commitlint + husky检查git commit

1. 需要插件

1. husky: 用于添加git hooks钩子
2. @commitlint/cli: commitlint的cli工具
3. @commitlint/config-conventional： commitlint规则配置文件

1. 安装插件

yarn add --dev-save husky @commitlint/cli @commitlint/config-conventional

2. 在项目根目录添加commitlint.config.js配置文件

commitlint.config.js

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

3. 执行husky

npx husky install

4. 添加git commit钩子

npx husky add .husky/commit-msg 'npx --no -- commitlint --edit ${1}'

5. 执行步骤

1. 用户执行git commit -m "xxxx"
2. 触发用husky添加的commit-msg钩子， 执行npx --no -- commitlint --edit ${1}命令
3. commitlint/cli使用cosmiconfig加载commitlint.config.js配置文件
4. 检查git commit -m "xxxx", xxx消息是否符合@commitlint/config-conventional配置文件规范，如不符合规范则停止提交