安装

1.依赖

1
npm install --save-dev @commitlint/config-conventional @commitlint/cli husky

2.配置文件

在工程根目录下新建配置文件,名称为 commitlint.config.js

当然也能直接一行命令

1
echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js

commitlint.config.js 中添加配置信息

1
module.exports = {extends: ['@commitlint/config-conventional']}

然后使用命令创建拦截脚本(可能会出错,建议检查一下内容)

1
npx husky add .husky/commit-msg "npx --no -- commitlint --edit $1"

你会发现在.husky文件夹内出现一个commit-msg文件,里面内容是npx --no -- commitlint --edit "$1"

至此结束!

小说明:如果某次提交想禁用 husky,可以添加参数 –no-verifygit commit --no-verify -m "xxx"