使用husky+eslint来限制提交代码的格式

1.执行命令,安装 husky

yarn add -D husky@6.0.0 lint-staged

husky 是提供git钩子的解决方案,它可以提供git在多个阶段前的操作,比如pre-commit、pre-push等,这里我们使用pre-commit

lint-staged,它只对git暂存区的文件执行linter检测,相对每次执行lint命令,这种只对增量修改的检测效率会高很多

2.在package.json的scripts中配置prepare指令

"prepare": "cd .. && cd .. && husky install ./各种活动/medical_cosmetology/.husky"

按照设计,husky install必须在与 相同的目录中运行.git,但您可以在prepare脚本期间更改目录并传递子目录:

必须在与git相同的目录中运行

3.执行刚才配置的命令

yarn run prepare

执行完之后会在项目下生成如下.husky文件

4.执行这个命令

npx husky add .husky/pre-commit

执行完之后会在.husky下面生成一个pre-commit文件

5.修改pre-commit文件

打开刚刚生成的pre-commit文件是这样子的,接下来需要修改它



修改成这个样子,


6.在当前项目文件夹下,添加.lintstagedrc.js文件,内容如下

module.exports = { "src/**/\*{js,jsx,ts,tsx,md,html}": ["eslint", "prettier --write"],}

文件内容根据,根据情况,按需配置。

.lintstagedrc.js添加的位置如下


7.将.eslintrc.js文件内容修改成如下

module.exports = { env: { browser: true, es6: true }, extends: ["plugin:react/recommended", "prettier"], globals: { Atomics: "readonly", SharedArrayBuffer: "readonly" }, parserOptions: { ecmaFeatures: { jsx: true }, ecmaVersion: 2018, sourceType: "module" }, parser: "babel-eslint", plugins: ["react"], settings: { react: { version: "detect" } }, rules: { semi: ["error"], "no-unused-vars": ["error"], quotes: ["error", "double"], "react/prop-types": "off", "no-mixed-spaces-and-tabs": ["error"], "comma-dangle": ["error", "only-multiline"] } };

.eslintrc.js位置如下


这个文件用于做一些格式校验

8.安装几个插件

yarn add -D eslint-plugin-react babel-eslint eslint eslint-config-prettier prettier

.eslintignore/.eslintrc.js/.prettierignore/.prettierrc.js(这里几个文件eslintrc可以自己写检测,忽略规则,除了它eslintrc.js其它的不强求)

    eslint-plugin-react:设定react组件的相关规范

eslint-config-prettier:

    eslint :eslint中集成了prettier

    eslint-config-prettier:    eslint-plugin-prettier 插件会调用 prettier对你的代码风格进行检查,其原理是先使用                     prettier对你的代码进行格式化,然后与格式化之前的代码进行对比,如果过出现了不一致,这个地方就会被 prettier进行                标记。

    prettier:自定以代码风格

9.拉一个文件出来,做一点小修改,我这里添加了一个空行,测试刚才的配置是否正确


10.到此位置就配置好了

参考文献:

https://typicode.github.io/husky/#/?id=install-1

https://zhuanlan.zhihu.com/p/272797097

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

推荐阅读更多精彩内容