commitlint 是对 Git 提交的 message 进行校验的工具。

1. 环境要求

v19 以上的 Stylelint，支持 Node.js 的版本为 v18 +。 在命令行中输入以下内容后回车，来查看当前系统中 Node.js 的版本。

node -v

Node.js 推荐使用 v18.20.3+ 或者 v20.13.1+。 这里使用的包管理器是 PNPM，版本为 v9.1.4。

2 安装

在对应项目的根目录下打开命令行，输入：

pnpm add -D @commitlint/{cli,config-conventional}

3 配置

执行以下命令：

echo "export default { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js

以上相当于在项目根目录下创建了 commitlint.config.js 文件，同时在文件中填了以上双引号中的内容。

4 结合 Husky

利用 Husky 在 git commit 时自动校验 commit message，如不符合规范，则不能被 commit。