commitlint-config-sharing v1.0.0

commitlint-config-sharing

GIT规范

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

安装

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

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

使用

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

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

设置 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 文档。