React项目工程化(三)集成Husky+lint-staged实现代码提交校验

项目里eslint+prettier都已经集成了,但是没有一个强制的规范,还是会有同学把不符合规范的代码提交上远程仓库,怎么办呢?通过husky+lint-staged可以很好地实现提交代码前强制校验

Husky: 一个钩子工具,可以在这里做一些commit之前的预检查

lint-staged: 一个过滤工具,可以过滤出在git staged状态下的文件

Step 1、依赖安装

yarn add -D husky@6.0.0 lint-staged

这里必须使用6.0.0版本的husky,在此之上的husky有版权问题

Step 2、情况判断

判断.git文件是否在项目的根目录
若是,即单一项目,可以直接在项目里的package.json中添加执行命令

//  .git  文件在你当前项目的根目录下时,修改项目根目录下的 package.json
  "scripts": {
    "prepare": "husky install"
  },

若否,则为聚合多个子项目的项目,则需要根据目录定义husky install命令
如目录结构为:

+ .git
- project_1
   - package.json
+ project_2
+ project_3

针对project_1package.json,添加如下执行命令

// .git  文件不在在你当前项目的根目录下时,修改项目根目录下的 package.json
  "scripts": {
    "prepare": "cd .. && husky install project_1/.husky"
  },

Step 3、执行yarn run prepare

执行完毕,将会在project_1目录下,出现一个.husky文件夹

image.png

Step 4、添加pre-commit钩子

$ npx husky add .husky/pre-commit 

此时会发现,.husky文件夹下,新增了pre-commit文件

image.png

Step 5、修改pre-commit文件

新建的pre-commit文件,默认是这样的

image.png

当为:单一项目,修改成:

image.png

当为:聚合多个子项目的项目,修改成:

image.png

Step 6、新建并配置.lintstagedrc.js文件

// .lintstagedrc.js 文件中的代码如下
module.exports = {
    "src/**/\*{js,jsx,ts,tsx,md,html}": ["eslint", "prettier --write"],
    "src/**/*.scss": ["stylelint --fix", "git add"],
}

最后检查下,其效果后是这样的:

当不符合规范的代码试图被提交

image.png

完成

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

推荐阅读更多精彩内容