【Git 】规范 Git 提交信息的工具 Commitizen

Commitizen是一个用于规范Git提交信息的工具，它旨在帮助开发者生成符合一定规范和风格的提交信息，从而提高代码维护的效率，便于追踪和定位问题。以下是对Commitizen的详细介绍。

1、Commitizen的作用与优势

• 规范提交信息：通过提供预定义的提交类型和格式，引导开发者编写清晰、一致的提交信息。
• 提高代码维护效率：规范的提交信息有助于快速理解每次提交的目的和内容，减少后续代码审查和信息查找的时间。
• 促进团队协作：统一的提交信息规范有助于团队成员之间的沟通和协作，减少因提交信息不清晰而产生的误解和冲突。

2、Commitizen的使用方法

2.1安装Commitizen

可以通过npm（Node.js的包管理器）来全局或局部安装Commitizen。

2.1.1 全局安装命令为

npm install -g commitizen

2.1.1 局部安装则需要在项目目录下运行

npm install commitizen --save-dev

• 安装完成后 cz-conventional-changelog 会被默认安装，并且是作为 commitizen 的依赖项安装的。
• 这意味着你可以直接使用 commitizen 并配置它使用 cz-conventional-changelog 适配器来规范你的 Git 提交信息。
• 可以在 node_modules中查看， 或者通过 npm list cz-conventional-changelog显示 cz-conventional-changelog 的安装信息，包括它的版本和安装路径。

2.2 配置Commitizen

安装完成后，需要配置Commitizen以使用特定的适配器（Adapter），如cz-conventional-changelog。这通常涉及在项目的package.json文件中添加相关配置，或者创建专门的配置文件（如.czrc）。

2.2.1 全局安装配置

Vue.js、React 项目根目录中配置 package.json:

{
  ...
  "scripts": {
  	...
  },
  "devDependencies": {
	...
  },
  // 新增 config 配置
  "config": {
    "commitizen": {
      "path": "cz-conventional-changelog"
    }
  }
}

2.2.2 局部安装配置

ps: 运行 npm run commit 来代替 git cz 来启动 Commitizen的交互式提交信息填写流程

Vue.js、React 项目根目录中配置 package.json:

{
  ...
  "scripts": {
   	...
    "commit": "cz"
  },
  "devDependencies": {
    ...
  },
  "config": {
    "commitizen": {
      "path": "node_modules/cz-conventional-changelog"
    }
  }
}

2.3 使用Commitizen提交信息

• 配置完成后
  • 可以使用git cz（全局安装）
  • npm run commit（局部安装并配置script）命令来启动Commitizen的交互式提交信息填写流程。
• 按照提示逐步填写提交信息的各个部分，如提交类型、范围、简短描述、详细描述等。
• 完成后，Commitizen将生成符合约定格式的提交信息。

3、Commitizen与其他工具的集成

Commitizen可以与其他工具和流程集成，如Git钩子（Hooks）、持续集成（CI）等。通过将这些工具与Commitizen结合使用，可以在提交代码之前自动检查提交信息是否符合规范，从而进一步提高代码质量和维护效率。

4、总结

Commitizen是一个强大的工具，它通过规范Git提交信息来提高代码维护效率并促进团队协作。

通过简单的安装和配置，开发者就可以在项目中使用Commitizen来生成符合规范的提交信息。

此外，Commitizen还支持自定义和扩展功能，以满足不同项目的需求。

对于希望提高代码质量和团队协作效率的开发者来说，Commitizen是一个值得尝试的工具。

5、扩展

当你全局安装 commitizen 时，它的可执行文件被添加到了系统的 PATH 环境变量中。这意味着你可以在任何命令行窗口中直接访问 commitizen 命令，包括使用 git cz 别名（如果 commitizen 安装过程中设置了这个别名）。

然而，当你局部安装 commitizen（即在项目内部通过 npm 安装）时，它的可执行文件只会被添加到项目的 node_modules/.bin 目录中。这个目录通常不会被自动添加到 PATH 环境变量中，因此你不能直接在命令行窗口中访问 commitizen 命令，除非你使用 npm 脚本来调用它。

通过在 package.json 的 scripts 字段中添加一个脚本，如下所示：

"scripts": {  
  "commit": "cz"  
}

你创建了一个 npm 脚本，该脚本会调用局部安装的 commitizen。这样，当你运行 npm run commit 时，npm 会知道去 node_modules/.bin 目录中查找 cz 命令并执行它。

总结来说，全局安装的 commitizen 可以在任何地方直接访问，而局部安装的 commitizen 需要通过 npm 脚本来访问，因为它只被添加到了项目的 node_modules/.bin 目录中。