git约定式提交规范

一.Commitizen助你规范化提交代码

commitizen 仓库名为 cz-cli ,它提供了一个 git cz 的指令用于代替 git commit,简单一句话介绍它:

当你使用 commitizen 进行代码提交(git commit)时,commitizen 会提交你在提交时填写所有必需的提交字段!
  1. 全局安装Commitizen
npm install -g commitizen@4.2.4
  1. 安装并配置 cz-customizable 插件
npm i cz-customizable@6.3.0 --save-dev
  1. 将cz-customizable添加以下配置到 package.json 中
...
  "config": {
    "commitizen": {
      "path": "node_modules/cz-customizable"
    }
  }

  1. 项目根目录下创建 .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
}

到这里我们就已经可以使用git cz 来代替了 git commit 实现了规范化的提交诉求了,但是当前依然存在着一个问题,那就是我们必须要通过 git cz 指令才可以完成规范化提交!

git cz 来代替了 git commit 实现了规范化的提交诉求,但是依然存在着有人会忘记使用的问题。所以我们希望《提交描述信息》不符合 约定式提交规范 的时候,阻止当前的提交,并抛出对应的错误提示。阻止不合规的提交消息,需要使用到 hooks 的钩子函数,也叫做 Git hooks(git 钩子 || git 回调方法),
详细的 HOOKS介绍 可点击这里查看

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

要完成这么个目标,那么我们需要使用两个工具:

  • commitlint:用于检查提交信息
  • husky:是git hooks工具
    注意:npm 需要在 7.x 以上版本!!!!!
  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 , 增加配置项
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 的编码格式,否则可能会出现以下错误:
在这里插入图片描述

三.husky

1.安装依赖:

npm install husky@7.0.1 --save-dev

2.启动 hooks , 生成 .husky 文件夹:

npx husky install

在这里插入图片描述
3.在 package.json 中生成 prepare 指令( 需要 npm > 7.0 版本 ):
git约定式提交规范_第1张图片
4.执行 prepare 指令:

npm run prepare

5.执行成功,提示:
在这里插入图片描述
6. 添加 commitlint 的 hook 到 husky中,并指令在 commit-msg 的 hooks 下执行 npx --no-install commitlint --edit “$1” 指令

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

7.此时的 .husky 的文件结构:
至此, 不符合规范的 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

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

那么至此,我们就已经可以处理好了 强制规范化的提交要求,到现在 不符合规范的提交信息,将不可在被提交!

四.通过 pre-commit 检测提交时代码规范

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 时运行)

  2. 该操作会生成对应文件 pre-commit:
    git约定式提交规范_第2张图片

五.lint-staged 自动修复格式错误

pre-commit 处理了 检测代码的提交规范问题,当我们进行代码提交时,会检测所有的代码格式规范 。

但是这样会存在两个问题:

1.我们只修改了个别的文件,没有必要检测所有的文件代码格式
2.它只能给我们提示出对应的错误,我们还需要手动的进行代码修改

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

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

  1. **修改 package.json 配置 **
"lint-staged": {
    "src/**/*.{js,vue}": [
      "eslint --fix",
      "git add"
    ]
  }

  • 如上配置,每次它只会在你本地 commit 之前,校验你提交的内容是否符合你本地配置的 eslint规则(这个见文档 ESLint ),校验会出现两种结果:
  • 如果符合规则:则会提交成功。
  • 如果不符合规则:它会自动执行 eslint --fix 尝试帮你自动修复,如果修复成功则会帮你把修复好的代码提交,如果失败,则会提示你错误,让你修好这个错误之后才能允许你提交代码
  1. 修改 .husky/pre-commit 文件
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx lint-staged


  1. 再次执行提交代码
  2. 发现 暂存区中 不符合 ESlint 的内容,被自动修复

流程如下:
先执行git add . 因为git cz 只是替代git commit -m’‘ 这一步而已,执行完这一步还需要执行git pull和git push,整个提交过程才算是完成
git约定式提交规范_第3张图片
git约定式提交规范_第4张图片
git约定式提交规范_第5张图片

你可能感兴趣的:(vue,web前端,git,github)