SquirrelJimmy/cz-conventional-changelog-cn

A commitizen adapter for the angular preset of https://github.com/conventional-changelog/conventional-changelog

cz-conventional-changelog 汉化

cz-conventional-changelog 的汉化版本

配置 (Configuration)

package.json

通过 package.json 添加 config.commitizen 使用

{
// ...  default values
    "config": {
        "commitizen": {
            "path": "./node_modules/cz-conventional-changelog-cn",
            "maxHeaderWidth": 100,
            "maxLineWidth": 100,
            "defaultType": "",
            "defaultScope": "",
            "defaultSubject": "",
            "defaultBody": "",
            "defaultIssues": "",
            "types": {
              ...
              "feat": {
                "description": "A new feature",
                "title": "Features"
              },
              ...
            }
        }
    }
// ...
}

环境变量 (Environment variables)

下面的变量都可以用默认配置或者package.json的config.commitizen配置覆盖

• CZ_TYPE = defaultType
• CZ_SCOPE = defaultScope
• CZ_SUBJECT = defaultSubject
• CZ_BODY = defaultBody
• CZ_MAX_HEADER_WIDTH = maxHeaderWidth
• CZ_MAX_LINE_WIDTH = maxLineWidth

Commitlint

如果使用了commitlint, "maxHeaderWidth"配置属性将默认为"header-max-length"的值, 而不是100. 可以通过设置配置的'maxHeaderWidth'字段或者环境变量CZ_MAX_HEADER_WIDTH重置.

自定义配置(可重写默认配置)

在项目的根目录提供cz.commitlog.config.js可以修改或重写提交流程

module.exports = function(questions) {
  // ...
  return questions;
}

具体的规则参考Inquirer

根目录下提供cz.committypes.config.js可以修改或者重写提交类型的模板

module.exports = function(types) {
  // ...
  return types;
}

格式如下

{
  "key": {
    "description": "这是描述",
    "name": "这是name"
  }
}