自定义commit提交

首先安装
1、npm install --save-dev husky
然后在package.json里面加入

"husky": {
    "hooks": {
        "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
},

2、npm install @commitlint/cli @commitlint/config-conventional --save-dev

新建文件
commitlint.config.js

module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'type-enum': [
      2,
      'always',
      ['Feat', 'Fix', 'Doc', 'Style','Update', 'Refactor', 'Test', 'Framework', 'Revert']
    ],
    'type-case': [0,'always','start-case'],
    'type-empty': [0],
    'scope-empty': [0],
    'scope-case': [0],
    'subject-full-stop': [0, 'never'],
    'subject-case': [0, 'never'],
    'header-max-length': [0, 'always', 72]
  }
}

npm install cz-customizable --save-dev
新建文件
.cz-config.js

module.exports = {
  types: [
      {value: 'Feat',     name: '特性:    一个新的特性'},
      {value: 'Update',     name: '更新:   更新一个功能'},
      {value: 'Fix',      name: '修复:    修复一个Bug'},
      {value: 'Style',     name: '样式:    变更的只有样式'},
      {value: 'Doc',     name: '文档:    变更的只有文档'},
      {value: 'Refactor', name: '重构:    代码重构，注意和特性、修复区分开'},
      {value: 'Test',     name: '测试:    添加一个测试'},
      {value: 'Framework',    name: '框架:    开发框架变动(构建、脚手架工具等)'},
      {value: 'Revert',   name: '回滚:    代码回退'}
    ],
    scopes: [
      {name: '系统框架'},
      {name: '公共组件'},
    ],
  allowTicketNumber: false,
  isTicketNumberRequired: false,
  ticketNumberPrefix: 'TICKET-',
  ticketNumberRegExp: '\d{1,5}',

  // it needs to match the value for field type. Eg.: 'fix'
  /*
  scopeOverrides: {
    fix: [

      {name: 'merge'},
      {name: 'style'},
      {name: 'e2eTest'},
      {name: 'unitTest'}
    ]
  },
  */
  // override the messages, defaults are as follows
  messages: {
      type: '选择一种你的提交类型:',
      scope: '选择一个scope (可选):',
      // used if allowCustomScopes is true
      customScope: 'Denote the SCOPE of this change:',
      subject: '短说明:
',
      body: '长说明，使用"|"换行(可选)：
',
      breaking: '非兼容性说明 (可选):
',
      footer: '关联关闭的issue，例如：#31, #34(可选):
',
      confirmCommit: '确定提交说明?'
  },

  allowCustomScopes: true,
 // allowBreakingChanges: ['特性', 'Fix'],
  // skip any questions you want
  skipQuestions: ['body'],

  // limit subject length
  subjectLimit: 72,
  // breaklineChar: '|', // It is supported for fields body and footer.
  // footerPrefix : 'ISSUES CLOSED:'
  // askForBreakingChangeFirst : true, // default is false
};

最后配置package.json
"commit": "node ./node_modules/cz-customizable/standalone.js"

使用git add .之后就是用npm run commit 来做本地git代码暂存

 提交之前应该在做一次代码检查

"husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
      "pre-commit": "lint-staged --allow-empty"
    }
  },
  "lint-staged": {
    "src/**/*.{ts,tsx,js,jsx}": [
      "eslint --fix"
    ]
  },

加上这个配置commit的时候就会自动检测代码是否符合要求，不符合会报错终止代码提交

参考文档
https://segmentfault.com/a/1190000017790694
https://blog.csdn.net/weixin_33890526/article/details/91393527