git+commitize+cz-customizable 代码 提交规范

1.全局安装 Commitizen

npm install -g [email protected]

2.安装并配置 cz-customizable 插件
使用npm 下载 cz-customizable

npm i [email protected] --save--dev

添加以下配置到pack.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:   打包' },
    {
    
     value: 'revert', name: 'revert:   回退' }
  ],
  //消息步骤
  messages: {
    
    
    type: '请选择提交类型',
    customScope: '请输入修改范围(可选)',
    subject: '请简要描述提交(必填)',
    body: '请输入详细描述(可选)',
    footer: '请输入要关闭的issue(可选)',
    confirmCommit: '确认以上信息提交?(y/n)'
  },
  //跳过问题
  skipQuestion: ['body', 'footer'],
  //subject文字长度默认是
  subjectLimit: 72
}

4.使用 git cz 代替 git commit

使用git cz 代替 git commit,即可看到提示内容