1. 安装脚手架:
pnpm add @commitlint/cli -D
1
  1. 安装对应的约束规范:
pnpm add @commitlint/config-conventional -D
1
  1. 安装完成之后,在本地控制台测试:
echo 'foo: bar' | pnpm commitlint
1
  1. 为了在项目中自动启用 husky,可以安装 husky
pnpm add husky@^8.0.0 -D
1
  1. 初始化 husky
npx husky-init
1

初始化完成之后,会自动有 pre-commit 钩子

  1. 我们需要手动添加 commit-msg 钩子
npx husky add .husky/commit-msg "npx --no-install commitlint --edit $HUSKY_GIT_PARAMS"
1

添加完成之后,在后续的 git commit 操作中会自动检测格式是否规范。

TIP

pre-commit 钩子可用于代码格式验证。

commit-msg 钩子可用于 commit 信息格式验证。