React 项目中引入 Husky 6.x 和 Lint-staged

React 项目中引入 ESLint + Perttier 做代码规范React 项目中引入 Stylelint 做样式表代码规范 这两篇文章中我们了解到可以使用 ESLint 和 Stylelint 做代码规范,但本篇文章我们将介绍 HuskyLint-staged 这两种工具,他们也是做代码规范的,但侧重点却不同,同时使用并不冲突。

Husky:是一个代码提交钩子。即在代码被提交到Git仓库之前,我们可以在这里做一些预检查或者格式化,需要做这些操作,我们需要一个Git的提交钩子,简单说就是使用Git命令会触发的函数。

Lint-staged:是一个前端文件过滤的工具。是一个仅仅过滤出Git代码暂存区文件(被 committed 的文件)的工具。Lint-staged 仅仅是文件过滤器,不会帮你格式化任何东西。

步骤一、执行命令 npm install husky --save-dev 安装 husky 安装包

Husky支持的Git hooks还是很全面的,如常用的pre-commit、commit-msg。这样我们就能再一些特定的时间点做一些事情。

步骤二、判断 .git 文件是否在项目根目录下

2-1

步骤三、修改项目根目录下的 package.json 中 "scripts" 字段

情况1、 如果 .git 文件在你当前项目的根目录下,对 package.json 中 "scripts" 字段 做如下更改

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

情况2、如果 .git 文件不在你项目的根目录下,则需要自定义目录

3-1

在 .git主目录下的每个子项目,可以依照每个项目特有的规则执行钩子,特别在一个仓库管理多个项目时,在不影响各项目独自的 lint 配置的情况下,可以实现对子项目独立配置的自动化提交管理,互不影响。这种情况比较少见,但很不巧,我的项目就是这种情况,因此还需要将这种情况简述一下。
3-2

如图中所述,.git 文件不在当前项目的根目录下,这时对当前项目根目录中的 package.json 中 "scripts" 字段 做如下更改

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

步骤四、执行命令 npm run prepare

此时在当前项目的根目录下会出现一个 .husky 的文件夹


4-1

步骤五、执行命令创建 pre-commit 钩子

执行命令 npx husky add .husky/pre-commit 在 .husky文件夹中创建 pre-commit 文件

5-1

注意:为什么不使用官网中提供的命令呢?因为使用官网中提供的命令在某些情况下会出现始终创建不成功的情况,详情查看 Issues

步骤六、修改步骤五中创建的 pre-commit 文件

情况1: .git 文件在你当前项目的根目录下 (对应步骤三中的情况1)

6-1

 // 将 pre-commit 文件修改为如下代码
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx lint-staged

情况2: .git 文件不在你当前项目的根目录下 (对应步骤三中的情况2)

6-2

 // 将 pre-commit 文件修改为如下代码
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

cd projectName
npx lint-staged

步骤七、执行命令 npm install lint-staged --save-dev 安装 lint-staged 安装包

首先明确一下,Lint-staged仅仅是文件过滤器,不会帮你格式化任何东西,所以没有代码规则配置文件,需要自己配置一下

步骤八、在项目根目录中创建一个 .lintstagedrc.js 配置文件

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

步骤九、 测试 Husky + Lint-staged 配置是否生效
使用var定义的a变量,ESLint 规范报错,这时我们不去修改这个错误直接按照正常流程使用git提交代码,会发现git 不允许我们提交如下图9-2


9-2

9-3

参考网址
https://github.com/typicode/husky
https://github.com/okonet/lint-staged
https://blog.csdn.net/Banterise/article/details/115206267

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

推荐阅读更多精彩内容