使用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

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

推荐阅读更多精彩内容