commit message撰写以及自动检查工具

本文主要讲解如何安装commit message 的撰写工具以提高效率,同时安装自动纠错工具来强制规范团队成员的 commit message 格式

Commitizen

Commitizen是一个撰写合格 Commit message 的工具。

安装命令如下。

1
2
$ npm install -g commitizen
`

然后,在项目目录里,运行下面的命令,使其支持 Angular 的 Commit message 格式。

npm

1
$ commitizen init cz-conventional-changelog --save --save-exact

yarn

1
commitizen init cz-conventional-changelog --yarn --dev --exact

以后,凡是用到git commit命令,一律改为使用git cz。这时,就会出现选项,用来生成符合格式的 Commit message。

commitlint

我们可以使用commitlint来检查提交的git message是否符合规范

commitlint

安装commitlint

1
2
npm install --save-dev @commitlint/{cli,config-conventional}
echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js

安装husky

husky 是一个可以触发 git 钩子的一个库,方便我们在git操作的各个阶段执行各种命令

1
npm install --save-dev husky

然后在 文件中添加:

1
2
3
4
5
6
7
8
// package.json
{
"husky": {
"hooks": {
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}
}
}

这样,在每次提交commit message 之后 commitlint 就会自动检测提交的内容是否符合规范,如果不符合就会提交失败。