Skip to main content

代码提交验证

1.4. git Husky和eslint（后续）​

虽然我们已经要求项目使用eslint了，但是不能保证组员提交代码之前都将eslint中的问题解决掉了：

  • 也就是我们希望保证代码仓库中的代码都是符合eslint规范的；

  • 那么我们需要在组员执行 git commit 命令的时候对其进行校验，如果不符合eslint规范，那么自动通过规范进行修复；

那么如何做到这一点呢？可以通过Husky工具：

  • husky是一个git hook工具，可以帮助我们触发git提交的各个阶段：pre-commit、commit-msg、pre-push

如何使用husky呢？

这里我们可以使用自动配置命令：

npx husky-init && npm install

这里会做三件事：

1.安装husky相关的依赖：

2.在项目目录下创建 .husky 文件夹：

3.在package.json中添加一个脚本：

"prepare": "husky install"

接下来，我们需要去完成一个操作：在进行commit时，执行lint脚本：

在.husky/pre-commit中修改

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

pnpm lint

这个时候我们执行git commit的时候会自动对代码进行lint校验。

1.5. git commit规范（后续）​

1.5.1. 代码提交风格​

通常我们的git commit会按照统一的风格来提交，这样可以快速定位每次提交的内容，方便之后对版本进行控制。

但是如果每次手动来编写这些是比较麻烦的事情，我们可以使用一个工具：Commitizen

  • Commitizen 是一个帮助我们编写规范 commit message 的工具；

1.安装Commitizen

npm install commitizen -D

2.安装cz-conventional-changelog，并且初始化cz-conventional-changelog：

# npm
npx commitizen init cz-conventional-changelog --save-dev --save-exact

# yarn
npx commitizen init cz-conventional-changelog --yarn --dev --exact

# pnpm
npx commitizen init cz-conventional-changelog --pnpm --save-dev --save-exact

这个命令会帮助我们安装cz-conventional-changelog，并且在package.json中自动添加：

.... 
"config": {
    "commitizen": {
      "path": "./node_modules/cz-conventional-changelog"
    }
  }

这个时候我们提交代码需要使用 npx cz，或者在package.json中添加 

  "scripts": {
     ...
    "commit":"cz"
  },
  • 第一步是选择type，本次更新的类型
Type作用
feat新增特性 (feature)
fix修复 Bug(bug fix)
docs修改文档 (documentation)
style代码格式修改(white-space, formatting, missing semi colons, etc)
refactor代码重构(refactor)
perf改善性能(A code change that improves performance)
test测试(when adding missing tests)
build变更项目构建或外部依赖（例如 scopes: webpack、gulp、npm 等）
ci更改持续集成软件的配置文件和 package 中的 scripts 命令，例如 scopes: Travis, Circle 等
chore变更构建流程或辅助工具(比如更改测试环境)
revert代码回退

  • 第二步选择本次修改的范围（作用域）

  • 第三步选择提交的信息

  • 第四步提交详细的描述信息

  • 第五步是否是一次重大的更改

  • 第六步是否影响某个open issue

1.5.2. 代码提交验证​

如果我们按照cz来规范了提交风格，但是依然有同事通过 git commit 按照不规范的格式提交应该怎么办呢？

  • 我们可以通过commitlint来限制提交；

1.安装 @commitlint/config-conventional 和 @commitlint/cli

npm i @commitlint/config-conventional @commitlint/cli -D

2.在根目录创建commitlint.config.js文件，配置commitlint

module.exports = {
  extends: ['@commitlint/config-conventional']
}

3.使用husky生成commit-msg文件，验证提交信息：

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

4.这样会在.husky目录下面生成commit-msg文件，里面有提交时需要校验信息的指令。

5.如果运行时，出现[eslint] 'module' is not defined. (no-undef)，可以在.eslintrc.cjs中配置env中包含node环境。

/* eslint-env node */
require('@rushstack/eslint-patch/modern-module-resolution')

module.exports = {
...
  "env": {
    "browser": true,
    "amd": true,
    "node": true
 },
 ...
}