[4] commit 规范

commit 提交规范

// 文件 .commitlintrc.js

'use strict'
module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'type-enum': [
      2,
      'always',
      ['WIP', 'feat', 'fix', 'refactor', 'docs', 'test', 'style', 'chore', 'revert'],
    ],
    'type-case': [1, 'always', ['lower-case', 'upper-case']],
    'scope-case': [0, 'never'],
    'subject-case': [0, 'never'],
    'scope-empty': [0, 'never'],
  },
}

格式：<type>(<scope>): <subject>
例如：git commit -m "feat: xxxxx"

其中type取值范围：

• WIP：有缺陷的代码
• feat: 新功能、新特性
• fix: 修改 bug
• refactor: 代码重构（重构，在不影响代码内部⾏为、功能下的代码修改）
• docs: ⽂档修改
• test: 测试⽤例新增、修改
• style: 代码格式修改, 注意不是 css 修改（例如分号修改）
• build: 影响项⽬构建或依赖项修改
• revert: 恢复上⼀次提交
• ci: 持续集成相关⽂件修改
• chore: 其他修改（不在上述类型中的修改）
• release: 发布新版本
• workflow: ⼯作流相关⽂件修改
• perf: 更改代码，以提⾼性能

⾃动化提交验证

验证 git commit 规范，主要通过 git 的 pre-commit 钩⼦函数来进⾏。
当然，你还需要下载⼀个辅助⼯具来帮助你进⾏验证。

npm i -D husky