@cenk1cenk2/cz-cc

• 说明
• 使用量
• 配置
  • 软件包.json
  • 环境变量
• 中断更改
  • 迁移到 v3
• 委员会

说明

这是直接的叉子 cz- 常规变化日志时,它交换 inquirer 页:1 enquirer 以输入类型,并减少总的问题,使许多问题成为可选的.

使用量

• 安装承诺。 要么在全球范围内,要么在项目中.

# yarn
yarn global add commitizen
# npm
npm install -g commitizen

• 在工程中启动这个适配器 。 如果已经启动, 您可以添加 --force 旗下可以将这个适配器和旧的相换.
  • 目前工作空间有问题 commitizen。 。 。 .

# yarn
commitizen init @cenk1cenk2/cz-cc --yarn --dev
# npm
commitizen init @cenk1cenk2/cz-cc --dev

• 添加 git- hooks 为 小时。 。 。 .

amends "package://github.com/jdx/hk/releases/download/v2.0.1/[email protected]#/Config.pkl"

hooks {
  ["prepare-commit-msg"] {
    steps {
      ["commitizen"] {
        fix = "git cz --hook"
        interactive = true
      }
    }
  }
}

• 添加 承诺 如果需要的话.

配置

利用全球承诺安装安装适配器.

下面是配置设置 .

软件包.json

与承诺式一样,您通过包指定了cz-常规切换log的配置. 强森的 config.commitizen 键.

{
// ...  default values
    "config": {
        "commitizen": {
            "path": "./node_modules/@cenk1cenk2/cz-cc",
            "preset": "conventionalcommits",
            "maxHeaderWidth": 100,
            "maxLineWidth": 100,
            "defaultType": "",
            "defaultScope": "",
            "defaultSubject": "",
            "defaultBody": "",
            "defaultIssues": "",
            "types": {
              ...
              "feat": {
                "description": "A new feature",
                "title": "Features"
              },
              ...
            }
        }
    }
// ...
}

preset 选择断开更改是如何被提示和渲染的, 或 conventionalcommits (违约)或 angular。见 中断更改。 。 。 .

环境变量

以下的环境可流体可以用来覆盖任何默认配置或包. json基于配置.

• CZ PRESET = 预设
• CZ TYPE = 默认类型
• CZ SCOPE = 默认范围
• CZ SUBJECT = 默认对象
• CZ BODY = 默认的Body
• CZ MAX HEADER WIDTH = 最大页眉宽度
• CZ MA LINTH = 最大线网

中断更改

突破性变化通过快速和 preset 组合决定提供两种机制中的哪一种。 它必须与发布工具分析的预设相匹配.

• conventionalcommits (单位:千美元)默认二者兼具. breaking-marker 附加 ! 如 feat(api)!: drop the legacy token endpoint,以及 breaking-changes 附录a BREAKING CHANGE 脚指. 规格将两者视为独立的信号,因此任何一个单独标出承诺即为破解并选择两者都是有效的.
• angular 提议 breaking-changes 一个人,因为 ! 标记不是其头图案的一部分。 这是每一次发布在v3之前的行为.

选择既不离开承诺的不突破,所以普通的承诺仍然在一次通过中跳过整个主题.

迁移到 v3

conventionalcommits 成为 v3 中的默认, 因此通过适配器所做的承诺现在可以携带 ! 在页眉中标记一次 breaking-marker 已选定。 有两件事要查:

• 释放工具必须分析与 conventionalcommits 预设,否则 ! 标记不读取为大起落. @semantic-release/commit-analyzer 财务报告和审定财务报表 commitlint 都拿一个 preset 他们自己的.
• header-max-length 计算额外字符,任何工具匹配自定义正则表达式的 承诺信头必须允许 ! 在结肠之前.

为了保持先前的行为, 将预设后置 :

{
  config: {
    commitizen: {
      preset: 'angular'
    }
  }
}

委员会

如果使用 承诺 js 库,"maxheaderWidth"配置属性将默认为"header-max-长"规则的配置,而不是100的硬码值. 这可以通过设置宏包中的"maxheaderWidth"配置来覆盖.json或CZ MA HEADER WIDTH环境变量.