讲师中心 微信公众号

工具推荐

视频效率加速
剧云
剧云

中文短剧剧本制作平台

Seko
Seko

AI短剧一键生成成片

Laper
Laper

剧本策划到成片协作

立刻MV
立刻MV

低成本歌曲 MV、视频生成

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

阿涛吖_4467

阿涛吖_4467

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

|

396人浏览过

|

来源于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 默认的格式类规则(如 indent、quotes)必须禁用,否则和 Prettier 冲突,保存时反复触发修正、光标乱跳。正确做法是用 eslint-config-prettier 关闭所有格式规则。

shopify-app-react-router
shopify-app-react-router

构建 Shopify 嵌入式应用(Embedded App)的开发技能:基于 @shopify/shopify-app-react-router + React Router v7 + Admin API 2026-04。覆盖 shopifyApp 配置、authenticate.admin 的 GraphQL/REST 调用、Webhook 校验、Session 存储、订阅计费、App Bridge 导航、部署,并新增:适用场景判断、安全最佳实践、错误处理与容错、最佳实践、常见问题 FAQ、高级场景。G

下载
  • 执行 npm install --save-dev eslint-config-prettier
  • 在 .eslintrc.json 的 extends 数组末尾追加 "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 格式化——但二者不能同时启用“格式化”,否则顺序错乱。

  • 安装官方插件: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.json 里 extends 拼写正确(大小写敏感)
  • 保存后无反应 → 确认当前文件语言模式是 JavaScript(右下角显示),不是 Plain Text;也可能是 settings.json 放在了用户级而非工作区级,被其他配置覆盖
  • TSX 文件里 ESLint 不报错 → 检查 .eslintrc.json 中 overrides 是否包含了 "files": ["*.ts", "*.tsx"],并指定了 parser: "@typescript-eslint/parser"

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

热门AI工具

更多
PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

讯飞智文

一款面向学习和办公场景的AI文档创作工具,可辅助生成PPT与Word文档,提高资料整理和内容制作效率。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

332

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

540

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

411

2026.03.13

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

326

2026.06.03

TypeScript Node.js 全栈工程化与Monorepo架构实践
TypeScript Node.js 全栈工程化与Monorepo架构实践

本专题围绕 TypeScript 在 Node.js 全栈开发中的工程化实践展开,系统讲解 Monorepo 架构设计、包管理策略、模块复用机制以及服务端与前端统一类型系统的构建方法。通过真实项目案例,帮助开发者提升大型全栈项目的可维护性与协作效率。

738

2026.06.16

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2295

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

3762

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

1256

2023.10.13

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

60

2026.11.06

热门下载

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

精品课程

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

共58课时 | 12.5万人学习

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

共12课时 | 1.4万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn