fast-commitlint-config v1.0.0

fast-commitlint-config

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

安装

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

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

使用

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

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

设置 git hook

可通过 husky 设置在 git commit 时触发 commitlint。

首先安装 husky：

npm install husky --save-dev

然后执行添加commit-msg:

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

更多信息可参考 commitlint 文档。

type-enum

feat：表示添加新功能（feature）。 fix：表示修复 bug。 docs：表示更新文档（例如：README、文档注释等）。 style：表示对代码样式、格式进行调整，不涉及代码逻辑的更改。 test：表示添加或修改测试代码。 refactor：表示对代码进行重构，既不修复 bug 也不添加新功能。 chore：表示对构建过程或辅助工具/库的更改。 revert：表示撤销之前的提交。