什么是commitlint
commitlint帮助您的团队遵守提交约定。通过支持 npm 安装的配置,它使提交约定的共享变得容易。
安装commitlint
npm install -g @commitlint/cli @commitlint/config-conventional
配置
echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js
执行完成后会生成一个commitlint.config.js的文件,这个文件是用来配置commitlint的校验规则的,默认也行,默认就是使用的commitlint的默认的校验规则,也可以自己去添加,这个是根据团队来制定的
搭配husky
什么是husky
当您提交或推送时,您可以使用它来检查提交消息、运行测试、检查代码等。
安装 husky
npm install husky --save-dev
激活钩子
npx husky install
执行后会在项目的根目录生成一个.husky
添加钩子
npx husky add .husky/commit-msg 'npx --no -- commitlint --edit ${1}'
执行会在.husky目录中生成一个commit-msg的文件
添加了这个钩子后,不符合commitlint规则的提交描述是不会执行成功的
测试钩子
npx commitlint --from HEAD~1 --to HEAD --verbose
这将检查您的最后一次提交,如果无效则返回错误,如果有效则返回正输出。