preitter +eslint+vscode插件+git hooks的配置方法

preittier和eslint有npm包也有vscode插件,平时应该怎么搭配使用,还有prettier格式化代码和eslint会产生规则冲突的问题。比如你在prettier中设置了semi:false,而eslint的推荐规则是强调你必须在行尾加分号的。就会产生冲突。

解决eslint和prettier的冲突问题

有两种方法,一个是直接放弃使用prettier,反正eslint也能格式化代码,把js加入prettier忽略的文件里面

另一个是使用prettier官方的解决方案eslint-config-prettier,他的原理是将eslint里面和prettier重叠的配置都关掉。

npm install --save-dev eslint-config-prettier

在eslint的配置文件r.eslintrc.* 里面,进行配置,只需在extends里面放在最后一行,因为要保证覆盖前面的配置。

{
  "extends": [
    "some-other-config-you-use",
    "prettier"
  ]
}

单独使用vscode插件的不安装npm包的方法

不想安装npm包的理由很简单,因为你每个项目都要npm install这么一下,多了一大堆文件,你搭脚手架的等待时间变长。你删除文件花的时间也变长,要是能在vscode插件上直接配好不是很方便吗。

prettier的vscode插件 esbenp.prettier-vscode

prettier的vscode的插件是集成了功能的,可以独立使用。并且可以读取当前项目目录的配置文件,优先级高于你在编辑器的配置。并且你在项目安装了prettier,他会优先读取,并且有个配置项配置了 prettier.resolveGlobalModules为true,他也会从全局下载的npm包中找prettier,都找不到了才会用编辑器绑定的prettier。

而官方推荐的方式是在项目目录中安装本地开发依赖

关于配置文件读取的优先级如下:

  1. Prettier configuration file
  2. .editorconfig
  3. Visual Studio Code Settings (Ignored if any other configuration is present)

所以,prettier 可以单独使用,但是还是建议安装本地开发依赖

eslint的vscode插件dbaeumer.vscode-eslint

eslint的vscode插件并不能单独使用,你只能全局安装一个或者项目文件夹里面安装一个。

全局安装一个就能正常使用了npm install -g eslint

综上,如果要讲prettier+eslint一起使用,你至少要在项目文件夹中安装个eslint-config-prettier配置好,并且全局安装eslint

然后最推荐的方式还是在项目文件夹安装,因为作为开发依赖,你需要把它记录到package.json中保持一致性。比如说你把这个项目传到git,然后过一阵子有人下载下来,要用eslint,版本跟你用的不一样,可能就会因为配置变化多一堆报错。。。

另外开发依赖里面你还需要一个git hook,这些都是在本地配置比较方便。

作为开发依赖安装eslint+prettier的流程

01.安装prettier相关

npm install prettier --save-dev
npm install eslint-config-prettier --save-dev

然后把你写的prettier文件复制过来,我对默认配置只改了两项。

//.prettierrc.js
module.exports = {
  semi: false,
  singleQuote: true,
}

02.安装eslint相关

npm install eslint --save-dev

然后安装你想用的js代码风格之类的,可以用npx eslint --init,他预设了一些配置的选项给你选,包括typescript也可以支持。

配置完eslint,你就可以配置和prettier的兼容了。

.eslintrc.js里extends里面最后加上prettier

{
  "extends": [
    "some-other-config-you-use",
    "prettier"
  ]
}

03.配置git hooks

这里介绍一种用lint-stage进行配置的方法,

直接安装npm install --save-dev lint-staged husky

husky现在的版本号是6.0,配置方式已经发生了变化,网上很多教程是4的版本号已经不适用了。

# 执行完这样代码会多出一个.husky目录
npx husky install
# 后面字符串参数就是pre-commit阶段里面会执行的命令,你也可以直接编辑pre-commit文件添加命令
npx husky add .husky/pre-commit "npx lint-staged"

然后在package.json文件里添加lint-staged的配置,注意prettier要放在最后执行

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

推荐阅读更多精彩内容