Skip to content

(四十)代码提交规范 cz customizable

阿峰 edited this page Jun 30, 2023 · 1 revision

步骤四十

代码提交规范-cz-customizable

  1. 安装依赖
npm i cz-customizable -D
  1. 在根目录下创建 .cz-config.js
module.exports = {
  // 可选类型,和上面commitlint.config.js配置的规则一一对应
  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)',
  }, // 跳过问题:修改范围,自定义修改范围,详细描述,issue相关
  skipQuestions: ['scope', 'customScope', 'body', 'footer'], // subject描述文字长度最长是72
  subjectLimit: 72,
}
  1. 在 package.json 中添加
{
  "config": {
    "commitizen": {
      "path": "./node_modules/cz-customizable"
    }
  },
}

提交代码时,使用 cz 即可选择对应的规范

Clone this wiki locally