Giter Club home page Giter Club logo

cz-conventional-changelog-cn's Introduction

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"
  }
}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.