VSCode合理配置ESLint+Prettier

简介: VSCode合理配置ESLint+Prettier

前言


昨天,我的开源项目成员给我提交了代码,我在用webstorm看他的代码时发现了一堆跟代码格式相关的黄色报错,我就问他这一堆黄色报错你的编辑器就没给你提示吗?他说他用的vscode没有提示这些报错。


于是,我就亲自下载了vscode搞了下发现真没提示,在百度和掘金搜了下vscode配置eslint+prettier的文章没有一个好使的,终于在踩了很多坑后,配置成功了。


本文就跟大家分享下如何在vscode上配置Eslint+Prettier,欢迎各位感兴趣的开发者阅读本文。


写在前面


本文中所使用的项目在package.json中已经装了相关依赖包,在项目根目录也有其对应的配置文件。webstorm是可以正确识别我的配置文件在保存时进行格式化的,vscode就不行了,本文的目的就是解决这个问题。


本文中使用的项目地址:chat-system


插件安装


我们先需要为vscode安装相关插件。


  • 安装eslint、prettier插件

640.png

640.png

640.png


插件使用


这里你可以选择直接修改vscode的setting.json文件,这样的修改是本地的,无法做到同步,如果有其他人也是用的vscode,那么你要告诉他改什么改什么,他在去改,甚是麻烦。


我这里选择在项目的根目录创建.vscode文件夹, 然后再在其下面创建setting.json文件,将这个文件夹同步到git,这样做vscode就会优先读取项目根目录下的配置文件了,完美的解决了刚才那个痛点。


创建好文件后,添加下述配置:


{
  "[vue]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "eslint.alwaysShowStatus": true,
  "eslint.format.enable": true,
  "eslint.packageManager": "yarn",
  "eslint.run": "onSave",
  "prettier.packageManager": "yarn",
  "eslint.validate": [
    "vue",
    "javascript",
    "javascriptreact"
  ],
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },
  "vetur.validation.template": false,
  "editor.formatOnPaste": true,
  "editor.formatOnType": true,
  "editor.formatOnSave": true,
  "files.eol": "\n"
}


注意:如果你启用了prettier,但是没有相关配置文件,editor.formatOnSave选项就要设置为false。不然会与vscode自身的保存起冲突


接下来,我们来配置prettier,同样的在项目根目录创建.prettierrc.json文件,添加下述配置:


{
  "tabWidth": 2,
  "useTabs": false,
  "endOfLine": "auto",
  "singleQuote": false,
  "semi": true,
  "trailingComma": "none",
  "bracketSpacing": true
}


上述配置是我项目的相关规范,你可以按照你的实际需求去弄,对此不了解的可以去查阅官方文档。


做完上述配置后,vscode就已经可以按照我们的规范来进行相应的提示了,按ctrl+s保存代码时其也会按照我们自定义的的规范进行格式化。


写在最后


  • 公众号无法外链,如果文中有链接,可点击下方阅读原文查看😊


相关文章
|
1月前
|
编译器 C语言 C++
VSCode上搭建C/C++开发环境(vscode配置c/c++环境)Windows系统---保姆级教程
VSCode上搭建C/C++开发环境(vscode配置c/c++环境)Windows系统---保姆级教程
|
1月前
|
人工智能 NoSQL 机器人
【C++】VS code如何配置使用C++(手把手教学)
【C++】VS code如何配置使用C++(手把手教学)
|
1月前
|
编译器 开发工具 C语言
vscode安装+配置+使用+调试【保姆级教程】
vscode安装+配置+使用+调试【保姆级教程】
289 4
|
2月前
|
前端开发
|
2月前
配置vscode
配置vscode
25 4
|
3月前
|
前端开发 JavaScript Windows
前端秘法引言(配置vscode, 以及html的基础)
前端秘法引言(配置vscode, 以及html的基础)
175 0
|
3月前
|
C语言 C++
VScode中C++多文件编译运行问题(使用code runner配置)
VScode中C++多文件编译运行问题(使用code runner配置)
|
4月前
|
编译器 测试技术 C语言
vscode+CMakeLists+mingw配置Opencv4.5.5
vscode+CMakeLists+mingw配置Opencv4.5.5
218 0
|
4月前
|
Linux C++
vscode中配置cmake及debug使用
vscode中配置cmake及debug使用
277 0
|
4月前
|
机器学习/深度学习 人工智能 PyTorch
VScode配置深度学习环境python+conda
VScode配置深度学习环境python+conda
285 0