std-commitlint-config

提交检查

Usage

const commitlintConfig = require('std-commitlint-config');

// TODO: DEMONSTRATE API

安装

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

commitlint/cli 这个node > 18

使用

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

module.exports = {
  extends: ['std-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 文档。