git 提交之规范校验 (eslint+husky+prettier)

开发过程中为了统一团队编码规范,会用 Eslint 去检查和自动修复 js 代码。但是代码规范检查不通过,还是可以提交 commit 记录的,这显然是有问题的, 还好 git hook 提供了很多钩子函数绑定在 git 各个命令上,这样就可以把 eslint 代码检查放在 pre-commit hook 中, 这样如果eslint 检查不通过就不让提交了。

1、Git hooks(git钩子)

默认情况下项目中 .git/hooks(.git文件夹下的hooks文件夹) 中已经内置了很多 hook,比如 pre-commit。如下图:


image.png

这些hooks文件夹下有很多git默认自带的钩子文件,这里我们主要使用pre-commit这个钩子文件。
我们找到.git/hooks/pre-commit文件,修改当前文件里的内容为:

echo '我是测试pre-commit钩子命令的'

然后在git 面板里执行git commit 命令,可以看到我们在执行git commit 命令时候触发了pre-commit钩子,输出了:'我是测试pre-commit钩子命令的'。如下图


image.png

我们在.git/hooks/pre-commit文件里执行了输出一行字,那如果我们修改当然文件,让文件执行eslint校验,如下图


image.png

注意.git/hooks/pre-commit文件里写 npm run eslint 那么一定要在package.json文件里添加如下代码:
"scripts": {
  "eslint": "eslint --ext .js,.vue zdyProject/" //注意这个zdyProject/是我测试的文件目录,请根据自己代码自行修改
},

到这里基本就完成了git提交时执行eslint校验功能了。但是在实际的团队项目里我们并不会这样做,因为我们是团队合作,.git/hooks/pre-commit文件修改后只会在本地,并不能上传到git上供其它成员使用,因为git会忽略.git文件夹下的文件。这个时候husky就可以解决这个问题。

2、husky

github为了解决.git配置不能提交远程仓库的问题,husky 出来了,husky 在你npm i安装完依赖只有自动执行husky install。

2.1、安装husky
npm install husky -D
2.2、使用husky

编辑package.json在script里添加prepare的值为husky install

"scripts": {
    "prepare":"husky install"
  },

然后执行npm run prepare,这个命令做了什么事呢 ?实际上就是创建 .husky 目录,修改了.git/config文件里的hooksPath字段(设置 .husky 目录为 git hooks 目录)


image.png

我们在.husky目录下创建一个pre-commit文件,里面放入代码 npm run eslint(如下图a)。

我们随便修改一下项目里的文件,然后执行git add .,git commit -m '测试husky',发现代码已经被拦截,没有提交,因为index.vue代码不符合规范(效果如下图a)。

a.png

到这里husky的简单配置已经完成,但是试想一下有没有问题?,假如项目里有a.js,b.js文件,我修改了a.js,b.js文件,但是我执行了git add a.js(也就是只把a.js文件提到了git缓存),那如果我们现在git commit 应该也只应该校验a.js才对,但是按照上面的配置,我们会在git commit的时候会校验的项目下的全部文件,这显然不对,也就是我们.husky目录下的pre-commit文件内容显然是不能够做到这样的,这时候就必须改写pre-commit文件内容,pre-commit文件是一个shell文件,对前端而言肯定是一大难题,不好写。这个时候就要用到lint-staged,用它来解决这个问题。

3、lint-staged

lint-staged作用:对 Git 暂存区代码文件进行 bash 命令操作等等。
先安装

npm i lint-staged -D

package.json添加script

"scripts": {
  "eslint": "lint-staged"
},
"lint-staged": {
    "*.{js,vue}": [
      "prettier --write",
      "eslint --ext .js,.vue"
    ]
  }

随便修改一下项目里a.js,b.js文件,然后执行git add a.js,git commit -m 'test',可以发现调用了 eslint 去检查代码,eslint只检查了a.js文件,并没有校验b.js文件。检查不通过就退出commit。如下图b


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

推荐阅读更多精彩内容