使用方法
- 安装依赖：在项目根目录下执行以下命令安装 Commitlint 和 Husky
npm install --save-dev husky @commitlint/cli @commitlint/config-conventional
- 配置 Commitlint：在项目根目录下创建 commitlint.config.js 文件，并写入以下代码
module.exports = {
extends: ['@commitlint/config-conventional']
};
- 配置 Husky：在项目的 package.json 文件中添加以下代码
"husky": {
"hooks": {
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}
}
推荐的关键词
Commitlint 默认使用的是 conventional commit 规范。Conventional commit 规范中推荐使用的关键词包括：
-
fix：修复 bug。 -
feat：添加新功能。 -
docs：只修改了文档。 -
style：修改了代码的格式，不影响代码的逻辑。 -
refactor：重构代码，不修复 bug 也不添加新功能。 -
revert: 回滚。 -
perf：提高性能。 -
test：添加或修改测试用例。 -
build：影响了构建过程和依赖关系。 -
ci：修改了 CI 配置文件和脚本。 -
chore：修改了项目维护任务，例如更新版本号。
这些关键词仅是 Conventional commit 规范中的建议，您也可以根据自己的需要自定义关键词。希望对您有所帮助。
