依赖工具
husky
Git hooks 工具, 可以在执行 git 命令时,执行自定义的脚本程序
commitlint
检测 git commit 内容是否符合定义的规范,只有规范的 commit message 才能提交
工具安装(推荐全局)
前置条件:npm
npm install -g husky
npm install -g @commitlint/cli @commitlint/config-conventional
项目内配置
Windows(使用powershell)
husky
"module.exports = {extends: ['@commitlint/config-conventional']};" | Out-File -Encoding UTF8 commitlint.config.js
项目目录下修改文件(命令行)
目录:.\.husky\commit-msg
内容:npx --no -- commitlint --edit
Mac
husky
echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js
echo "npx --no -- commitlint --edit \$1" > .husky/commit-msg
使用效果
idea中也同样会报错
特殊情况跳过验证
增加-n参数