Miss any of our Open RFC calls?Watch the recordings here! »

@fieldtech/simple-conventional-changelog

1.1.4 • Public • Published

simple-conventional-changelog

Join the community on Spectrum npm version npm downloads Build Status

作为 X-Developer 生产力工具家族成员,Simple Conventional Changelog 简化了 commitizen 的提交步骤,并提供了中文支持。

基于 conventional changelog 但实现了更简单的注释风格,仅需一行,如下所示:

#123 feat 中文交互式支持

此适配器生成的 Git 注释完整兼容 X-DeveloperGit 仓库的数据分析。

安装

commitizen 提供了交互式命令行,来生成格式化的 Git 注释,运行以下命令进行安装。

$ npm install -g commitizen

配置

生成配置

进入您的 Git仓库 目录,非 node.js 项目,需运行以下命令创建 package.json 文件。

$ npm init --yes

随后运行以下命令即启用 simple-conventional-changelog 风格的提交规范。

$ commitizen init @fieldtech/simple-conventional-changelog --save --save-exact

检查 package.json 可看到下面的生成项。

{
    "config": {
        "commitizen": {
            "path": "./node_modules/@fieldtech/simple-conventional-changelog"
        }
    }
}

个性化配置

此为可选项,可以通过更改以下的 key 值进行个性化配置。

  • maxHeaderWidth:注释行的最大长度
  • defaultType:默认的提交类型
  • defaultSubject:默认注释
  • defaultIssues:默认任务编号
{
// ...  默认参数值
    "config": {
        "commitizen": {      
            "path": "./node_modules/@fieldtech/simple-conventional-changelog",
            "maxHeaderWidth": 100,
            "defaultType": "",     
            "defaultSubject": "",
            "defaultIssues": ""
        }
    }
// ...    
}

提交代码

使用 git cz 而非 git commit 来提交变更。随后您将看到下列交互式操作,根据提示即可完成规范的注释提交。

$ git cz

Add and commit with Commitizen

Install

npm i @fieldtech/simple-conventional-changelog

DownloadsWeekly Downloads

0

Version

1.1.4

License

MIT

Unpacked Size

105 kB

Total Files

12

Last publish

Collaborators

  • avatar