cz-conventional-changelog-zh-cn
Version:
A fork of cz-conventional-changelog, and has been sensibly localized into Simplified Chinese.
115 lines (89 loc) • 4.32 kB
Markdown
# cz-conventional-changelog-zh-cn
[](https://www.npmjs.org/package/cz-conventional-changelog-zh-cn)
[](http://npm-stat.com/charts.html?package=cz-conventional-changelog-zh-cn&from=2023-11-01)
[English](./README_en_US.md) | 简体中文
符合 [conventional changelog](https://github.com/conventional-changelog/conventional-changelog) 标准的 **简体中文版** 提示适配器，[cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog) 的分叉（Fork）版本。
🪧 如果你更喜欢可以应用于多项目（multi-repo）的集成好的模板，可以去作者的 [cz-conventional-template-zh-cn](https://github.com/henryau53/cz-conventional-template-zh-cn) 瞧一瞧，也许更适合你。
## 截图
## 配置
### package.json
与 commitizen 类似，可以通过 package.json 文件中的 `config.commitizen` 键来指定 cz-conventional-changelog-zh-cn 的相关配置，可配置项如下：
```json5
{
// ...
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog-zh-cn",
"disableScopeLowerCase": false,
"disableSubjectLowerCase": false,
"maxHeaderWidth": 100,
"maxLineWidth": 100,
"defaultType": "",
"defaultScope": "",
"defaultSubject": "",
"defaultBody": "",
"defaultIssues": "",
"types": {
"feat": {
"description": "添加新功能或功能性变化"
},
"fix": {
"description": "修复 bug"
},
"docs": {
"description": "只修改了文档"
},
"style": {
"description": "修改了代码风格，不影响代码运行的变更"
},
"refactor": {
"description": "重构代码，既不新增功能，也不是修复 bug"
},
"perf": {
"description": "提升性能的代码更改"
},
"test": {
"description": "增加或修改测试用例"
},
"build": {
"description": "对构建过程或辅助工具和库的更改"
},
"chore": {
"description": "对构建过程或辅助工具和库的更改"
},
"ci": {
"description": "用于对持续集成（CI）配置文件和脚本的更改"
},
"revert": {
"description": "撤销之前的提交"
}
}
}
}
// ...
}
```
> 注意：默认当前版本已经集成了 `config.commitizen.types` 的中文描述，如果你不喜欢默认的中文描述，可通过上述配置自定义修改。
### 环境变量
以下环境变量可用于覆盖任何默认配置或基于 package.json 的配置。
* CZ_TYPE = 默认类型
* CZ_SCOPE = 默认范围
* CZ_SUBJECT = 默认简要描述
* CZ_BODY = 默认正文
* CZ_MAX_HEADER_WIDTH = 标题最大长度
* CZ_MAX_LINE_WIDTH = 行最大长度
### Commitizen
初始化项目以使用 cz-conventional-changelog-zh-cn 适配器，更多内容请参考 [commitizen](https://github.com/commitizen/cz-cli) 主页。
```bash
# npm
commitizen init cz-conventional-changelog-zh-cn --save-dev --save-exact
# yarn
commitizen init cz-conventional-changelog-zh-cn --yarn --dev --exact
# pnpm
commitizen init cz-conventional-changelog-zh-cn --pnpm --save-dev --save-exact
```
更多提交类型的说明请参考 [conventional-changelog 提交类型](./meta/docs/conventional-changelog-types.md)。
### Commitlint
如果使用 [commitlint](https://github.com/conventional-changelog/commitlint) JavaScript 库，`maxHeaderWidth` 配置属性将默认使用 `header-max-length` 规则的配置值，而不是硬编码的默认值 100。这可以通过在 package.json 中设置 `maxHeaderWidth` 配置或者设置 `CZ_MAX_HEADER_WIDTH` 环境变量来进行覆盖。