cd-commitlint-config

TIP

印客学院 Git 规范

支持配套的 commitlint 配置 (opens new window)，用于对 git commit message 进行校验。

安装

使用时，需要安装 @commitlint/cli (opens new window)：

npm install cd-commitlint-config @commitlint/cli --save-dev

使用

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

module.exports = {
  extends: ['cd-commitlint-config'],
};

设置 git hook

可通过 husky (opens new window) 设置在 git commit 时触发 commitlint。

首先安装 husky：

npm install husky --save-dev

然后执行添加 commit-msg:

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

更多信息可参考 commitlint 文档 (opens new window)。