Git Hooks

具备基本工程素养的同学都会注重编码规范,而代码风格检查(Code Linting,简称 Lint)是保障代码规范一致性的重要手段。

使用 Lint 会有什么好处呢?在我看来至少具有如下 3 点:

  • 更少的 Bug
  • 更高的开发效率,Lint 很容易发现低级的、显而易见的错误
  • 更高的可读性

很多时候我们lint的校验是放在持续集成阶段,大概流程如下:

代码提交 --> 跑 CI 发现问题(远程) --> 本地修复问题 --> 重新提交 --> 通过检查(远程)

但这样有一个问题,我们的 CI(持续集成) 往往不是仅仅只做 Lint工作,它还有会有很多其它的任务(如打包文件,静态资源上传 CDN 等),这样就导致特别的浪费时间,往往可能需要几分钟之后你才会发现问题,或者有的时候你根本就没有发现你的 CI 没有跑通过。

常见的流程:本地写好了代码,提交,开始跑 lint,发现不通过,本地修改代码,再提交,再等待 CI 的结果,若还有问题再重复之前的操作。

husky

最有效的解决方案就是将 Lint 校验放到本地,常见做法是使用 husky 或者 pre-commit 在本地提交之前先做一次 Lint校验。

当然如果你创建项目的时候使用了 vue-cli@3,你也可以使用它内置的 yorkie,它是基于husky的,但稍微改了一下接口。不过这里我们还是选用 husky作为例子。

# 注意:我们之后的例子都是1.3.1+ 版本!
npm install husky -D -S

然后修改 package.json,增加配置:

"husky": {
    "hooks": {
      "pre-commit": "eslint --ext .js,.vue src"
    }
  }

最后尝试 Git 提交,你就会很快收到反馈:

git commit -m "Keep calm and commit"

但这样会有一个问题,就是这次提交,我可能只修改了一个文件,比如我就修改了 foo.js 的内容,但它依然会校验所有src 下面的.js文件,非常的不友好。导致的问题就是:每次我提交我写的代码,还先要帮人的代码问题解决了才能顺利提交,而且当项目大了之后,检查速度也会变得越来越慢了。

lint-staged

解决上面的痛点就需要使用 lint-staged 了。它只会校验检查你提交或者说你修改的部分内容。

npm install lint-staged -D -S

然后,修改 package.json 配置:

"husky": {
  "hooks": {
    "pre-commit": "lint-staged"
  }
},
"lint-staged": {
    "src/**/*.{js,vue}": [
      "eslint --fix",
      "git add"
    ]
  }

如上配置,每次它只会在你本地 commit 之前,校验你提交的内容是否符合你本地配置的 eslint规则(这个见文档 ESLint ),如果符合规则,则会提交成功。如果不符合它会自动执行 eslint --fix 尝试帮你自动修复,如果修复成功则会帮你把修复好的代码提交,如果失败,则会提示你错误,让你修好这个错误之后才能允许你提交代码。

总结

最佳的 lint 规范流程就是推荐团队成员先在自己的编辑器中配置 eslint,在 webpack 中配置并开启 eslint-loader 错误提示,这样平时写的时候编辑器就能帮你修正一些简单的格式错误,同时提醒你有哪些不符合 lint 规范的的地方,并在命令行中提示你错误。这方面详细的内容见 ESLint

但这并不是强制的,有些团队成员或者说刚来的实习生没有在编辑器中配置或者无视命令行中提示的错误,这时候就需要配置pre-commit 这种强制性校验的东西,保证所有提交到远程仓库的内容都是符合团队规范的。