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 关闭所有格式规则。

Article Forge
Article Forge

行业文案AI写作软件,可自动为特定主题或行业生成内容

下载
  • 执行 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 格式化——但二者不能同时启用“格式化”,否则顺序错乱。

  • 安装官方插件: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 . 验证,比任何本地设置都可靠。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

47

2026.02.13

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

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

192

2026.02.25

json数据格式
json数据格式

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

455

2023.08.07

json是什么
json是什么

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

546

2023.08.23

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

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

335

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

Golang channel原理
Golang channel原理

本专题整合了Golang channel通信相关介绍,阅读专题下面的文章了解更多详细内容。

261

2025.11.14

golang channel相关教程
golang channel相关教程

本专题整合了golang处理channel相关教程,阅读专题下面的文章了解更多详细内容。

351

2025.11.17

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

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

精品课程

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

共58课时 | 6万人学习

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

共12课时 | 1万人学习

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

共12课时 | 1.1万人学习

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

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