JavaScript 项目中规范 commit message 的配置与原理

规范 commit message 的意义

采用标准化、格式化的提交信息，有助于追踪需求变更历史，在需要回滚时能快速定位相关提交，同时也能提升代码仓库的专业形象。

团队推行提交规范不应仅依赖宣讲或文档，而应通过工具自动生成和强制约束来实现。前端生态中已有丰富的相关工具可供选择。

• 使用 commitizen 通过问答方式生成格式化的提交信息。
• 利用 commitlint 对提交信息进行校验，确保其符合规范。

commitizen 工具介绍

commitizen 旨在为开发者提供简洁的提交约定。

通过 提供的 git cz 命令替代传统的 git commit 命令，以生成符合特定规范的提交信息。

commitizen 默认遵循 Angular 团队的提交规范。若需自定义格式，需配合适配器（Adapter）使用，此处我们选用 cz-customizable。

接下来介绍项目级别的配置方法。

配置 commitizen

执行命令安装依赖：npm install -D commitizen 以及 npm install -D cz-customizable。

在 package.json 文件的 scripts 和 config 字段中进行相应配置。

{
  "scripts": {
    "commit": "cz"
  },
  "config": {
    "commitizen": {
      "path": "./node_modules/cz-customizable"
    },
    "cz-customizable": {
      "config": ".cz-configrc.js"
    }
  }
}

创建 .cz-configrc.js 文件以定义自定义配置。

在项目根目录下执行 npm run commit 进行测试。

后续可将 npm run commit 替换为 git commit 以使用标准 Git 提交命令。

commitlint 配置

如何确保团队成员统一使用 npm run commit 命令？这需要借助工具来约束。

这里使用 commitlint，其作用类似于 eslint。通过 git hooks 拦截不符合规范的提交信息。

安装相关依赖

npm install --save-dev @commitlint/{config-conventional,cli} 
npm install yorkie --save-dev

添加 .commitlint.config.js 配置文件

扩展开源配置，并添加部分个性化规则。

配置 Git Hooks

为了拦截不规范的提交信息，需要利用 git hooks 的 commit-msg 钩子自动执行 commitlint。

"gitHooks": {
  "commit-msg": "commitlint -e $GIT_PARAMS"
}

尝试输入一个错误的提交信息，会发现校验生效，提交被阻止。

按照上述步骤即可完成团队提交信息的规范化。

总结配置步骤：

第一步：安装依赖

npm install -D commitizen cz-customizable
npm install -D @commitlint/{config-conventional,cli}
npm install -D yorkie 

第二步：添加配置文件

创建自定义格式的 commitizen 配置文件 .cz-configrc.js 以及校验规范的 .commitlint.config.js 文件。

配置 package.json 文件。

{
  "scripts": {
    "commit": "cz"
  },
  "config": {
    "commitizen": {
      "path": "./node_modules/cz-customizable"
    },
    "cz-customizable": {
      "config": ".cz-configrc.js"
    }
  },
  "gitHooks": {
    "commit-msg": "commitlint -e $GIT_PARAMS"
  }
}

git cz 命令原理

如果是全局安装 commitizen，还可以使用 git cz 命令代替 npm run commit。

git cz 究竟是什么？它既是 Git 命令，也是 commitizen 的命令。

查阅资料可知，git cz 是 commitizen 利用 Git 的文件命名规范生成的自定义 Git 命令。

Git 遵循命名约定 git-<subcmd> 自动解析 PATH 中可执行文件中的子命令。这些子命令可以通过 git <subcmd> 执行。

查看 commitizen 仓库 package.json 的 bin 字段，即可明白这是 Git 的自定义命令。

 "bin": {
    "cz": "./bin/git-cz",
    "git-cz": "./bin/git-cz",
    "commitizen": "./bin/commitizen"
  },

以上为 JavaScript 开发过程中规范 commit message 的详细解析，更多关于开发规范 commit message 的资料请关注本站其他相关文章。