利用 git 钩子做代码提交前的检查

前言

在前面《使用ESLint构建团队代码规则》《如何在WebStorm中配置ESLint》两篇文章中我介绍了eslint的搭建和项目中的运用,但还存在一个问题就是团队开发时,如何保证每个人提交的代码都是按规范修改好的?这时候我们可以利用git做提交前的最后把关。

原理

git中,我们每次执行commitpush等操作时,都会触发一个或多个shell脚本,这些脚本我们称为钩子,它们存放在.git/hooks目录下,我们可以看到目录下有commit-msg.samplepre-commit.sample等文件,这些都是案例文件,不会执行,要想执行的话把后面的.sample后缀去掉就可以了。

钩子执行顺序是有先后的

  • 前置(pre)钩子,在动作完成前调用
  • 后置(post)钩子,在动作完成后执行

当钩子在非零状态下退出,git操作就会停止。

所以总结来说,就是利用这一特点,在钩子里写入指令,执行git操作前先运行钩子里的指令,调用eslint检查代码,如果代码不符合规范就非零退出,git操作就会停止,从而达到我们的目的。

第三方插件

但是钩子默认是不继承的,clone下来的项目不会带有这些钩子,这样在团队开发中就不够优雅了。并且,我们如果只修改一个文件,就调用eslint检查了整个项目的文件(即使你能用.eslintignore忽略一部分),这样是性价比不高的操作。所以我们引入第三方插件帮助解决。

1. 安装插件

项目package.json目录所在路径下执行

npm  install eslint  husky lint-staged --save-dev
  • eslint:进行 JavaScript 代码检查的基础包;
  • husky:在 .git/hooks 中写入 pre-commit 等脚本激活钩子,在 Git 操作时触发;
  • lint-staged:参考 Git 中 staged 暂存区概念,在每次提交时只检查本次提交的文件。
2. 修改 package.json 配置,设置 precommit 和 lint-staged
"scripts": {
    "precommit": "lint-staged"
  },
  "lint-staged": {
    "linters": {
      "static/js/**/*.js": [
        "./node_modules/.bin/eslint --fix",
        "git add"
      ]
    }
  },
3. 文件过滤路径说明

指相对于package.json的路径,使用glob pattern匹配模式。

{
    "*.js": "工程下所有的 js 文件",
    "**/*.js": "工程下所有的 js 文件",
    "src/*.js": "src 目录中所有的 js 文件",
    "src/**/*.js": "src 文件夹下所有的 js 文件"
}
4. 钩子工作流程说明

当开发者执行 git add 操作将代码提交到暂存区后,再执行 git commit 操作时:

  1. 由于安装husky后其在.git/hooks中写入了pre-commit钩子,该钩子在 git commit 执行时被触发,执行npm run precommit脚本(即lint-staged命令);
  2. lint-staged的配置,就是利用linters对暂存区的文件路径应用过滤规则,匹配的文件将执行后面配置的任务,这里的任务就是调用项目中的eslint指令检查文件,如果报错则先自动修复--fix,最后把没有问题的代码加入暂存区git add
  3. 如果最终还有报错,则流程终止,无法执行 commit 操作。

总结

到此整个项目就应用上了eslint进行代码质量检查,解决了开发中检查和团队开发的问题,希望能帮助你解决同样的问题,谢谢!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,185评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,445评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,684评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,564评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,681评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,874评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,025评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,761评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,217评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,545评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,694评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,351评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,988评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,778评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,007评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,427评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,580评论 2 349

推荐阅读更多精彩内容