git 提交规范

青柠ii
301 阅读5分钟

前言

对于 git 提交规范 来说，不同的团队可能会有不同的标准， Angular团队规范 延伸出的 Conventional Commits specification（约定式提交） 就比较好，以此为例说明 git 提交规范

对于 **git** 提交规范 而言我们使用了 husky 来监测 Git hooks 钩子，并且通过以下插件完成了对应的配置：

  1. 约定式提交规范
  2. commitizen：git 提交规范化工具
  3. commitlint：用于检查提交信息
  4. pre-commit： git hooks 钩子
  5. lint-staged：只检查本次修改更新的代码，并在出现错误的时候，自动修复并且推送

约定式提交规范要求如下：

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

--------  翻译 -------------
    
<类型>[可选 范围]: <描述>

[可选 正文]

[可选 脚注]

一、采用 Commitizen工具规范化提交代码

commitizen 仓库名为 cz-cli ，它提供了一个 git cz 的指令用于代替 git commit

1、全局安装Commitizen

npm install -g commitizen@4.2.4

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

  1. 使用 npm 下载 cz-customizable
npm i cz-customizable@6.3.0 --save-dev
  1. 添加以下配置到 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

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

但是由于协同开发的时候 很多人git commit敲习惯了，忘记使用git cz指令 直接就提交了，该怎么解决呢

二、使用 husky + commitlint 检查提交描述是否符合规范要求

1、 commitlint

  1. 安装依赖：
npm install --save-dev @commitlint/config-conventional@12.1.4 @commitlint/cli@12.1.4
  1. 创建 commitlint.config.js 文件
echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js
  1. 打开 commitlint.config.js ， 增加配置项（ config-conventional 默认配置点击可查看 ）：
module.exports = {
  // 继承的规则
  extends: ['@commitlint/config-conventional'],
  // 定义规则类型
  rules: {
    // type 类型定义，表示 git 提交的 type 必须在以下类型范围内
    'type-enum': [
      2,
      'always',
      [
        'feat', // 新功能 feature
        'fix', // 修复 bug
        'docs', // 文档注释
        'style', // 代码格式(不影响代码运行的变动)
        'refactor', // 重构(既不增加新功能，也不是修复bug)
        'perf', // 性能优化
        'test', // 增加测试
        'chore', // 构建过程或辅助工具的变动
        'revert', // 回退
        'build' // 打包
      ]
    ],
    // subject 大小写不做校验
    'subject-case': [0]
  }
}

注意：确保保存为 **UTF-8** 的编码格式，否则会报错

2 、husky

  1. 安装依赖：
npm install husky@7.0.1 --save-dev
  1. 启动 hooks ， 生成 .husky 文件夹
npx husky install
  1. 在 package.json 中生成 prepare 指令（ 需要 npm > 7.0 版本 ）
npm set-script prepare "husky install"
  1. 执行 prepare 指令
npm run prepare

  1. 执行成功

  2. 添加 commitlint 的 hook 到 husky中，并指令在 commit-msg 的 hooks 下执行 npx --no-install commitlint --edit "$1" 指令

npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'

至此， 不符合规范的 commit 将不再可提交：

3、通过 pre-commit 检测提交时代码规范

PS F:\xxxxxxxxxxxxxxxxxxxxx\imooc-admin> git commit -m "测试"
⧗   input: 测试
✖   subject may not be empty [subject-empty]
✖   type may not be empty [type-empty]
✖   found 2 problems, 0 warnings
ⓘ   Get help: [https://github.com/conventional-changelog/commitlint/#what-is-commitlint](https://github.com/conventional-changelog/commitlint/#what-is-commitlint)

husky - commit-msg hook exited with code 1 (error)

我们期望通过 husky 监测 pre-commit 钩子，在该钩子下执行 npx eslint --ext .js,.vue src 指令来去进行相关检测：

  1. 执行
npx husky add .husky/pre-commit "npx eslint --ext .js,.vue src"

添加 commit 时的 hook （npx eslint --ext .js,.vue src 会在执行到该 hook 时运行）

  1. 该操作会生成对应文件 pre-commit：
  2. 关闭 VSCode 的自动保存操作
  3. 修改一处代码，使其不符合 ESLint 校验规则
  4. 执行 提交操作 会发现，抛出一系列的错误，代码无法提交
PS F:\xxxxxxxxxxxxxxxxxxx\imooc-admin> git commit -m 'test'

F:\xxxxxxxxxxxxxxxx\imooc-admin\src\views\Home.vue

  13:9  error  Strings must use singlequote  quotes

✖ 1 problem (1 error, 0 warnings)

  1 error and 0 warnings potentially fixable with the `--fix` option.

husky - pre-commit hook exited with code 1 (error)
  1. 要提交代码，必须处理完成所有的错误信息

4、通过lint-staged 自动修复提交时格式错误

lint-staged 可以让你当前的代码检查 只检查本次修改更新的代码，并在出现错误的时候，自动修复并且推送

lint-staged 无需单独安装，我们生成项目时，vue-cli 已经帮助我们安装过了，所以我们直接使用就可以了

  1. 修改 package.json 配置
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx lint-staged
  1. 如上配置，每次它只会在你本地 commit 之前，校验你提交的内容是否符合你本地配置的 eslint规则(这个见文档 ESLint )，校验会出现两种结果

a. 如果符合规则：则会提交成功。

b. 如果不符合规则：它会自动执行 eslint --fix 尝试帮你自动修复，如果修复成功则会帮你把修复好的代码提交，如果失败，则会提示你错误，让你修好这个错误之后才能允许你提交代码。

  1. 修改 .husky/pre-commit 文件
"lint-staged": {
  "src/**/*.{js,vue}": [
    "eslint --fix",
    "git add"
  ]
}
  1. 再次执行提交代码
  2. 发现 暂存区中 不符合 ESlint 的内容，被自动修复
avatar
文章
阅读
粉丝