当前位置：首页>后端>正文

git 提交规范

后端2024-04-30 17:05:33

约定式提交规范

Commitizen规范化提交代码

1、全局安装Commitizen

npm install -g commitizen@4.2.4

2、安装并配置cz-customizable插件

npm i cz-customizable@6.3.0 --save-dev

当页面报错时，在代码后面加--legacy-peer-deps 如：npm i cz-customizable@6.3.0 --save-dev --legacy-peer-deps
然后在package.json中配置

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

3、项目根目录下创建.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/e/h)'
  },
  // 跳过问题
  skipQuestions: ['body', 'footer'],
  // subject文字长度默认是72
  subjectLimit: 72
}

4、使用git cz代替git commit，即可看到提示内容

查看全文

https://www.xamrdz.com/backend/3fs1939204.html

Commitizen规范化提交代码

相关文章：