使用Git hooks+ESLint做团队代码强制校验

在多人合作的项目团队中，根据开发规范，统一代码风格，是打造一支规范化技术团队必不可少的一部分。

在一个npm项目中，我们常用ESLint来做代码检查：

• 项目根目录下创建ESLint配置文件

# 项目
cd project
touch .eslintrc.js

根据ESLlint规则在.eslintrc.js文件中创建代码校验规则。

• 创建npm校验脚本

vi package.json
# 在scripts中新增一行
scripts: {
    "lint": "eslint --ext .js,.vue --ignore-path .gitignore .",
},

这样，就可以通过npm run lint来按照配置的ESLint规则检测代码的规范性。

• 利用 Git pre-commint 钩子实现强制校验

团队中人员水平和意识参差不齐，某些同事在客观和主观上会或多或少地疏漏代码校验这个环节。那么，如何去强制校验呢？

设想下，如果在代码提交时触发代码校验脚本，不通过则不能提交，不就实现了强制校验了吗？

Git 能在特定的重要动作发生时触发自定义脚本，详情见Git hooks。在这里，我们要在提交前检查其代码快照，所以采用pre-commit hooks。

如果你是一位精通shell脚本的大神，可以直接去修改Git pre-commit hooks的源文件：

cd .git/hooks
ls
# applypatch-msg.sample post-commit.simple pre-commit.simple ...

以.simple扩展名结尾的文件都是Git提供的示例。如果想让他们生效，需要移除`.simple

# 复制 pre-commit.simple 文件并去掉扩展名
cp pre-commit.simple pre-commit
# 写入你要执行的脚本
vi pre-commit
# xxx... 此处省略大神shell脚本，感兴趣的可以去 Google

同时，为了兼容快发人员快捷提交命令git commit -am"xxx"，还需要在pre-applypatch这个钩子下去做相同的配置。

大多数码农朋友对于shell脚本不是很精通，写起来也费时费力。这里推荐使用 husky，通过配置npm脚本，来自动生成pre-commit文件。

npm i husky -D

# 在package.json 的 scripts中继续新增一行
scripts: {
    "lint": "eslint --ext .js,.vue --ignore-path .gitignore .",
    "precommit": "npm run lint"
},

打开.git/hooks目录，发现生成了pre-commit文件。

自此，每次执行git commit -m 'xxx'操作，就会触发npm run lint。若钩子返回结果为false，则无法提交，修改代码直至通过校验后，方可提交通过。

相关资料：
Git hooks
husky
ESLint