cz-conventional-changelog-zh(汉化版)

forked from z649319834/cz-conventional-changelog-zh

z649319834/cz-conventional-changelog-zh

Status:

基于cz-conventional-changelog的基础修改的中文版，并扩展了一些日常工作中需要用到的提交类型

Part of the commitizen family. Prompts for conventional changelog standard.

Configuration

package.json

与 commitizen 一样，您可以通过 package.json 的config.commitizen关键字来配置cz-conventional-changelog-zh。

{
// ...  default values
    "scripts":{
      ...
      "commit": "git-cz"
    },
    "config": {
        "commitizen": {
            "path": "cz-conventional-changelog-zh", // 如有问题可以设置此路径:./node_modules/cz-conventional-changelog-zh
            "disableScopeLowerCase": false,
            "disableSubjectLowerCase": false,
            "maxHeaderWidth": 100,
            "maxLineWidth": 100,
            "defaultType": "",
            "defaultScope": "",
            "defaultSubject": "",
            "defaultBody": "",
            "defaultIssues": "",
            "types": {
              ...
              "custom": {
                "description": "A new type",
                "title": "Custom Type"
              },
              ...
            }
        }
    }
// ...
}

Environment variables

以下环境变量可用于覆盖任何默认配置，包括 package.json的配置

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

Commitlint

如果使用commitlint js 库, “maxHeaderWidth”配置属性将默认为“header-max-length”规则的配置，而不是硬编码的值 100。这可以通过在package.json中设置“maxHeaderWidth”配置来完成或 CZ_MAX_HEADER_WIDTH 环境变量。

Types

扩展了新的提示类型,通过 package.json 的config.commitizen关键字来配置的类型会和原有内置的类型合并

{
  "feat": {
    "description": "一个新功能",
    "title": "Features"
  },
  "fix": {
    "description": "一个bug",
    "title": "Bug Fixes"
  },
  "docs": {
    "description": "文档增删改",
    "title": "Documentation"
  },
  "style": {
    "description": "样式修改(空白、格式、缺少分号等)",
    "title": "Styles"
  },
  "refactor": {
    "description": "既不修复bug也不添加新功能的更改",
    "title": "Code Refactoring"
  },
  "perf": {
    "description": "性能优化",
    "title": "Performance Improvements"
  },
  "test": {
    "description": "增加测试",
    "title": "Tests"
  },
  "build": {
    "description": "影响构建系统或外部依赖项的更改(示例范围:gulp、broccoli、npm)",
    "title": "Builds"
  },
  "ci": {
    "description": "对CI配置文件和脚本的更改(示例范围:Travis, Circle, BrowserStack, SauceLabs)",
    "title": "Continuous Integrations"
  },
  "chore": {
    "description": "除src目录或测试文件以外的修改",
    "title": "Chores"
  },
  "revert": {
    "description": "回退历史版本",
    "title": "Reverts"
  },
  "conflict": {
    "description": "修改冲突",
    "title": "Conflict"
  },
  "font": {
    "description": "字体文件更新",
    "title": "Fonts"
  },
  "delete": {
    "description": "删除文件",
    "title": "Delete Files"
  },
  "stash": {
    "description": "暂存文件",
    "title": "Stash Files"
  }
}