Git husky 之 commit-msg 规范

commitlint 相关工具.

commitlint是一个工具，用于对提交的Git commit消息进行规范化和验证。它能够帮助团队确保提交消息的一致性和明确性，提高代码的可读性和可维护性。
注意： 如果未安装husky， 先安装husky

yarn add husky -D

or

npm install husky -D

  // 会自动帮你初始化配置及目录，项目下会多出.husky 文件夹。同时会在package.json的script中添加"prepare": "husky install"

1. 安装commitlint

npm install @commitlint/cli -D

或

yarn add @commitlint/cli -D

2. 安装commit 的配置工具commitlint/config-conventional

npm install @commitlint/config-conventional -D

或

yarn add @commitlint/config-conventional -D

3. 根目录下创建commitlint.config.js

在文件里定义使用规则

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

4. 执行命令，添加commit-msg配置文件及脚本命令

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

执行完后，在.husky 文件目录下会生成 commit-msg 文件，内容是：

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx --no-install commitlint --edit "$1"

好了，现在可以尝试执行一下commit 命令，看是否有效
例如，执行不规范的提交

git add .
git commit -m "aaadddd"

就会出现提交错误：
⧗ input: aaadddd
✖ subject may not be empty [subject-empty]
✖ type may not be empty [type-empty]

好了，以上就是commit-msg 规范git提交检查限制设置。另外，也可以package.json 里面配置”husky" 来配置hooks 命令，自行百度吧！