npm.io
0.0.18 • Published 2 years ago

fecode-commitlint-config

Licence
ISC
Version
0.0.18
Deps
1
Size
2 kB
Vulns
0
Weekly
0

fecode-commitlint-config

TODO: description

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

安装

使用时,需要安装 @commitlint/cli:

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

使用

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

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