基于cz-customizable代码提交规范

131 阅读2分钟

背景:commit信息不够规范,通过明确和标准化提交信息来提高代码协作质量和效率,开发人员可以更容易地理解和管理代码的变更历史。

可以使提交信息更加规范化和易于管理,从而方便其他团队成员阅读和理解更改的含义,从而提高团队协作效率

实现步骤

1.安装cz-customizable:

npm install cz-customizable --save-dev

2.项目根目录添加自定义配置文件cz-config:

module.exports = {     // 可选类型     types: [       { value: 'feat', name: '⚡ feat: 新功能' },       { value: 'fix', name: '  fix: 修复Bug' },       { value: 'docs', name: '✏️ docs: 文档变更' },       { value: 'style', name: '  style: 不影响代码含义的变化(空白、格式化、缺少分号等)' },       { value: 'refactor', name: '♻️ refactor: 重构代码,既不修复错误也不添加功能' },       { value: 'perf', name: '⚡ perf: 性能优化' },       { value: 'test', name: '✅ test: 测试相关' },       { value: 'ci', name: '  ci: 更改持续集成文件和脚本' },       { value: 'chore', name: '  chore: 重新打包或更新依赖工具等杂活' },       { value: 'revert', name: '⏪ revert: 代码回退' },     ],     // scope 类型(定义之后,可通过上下键选择)3     scopes: [       ['components', '组件相关'],       ['hooks', 'hook 相关'],       ['utils', 'utils 相关'],       ['element-ui', '对 element-ui 的调整'],       ['styles', '样式相关'],       ['deps', '项目依赖'],       ['config', '配置相关'],       ['other', '其他修改'],       // 如果选择 custom,后面会让你再输入一个自定义的 scope。也可以不设置此项,把后面的 allowCustomScopes 设置为 true       ['custom', '以上都不是?我要自定义']     ].map(([value, description]) => {       return {         value,         name: `${value.padEnd(30)} (${description})`       }     }),       // 步骤消息提示     messages: {       type: '确保本次提交遵循规范!\n选择你要提交的类型:',       scope: '\n选择一个 scope(可选):',       customScope: '请输入修改范围(可选):',       subject: '请输入变更描述(必填):',       body: '填写更加详细的变更描述(可选):',       footer: '请输入要关闭的 ISSUES (可选):',       confirmCommit: '确认提交?',     },     // 允许自定义范围     allowCustomScopes: true,     // 要跳过的问题     skipQuestions: ['footer','customScope','body'],      // subject文字默认值是72     subjectLimit: 100   }
  1. package.json添加配置:
"config": {     "commitizen": {       "path": "./node_modules/cz-customizable"     },     "cz-customizable": {       "config": "./cz-config.js"     }   }
  1. git cz查看配置信息

image.png