react eslint prettier husky 配置

2021.1.22 更新
当 vscode 的自动保存操作中加入了 eslint 的规则时,保存自动 fix 命中的规则,此时一定要注意,否则会出现些意想不到的问题。 比如在使用 useEffect 时,第一个函数中的一些变量或调用的方法在fix时就可能会自动修复后加入到依赖数组中,然后导致这个effection不停的执行,死循环一样。
解决方法可以在 当前文件代码的 eslint 小灯泡提示那选择相应的忽略操作,或者直接将 vscode 保存时的规则中去掉 eslint 的fixall 配置, 即删掉下边的配置(在vscode 中 Ctrl+Shift+P,输入open settings (json) )

 "editor.codeActionsOnSave": {
        "source.fixAll.eslint": true
    },

===================================================================================

2021.1.20 更新
现在的项目一直用的 react-app 的规则集,命中规则后会在控制台中展示,但是-------没有人改,有问题的没人改! 于是越积越多,控制台上满的eslint的提示,其它日志根本看不到。非常不爽,所以用了就要严格要求,不严格执行干脆就不要用了。
===================================================================================

项目使用create-react-app脚手架创建,因其自带有安装eslint, 故不必安装。若自行安装,则项目启动时会提示冲突且需要解决冲突后才能启动。
create-react-app脚手架创建项目后,在 package.json 中会有如下配置

  "eslintConfig": {
    "extends": "react-app"
  },
  "devDependencies": {
   ...
  }

以上代码片段并不强制约束提交时要改好检查出来的问题,它只是在启动项目后将eslint规则集检查到的问题展示在控制台中,若要强制约束,则需要使用husky在代码git commit时做验证,不通过则改到通过为止,就问你怕不怕!(瑟瑟发抖~)。

本文介绍相应的配置方法,各工具介绍可参附录自行查阅。

eslintConfig 配置

话说常用的规则集有三个,按宽松到严格分别为 standard, google, airbnb。更多
这里用的是 CRA 默认的 react 的规则集,再加上 prettier 的配置:

 "eslintConfig": {
    "extends": [
      "react-app",
      "prettier"
    ],
    "plugins": [
      "prettier"
    ],
    "rules": {
      "prettier/prettier": "error"
    }
 }
 ...

上边 extends:["react-app"]extends:["airbnb", "airbnb/hooks"]区别应该不大,常用的验证规则如 no-unused-vars,jsx-a11y/alt-text,react-hooks/exhaustive-deps,array-callback-return,no-dupe-keys 等都有。"react-app"的具体规则集没找到,只找到这么个东西 eslint-config-react-app,因为对这个要求不高,一般能用就行,也就不深究了。

"prettier"这个一定要配置在 “extends"数组的最后,确保格式化时使用的是 prettier 的规则。

关于 eslintConfig 配置可以参考 Extending or replacing the default ESLint config

husky 和 lint-staged 配置

// package.json配置
  "husky": {
    "hooks": {
      "pre-commit": "lint-staged"
    }
  },
  "lint-staged": {
    "*.{js,jsx}": [          // 此处仅验证 js 方件即可,json文件验证会有明显的规则不符的问题,
      "eslint --fix",        // 仅检验当前提交的文件
    //   "eslint --ext .tsx,.ts --fix ./src",  后边加 ./src 时会验证 src 下的所有对应后缀文件
      "prettier --write",
      "git add"
    ]
  }

以上参考从零配置 Eslint + Prettier + husky + lint-staged 构建前端代码工作流

如果用的 creat-react-app 生成的项目,会默认带一个 eslint, 如果你和你自行安装的版本不一致否项目启动时会有提示,然后项目启动失败

解决办法建议删除你安装的即可。
项目启动后,如果eslint的检测中有 node-modules路径的文件,则可以加一个.eslintignore配置文件,配置内容为

node_modules/**

refer: Set up ESLint, Prettier and pre-commit hooks using Husky for WordPress from Scratch

.prettierignore refer:prettier
Add a .prettierignore to let your editor know which files not to touch, as well as for being able to run prettier --write . to format the entire project (without mangling files you don’t want, or choking on generated files).

相关安装包

husky 是一个 Git Hook 工具,它可以在代码提交前允许我们做一些事情,从而防止一些不好的代码被提交上去。
lint-staged 是针对工作区修改的文件,这对我们只希望处理将要提交的文件将会非常有用。
prettier 代码格式化神器
eslint-config-prettier 解决eslint与prettier冲突配置

参考文档:
Extending or replacing the default ESLint config create-react-app 文档中关于 ESLint config 的配置扩展
eslint-config-airbnb
eslint安装及使用
eslint-plugin-jsx-a11y 静态AST检查器,用于检查JSX元素上的可访问性规则。

这篇文章其实有个问题没解决, 就是 create-react-app 自带的 eslint, 在 windows 执行到 lint-stage:["eslint --fix"] 这一步时,总是会提示没有找到 eslint。 解决思路应该是要将eslint 加到执行路径中,但我没测试。马上又要回到mac的天下了。以后再折腾吧

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

推荐阅读更多精彩内容