Git规范：Commitizen

地瓜哥 - 2021-12-14 07:39:33

Conventional Commits specification(约定式提交)

  <type>[optional scope]: <description>

  [optional body]

  [optional footer(s)]

  ------ 翻译 ------
  
  <类型>[可选 范围]：<描述>

  [可选 正文]

  [可选 脚注]

使用Commitizen进行代码提交(git commit)时commitizen会提交你在提交时填写所有必需的提交字段。

全局安装Commitizen

 npm install -g commitizen

安装并配置cz-customizable插件
1) 使用npm下载cz-customizable

npm i cz-customizable --save-dev

2) 添加以下配置到package.json中

"config": {
  "commitizen": {
    "path": "node_modules/cz-customizable"
  }
}

在项目根目录下创建.cz-config.js自定义提示文件

module.exports = {
    // 可选类型
    types: [
        { value: 'feat', name: 'feat:   新功能' },
        { value: 'fix', name: 'fix:   修复' },
        { value: 'docs', name: 'docs:   文档变更' },
        { value: 'style', name: 'style:   代码格式(不影响代码运行的变动)' },
        {
                value: 'refactor',
                name: 'refactor:    重构(既不是增加feature，也不是修复bug)'
        },
        { value: 'perf', name: 'perf:   性能优化' },
        { value: 'test', name: 'test:   增加测试' },
        { value: 'chore', name: 'chore:   构建过程或辅助工具的变动' },
        { value: 'revert', name: 'revert:   回退' },
        { value: 'build', name: 'build:   打包' }
    ],
    // 消息步骤
    messages: {
        type: '请选择提交类型: ',
        customScope: '请输入修改范围(可选): ',
        subject: '请简要描述提交(必填): ',
        body: '请输入详细描述(可选): ',
        footer: '请输入要关闭的issue(可选): ',
        confirmCommit: '确认使用以上信息提交? (y/n)'
    },
    // 跳过问题
    skipQuestions: ['body', 'footer'],
    // subject文字长度默认是72
    subjectLimit: 72
};

使用 git cz代替 git commit

特别申明：本文内容来源网络，版权归原作者所有，如有侵权请立即与我们联系（cy198701067573@163.com），我们将及时处理。

上一篇：写一个vscode插件改善web项目的多版本维护难题

下一篇： git 初始化项目步骤