commitlint-config-yan

Git commit message 规范

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

安装

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

pnpm install commitlint-config-yan @commitlint/cli -D

使用

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

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

设置 git hook

可通过 simple-git-hooks 设置在 git commit 时触发 commitlint。

首先安装 simple-git-hooks：

pnpm install simple-git-hooks -D

然后执行添加commit-msg:

npx simple-git-hooks add .simple-git-hooks/commit-msg 'npx commitlint --edit $1'

更多信息可参考 commitlint 文档