VSCode怎么配置ESLint和Prettier共存_VSCode如何解决格式化和代码检查规则冲突【详解】

星明酱_1875

星明酱_1875

2026-04-12

298人浏览

原创

eslint 和 prettier 冲突的本质是职责未分离导致的重复格式化:eslint-plugin-prettier 等桥接方案过时,且 vscode 的 formatonsave 与 eslint 自动修复同时操作代码引发覆盖;正确做法是 prettier 仅格式化、eslint 仅做质量检查并禁用所有格式规则,vscode 中设 eslint 为默认格式化工具并启用 eslint.format.enable。

vscode怎么配置eslint和prettier共存_vscode如何解决格式化和代码检查规则冲突【详解】

ESLint 和 Prettier 冲突的本质是什么

不是工具本身打架,而是 ESLint 的 eslint-plugin-prettier 和 prettier-eslint 这类桥接方案已过时,且 VSCode 默认启用的 editor.formatOnSave 与 ESLint 的自动修复(eslint.codeAction.showDocumentation)可能重复操作同一段代码——比如一个换行、一个缩进,结果互相覆盖,最终格式错乱或报红。

正确做法是:让 Prettier 只做格式化(不介入规则检查),ESLint 只做代码质量检查 + 有限修复(禁用所有格式类规则),二者职责彻底分离。

  • 禁用 ESLint 中所有和格式相关的规则,例如 indent、quotes、semi、comma-dangle 等,统一交给 Prettier
  • 在 VSCode 中关闭 Prettier 扩展的自动格式化(避免和 ESLint 的保存时修复冲突)
  • 把 ESLint 扩展设为默认格式化工具,并开启 eslint.format.enable

VSCode 设置里必须改的三项关键配置

打开 VSCode 设置(Ctrl+, 或 Cmd+,),搜索并修改以下三项,缺一不可:

  • "editor.formatOnSave": true —— 保持开启,但必须确保此时默认格式化工具是 ESLint
  • "editor.defaultFormatter": "dbaeumer.vscode-eslint" —— 明确指定 ESLint 扩展接管格式化(前提是已安装 eslint 和 vscode-eslint)
  • "eslint.format.enable": true —— 这是关键开关,它让 ESLint 扩展支持格式化能力(依赖项目中存在 .prettierrc 和 eslint-config-prettier)

不要设置 prettier.eslintIntegration(该配置已在新版 Prettier 扩展中移除),也不要手动绑定 prettier-vscode 到 editor.defaultFormatter。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载

项目级配置文件怎么写才不踩坑

根目录下必须同时存在 .eslintrc.cjs(或 .eslintrc.js)和 .prettierrc,且 ESLint 配置中要显式关闭格式规则:

// .eslintrc.cjs
module.exports = {
  extends: [
    'eslint:recommended',
    'plugin:react/recommended',
    'prettier' // ← 这行必须放在最后,会覆盖前面所有格式类规则
  ],
  plugins: ['react'],
  rules: {
    'no-console': 'warn'
  }
};
  • eslint-config-prettier 必须通过 npm install --save-dev eslint-config-prettier 安装,并在 extends 中作为最后一项引入
  • .prettierrc 只管格式,内容如 {"semi": false, "singleQuote": true} 即可,无需额外插件
  • 如果用了 TypeScript,还需加装 @typescript-eslint/eslint-plugin 和 eslint-config-prettier,且 prettier 仍需排在 extends 最末位

保存后还是格式错乱?检查这三件事

常见“看似配置好了但无效”的真实原因:

  • 工作区启用了 settings.json 覆盖了用户级设置,检查当前文件夹下的 .vscode/settings.json 是否误写了 "editor.defaultFormatter": "esbenp.prettier-vscode"
  • ESLint 扩展未识别到本地 node_modules/.bin/eslint,终端运行 npx eslint --version 确认 CLI 可用;若报错,说明项目没装 eslint 或版本太低(建议 ≥8.0)
  • 文件未被 ESLint 认为是“受控文件”,检查右下角状态栏语言模式是否为 javascriptreact 或 typescriptreact,而不是 plaintext 或 javascript(后者可能跳过 JSX 检查)

最隐蔽的问题:某些 monorepo 项目里,VSCode 打开的是子包目录,但 ESLint 配置在根目录,此时需在子包的 .vscode/settings.json 中显式指定 "eslint.workingDirectories": ["./"]。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vscode

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2026.02.13

272

17

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

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

2026.02.25

480

17

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

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

2026.03.13

331

19

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

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

2026.06.03

246

29

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

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

2026.06.16

498

8

json数据格式
json数据格式

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

2023.08.07

1995

5

json是什么
json是什么

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

2023.08.23

2802

1

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

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

2023.10.13

956

3

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

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

2025.09.10

3159

7

热门下载

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

精品课程

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