介绍Commitizen和cz-customizable：更优雅的Git Commit信息工具

介绍Commitizen和cz-customizable：更优雅的Git Commit信息工具

如果你是一名开发者，你可能经常会使用Git来管理你的代码，但是你是否曾经因为Git Commit信息不规范而感到头痛？如果是的话，那么你可能需要尝试一下Commitizen。而结合cz-customizable插件使用Commitizen可以满足自定义Git提交规范的需求。

Commitizen的介绍

Commitizen是一个用于撰写Git提交信息的工具。它可以帮助开发人员遵循一个规范，以便更容易地阅读和维护Git仓库历史记录。Commitizen采用了一个交互式的命令行界面，引导你逐步填写必要的数据，从而生成符合规范的Git提交信息。

cz-customizable的介绍

cz-customizable是一个Commitizen的插件，它允许你使用自定义的Git提交规范。通过为项目添加一个配置文件，你可以指定你自己的提交格式，并在使用Commitizen时使用该格式。你可以轻松地定义自己的提交类型、作用域和描述等信息。

如何使用Commitizen和cz-customizable

以下是在项目中使用Commitizen和cz-customizable的简单步骤：

1. 首先，你需要在项目中安装commitizen、cz-customizable和conventional-changelog-cli。你可以使用以下命令进行安装：

npm install commitizen cz-customizable conventional-changelog-cli --save-dev

2. 在package.json文件中，添加以下字段：

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

3. 然后，在项目根目录下添加一个.cz-config.js文件，并定义你的提交类型、作用域和描述等信息。例如：

module.exports = {
  types: [
    {
      value: 'feat',
      name: 'feat: 添加新特性'
    },
    {
      value: 'fix',
      name: 'fix: 修复问题'
    },
    {
      value: 'docs',
      name: 'docs: 文档变更'
    },
    {
      value: 'style',
      name: 'style: 代码格式（不影响功能的代码改动）'
    },
    {
      value: 'refactor',
      name: 'refactor: 重构代码（既不修复错误也不添加新功能的代码修改）'
    },
    {
      value: 'test',
      name: 'test: 添加测试'
    },
    {
      value: 'chore',
      name: 'chore: 构建过程或辅助工具的变动'
    }
  ],
  scopes: [],
  messages: {
    type: "选择一种你的提交类型:",
    scope: '\n选择一个scope (可选):',
    customScope: '请输入自定义的scope:',
    subject: '填写简短精炼的变更描述:\n',
    body: '填写更加详细的变更描述 (可选). 使用 "|" 分隔新行:\n',
    breaking: '列出 BREAKING CHANGES (可选):\n',
    footer: '关联关闭的 issues，例如：#31, #34(可选):\n',
    confirmCommit: '确认提交?'
  }
};

4. 最后，你可以使用以下命令来代替git commit：

npm run commit

这将启动Commitizen的交互式命令行界面，并引导你逐步填写必要的数据。

总结

通过使用Commitizen和cz-customizable，你可以更加优雅地提交Git Commit信息。它可以帮助你遵循规范，并根据自己的需求定义提交格式，以便更容易地阅读和维护Git仓库历史记录。如果你是一名开发者，并且想要尝试一下更好地管理你的Git提交信息，那么Commitizen和cz-customizable可能是一个非常不错的选择。