可以在提交代码进 git 仓库时,自动检查代码规范(运行配置的脚本命令),并自动修复代码。
比如可以执行 eslint,prettier 命令等,等这些命令运行成功才能提交。
https://github.com/typicode/husky
使用方法很简单,参照官方文档,即可快速用起来。
Edit package.json > prepare
script and run it once:
npm set-script prepare "husky install"
npm run prepare
Add a hook:
npx husky add .husky/pre-commit "npm test"
git add .husky/pre-commit
Make a commit:
git commit -m "Keep calm and commit"
# `npm test` will run
安装完之后:
跟 git hook 结合在一起的。
比如做一个 git commit 时,会运行 husky 指定的脚本:npm run test
npm run test
要返回状态码 0 才能提交。
exit 1
改成 exit 0
就可以了。
有一种情况不需要用到这个工具也能达到差不多的效果:
自带的。
在 build
之前会自动运行 prebuild
里的脚本。
这种情况只针对某个命令,不会针对 git 提交的。