0

0

如何为VSCode配置ESLint和Prettier以实现代码自动规范【教程】

紅蓮之龍

紅蓮之龍

发布时间:2026-01-22 14:46:03

|

679人浏览过

|

来源于php中文网

原创

ESLint 与 Prettier 需分工协作:ESLint 专注逻辑检查,Prettier 专责格式化;须禁用 ESLint 格式功能、启用 eslint-config-prettier 关闭冲突规则,并在 VSCode 中指定 Prettier 为唯一格式化器。

如何为vscode配置eslint和prettier以实现代码自动规范【教程】

VSCode 里配 ESLint 和 Prettier 不是为了“装个插件就完事”,而是要让两者不打架、各司其职:ESLint 检查逻辑和潜在错误,Prettier 负责格式化。如果没理清分工,你会遇到保存后代码被反复重排、规则冲突报错、eslint-config-prettier 失效等典型问题。

为什么 ESLint 和 Prettier 会互相覆盖

ESLint 默认带部分格式规则(比如 indentquotes),而 Prettier 也管这些。二者同时启用且未协调时,VSCode 可能先用 ESLint 格式化一遍,再被 Prettier 覆盖,或者保存时触发两次格式化,导致光标跳动、代码“抖动”。关键不是禁用谁,而是让 ESLint 专注代码质量,把格式全交给 Prettier。

  • 安装 eslint-config-prettier,并在 ESLint 配置中 最后 extend 它,用来关闭所有与 Prettier 冲突的格式类规则
  • .eslintrc.cjs.eslintrc.json 中确认没有手动开启如 semicomma-dangle 等格式规则
  • VSCode 设置里关掉 "editor.formatOnSave": true 对 ESLint 的绑定(即不要设 "editor.defaultFormatter": "dbaeumer.vscode-eslint"

VSCode 必须启用的三个设置项

仅装插件不够,VSCode 自身的编辑器行为必须对齐工具链。以下三项缺一不可,且顺序和值敏感:

  • "editor.formatOnSave": true —— 保留,但需指定唯一 formatter
  • "editor.defaultFormatter": "esbenp.prettier-vscode" —— 必须设为 Prettier 插件,不能是 ESLint
  • "eslint.enable": true"eslint.format.enable": false —— 显式禁用 ESLint 的格式能力,只保留校验

注意:"eslint.format.enable" 默认是 true,不手动设 false 就会和 Prettier 同时抢着格式化。

Powtoon
Powtoon

AI创建令人惊叹的动画短片及简报

下载

如何验证 ESLint + Prettier 是否真正协同工作

最直接的验证方式是改一个明显违反规则但不涉及格式的问题,比如写 console.log('test');(假设你用了 no-console 规则),看 VSCode 底部状态栏是否标出 ESLint 警告;再删掉分号,保存——代码应自动补上分号(由 Prettier 控制),且 ESLint 不再报 semi 错误(已被 eslint-config-prettier 关闭)。

  • 打开命令面板(Ctrl+Shift+P),运行 ESLint: Show Output Channel,查看日志里是否加载了你的配置文件
  • 右键编辑器 → “Format Document With…” → 确认默认项是 Prettier,不是 ESLint
  • 在 JS 文件里故意写 if (a) { console.log(b) }(缺大括号),ESLint 应报 curly 错误;但不会因缩进或换行报错

真正的难点不在安装步骤,而在于配置文件层级叠加(项目级、用户级、插件默认)带来的隐性覆盖。建议始终在项目根目录放 .eslintrc.cjs.prettierrc,并用 npx eslint --print-config ./src/index.js 查看最终生效的规则集——很多“不生效”的问题,其实只是某一层配置悄悄覆盖了你以为的设置。

相关专题

更多
json数据格式
json数据格式

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

417

2023.08.07

json是什么
json是什么

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

533

2023.08.23

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

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

310

2023.10.13

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

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

76

2025.09.10

python中print函数的用法
python中print函数的用法

python中print函数的语法是“print(value1, value2, ..., sep=' ', end=' ', file=sys.stdout, flush=False)”。本专题为大家提供print相关的文章、下载、课程内容,供大家免费下载体验。

185

2023.09.27

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

757

2023.08.22

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

679

2023.07.31

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

431

2024.06.27

菜鸟裹裹入口以及教程汇总
菜鸟裹裹入口以及教程汇总

本专题整合了菜鸟裹裹入口地址及教程分享,阅读专题下面的文章了解更多详细内容。

0

2026.01.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
go语言零基础开发内容管理系统
go语言零基础开发内容管理系统

共34课时 | 2.6万人学习

第二十三期_前端开发
第二十三期_前端开发

共98课时 | 7.5万人学习

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

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