commitlint-config-code

Git 提交规范

支持配套的 commitlint 配置，用于对 git commit message 进行校验。

安装

使用时，需要安装 @commitlint/cli：

:::code-group

pnpm install commitlint-config-code --save-dev

npm install commitlint-config-code --save-dev

:::

使用

在 commitlint.config.js 中集成本包:

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

设置 git hook

可通过 husky 设置在 git commit 时触发 commitlint。

首先安装 husky：

npm install husky --save-dev

然后执行添加commit-msg:

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

更多信息可参考 commitlint 文档。

再安装 cz-commitlint 触发 commit 自动提示：如下

npm install --save-dev @commitlint/cz-commitlint commitizen

{
    "scripts": {
         "commit": "git-cz"
     },
     "config": {
         "commitizen": {
             "path": "@commitlint/cz-commitlint"
          }
      }
 }