0

0

如何为VSCode添加代码质量检查工具_集成ESLint和Prettier的步骤【教程】

幻影之瞳

幻影之瞳

发布时间:2026-01-25 19:48:41

|

336人浏览过

|

来源于php中文网

原创

VSCode需手动集成ESLint与Prettier实现代码质量检查与格式化,关键在于职责分离(ESLint校验逻辑、Prettier统一格式)、本地安装依赖、禁用ESLint格式规则(通过eslint-config-prettier)、正确配置.vscode/settings.json启用保存时ESLint自动修复并禁用全局格式化,同时确保团队版本一致。

如何为vscode添加代码质量检查工具_集成eslint和prettier的步骤【教程】

VSCode 本身不自带代码质量检查,必须手动集成 ESLint 和 Prettier 才能实现实时校验与自动格式化。关键不是装插件,而是让两个工具不打架——ESLint 负责规则校验(比如 no-unused-vars),Prettier 负责统一格式(比如缩进、分号),它们默认职责重叠,直接共存会互相覆盖。

安装 ESLint 和 Prettier 的本地依赖

必须用项目级本地安装(npm install --save-dev eslint prettier),而非全局安装。VSCode 的 ESLint 插件默认优先使用工作区内的 eslint 可执行文件;若全局安装,多人协作时容易因版本不一致导致警告不一致或规则失效。

  • 运行 npx eslint --init 初始化配置,选择 “To check syntax and find problems”,再选 “JavaScript modules (import/export)” 和 “React”(按需),最后选 JSON 格式保存为 .eslintrc.json
  • 单独创建 .prettierrc 文件,内容可极简:
    {"semi": true, "singleQuote": true, "tabWidth": 2}
  • 务必加 .eslintignore,至少包含 node_modules/dist/,否则 ESLint 会扫描整个 node_modules,卡顿明显

配置 ESLint 使用 Prettier 规则(避免冲突)

ESLint 默认的格式类规则(如 indentquotes)必须禁用,否则和 Prettier 冲突,保存时反复触发修正、光标乱跳。正确做法是用 eslint-config-prettier 关闭所有格式规则。

  • 执行 npm install --save-dev eslint-config-prettier
  • .eslintrc.jsonextends 数组末尾追加 "prettier"(注意:必须放在最后,否则会被前面的配置覆盖)
  • 如果用了 TypeScript,额外加 eslint-config-prettier/@typescript-eslint,并确保 @typescript-eslint/eslint-plugin 版本与 ESLint 兼容(常见坑:ESLint v8 + @typescript-eslint v5 会报 ESLint couldn't determine the plugin...

VSCode 设置启用自动修复与格式化

仅装插件不配置,保存时不会自动修。需要明确告诉 VSCode:JS/TS 文件保存时调用 ESLint 修复,同时用 Prettier 格式化——但二者不能同时启用“格式化”,否则顺序错乱。

Mulan AI
Mulan AI

画布式AI视频创作平台,轻松制作爆款视频

下载
  • 安装官方插件:ESLint(by Dirk Baeumer)和 Prettier(by Prettier)
  • 在工作区 .vscode/settings.json 中写死以下三项:
    "editor.codeActionsOnSave": {
      "source.fixAll.eslint": true
    },
    "editor.formatOnSave": false,
    "[javascript]": {"formatting.provider": "prettier"}
  • 关键点:editor.formatOnSave 必须为 false,否则 Prettier 会抢在 ESLint 修复前格式化,导致 ESLint 报出“格式错误”(比如多了一个空格)

验证是否生效及常见失败信号

改一行代码后保存,看右下角状态栏是否出现 ESLint 图标闪烁,或打开命令面板(Ctrl+Shift+P)运行 ESLint: Show Output Channel 查看日志。失败往往藏在细节里:

  • 控制台报 Failed to load plugin 'prettier' → 检查 eslint-config-prettier 是否真的装在 devDependencies,且 .eslintrc.jsonextends 拼写正确(大小写敏感)
  • 保存后无反应 → 确认当前文件语言模式是 JavaScript(右下角显示),不是 Plain Text;也可能是 settings.json 放在了用户级而非工作区级,被其他配置覆盖
  • TSX 文件里 ESLint 不报错 → 检查 .eslintrc.jsonoverrides 是否包含了 "files": ["*.ts", "*.tsx"],并指定了 parser: "@typescript-eslint/parser"

最常被忽略的是:团队成员各自安装了不同版本的 Prettier 或 ESLint,导致同一份代码在 A 机器上“保存即修复”,在 B 机器上“保存后仍报错”。统一用 package.jsonengines 字段锁版本,并在 CI 中跑 npx eslint . 验证,比任何本地设置都可靠。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

559

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

437

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

776

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

479

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

554

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

1091

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

659

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

554

2023.09.20

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

58

2026.01.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 4.1万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.0万人学习

React核心原理新老生命周期精讲
React核心原理新老生命周期精讲

共12课时 | 1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号