Skip to content
大纲

Commitizen

前置知识

有了 Commitlint 之后,我们就可以规范 commit 的信息校验了。 Commitizen 可以令这种校验体验感更佳。

commitizen 官方文档

安装

shell
npm install -D commitizen
# or
yarn add commitizen -D

之后终端运行:

shell
npx commitizen init cz-conventional-changelog --save-dev --save-exact
# or
npx commitizen init cz-conventional-changelog --yarn --dev --exact

package.json 文件中添加命令:

js
"scripts": {
  ...
  "cz": "cz"
}

TIP

如果安装了 husky

  • 命令命名为 commit ,运行此命令的时候 npmhusky 会自动运行名为 precommit 的脚本 2 次
  • 命令命名为其他,如 cz ,运行此命令的时候 npm 只会自动运行名为 prexxx 的脚本

验证

终端运行:

shell
git add .

yarn cz
# or
npm cz

设置中文

cz-conventional-changelog 出来的选项都是英文,对于开始使用的新手来说不太方便。这里是中文版

根据 MIT 许可证发布。