展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > 如何在VSCode中解决ESLint与Prettier的格式化冲突

如何在VSCode中解决ESLint与Prettier的格式化冲突

ESLint 与 Prettier 冲突源于职责混淆:ESLint 应专注逻辑错误,Prettier 负责格式;需禁用 ESLint 格式规则、关闭其自动修复、确保 eslint-config-prettier 在 extends 末尾,并配置 VSCode 仅由 Prettier 格式化。 说到底

本文目录

    ESLint 与 Prettier 冲突源于职责混淆:ESLint 应专注逻辑错误,Prettier 负责格式;需禁用 ESLint 格式规则、关闭其自动修复、确保 eslint-config-prettier 在 extends 末尾,并配置 VSCode 仅由 Prettier 格式化。

    如何在VSCode中解决ESLint与Prettier的格式化冲突

    说到底,ESLint 和 Prettier 的冲突,根源往往不是工具本身有问题,而是我们没把它们的职责边界划清楚。一个应该专心抓代码的逻辑错误和潜在 Bug,另一个则专职负责代码的“颜值”和格式。只要把格式类的规则从 ESLint 手里剥离出来,同时管住它那双“爱动手”的自动修复功能,再确保配置的加载顺序不出错,编辑器里那些恼人的红黄波浪线,自然就消停了。

    为什么保存后波浪线反复闪、代码越修越乱

    典型的场景是这样的:你按下 Ctrl+S 保存文件,Prettier 立刻把 const a = 1 改成了 const a = 1;(加了个分号)。可紧接着,ESLint 就跳出来报错,提示“Missing semicolon”。这其实是因为,ESLint 检查的时机可能卡在了 Prettier 格式化完成之前,它看到的还是没加分号的原始代码。更糟糕的是,如果 VSCode 里 eslint.autoFixOnSa ve 和 editor.formatOnSa ve 这两个开关同时开着,它们俩就会像打乒乓球一样,轮流覆盖对方的修改结果,代码也就越改越乱。

    • 问题的根本,通常不是版本不兼容,而在于 ESLint 依然在固执地检查那些纯属格式范畴的规则,比如 indent(缩进)、quotes(引号)、semi(分号)、comma-dangle(尾随逗号)。
    • 配置顺序是关键。eslint-config-prettier 这个包必须出现在 .eslintrc.js 配置文件里 extends 数组的最后一位。否则,前面加载的配置(比如 airbnb 或 standard 的规则集)会把它覆盖掉,让它白忙一场。
    • VSCode 的默认行为也是个“帮凶”。它本身并不区分“代码校验”和“代码格式化”这两个动作,导致两个插件都监听同一个保存事件。这就好比让两个人同时修改同一份草稿,不乱才怪。

    如何配置 .eslintrc.js 让 ESLint 不再管格式

    我们的目标很明确:让 ESLint 完全信任 Prettier 格式化后的输出,只去报告那些真正的“硬伤”,比如 undefined is not a function 这类运行时错误,而别再纠结于“这里应该缩进2个空格而不是4个”这种风格问题。

    • 首先,安装必要的依赖包:npm install --sa ve-dev eslint-config-prettier eslint-plugin-prettier。
    • 接着,在项目的 .eslintrc.js 文件中,确保 extends 配置项里包含了 "prettier",并且它必须位于数组的末尾。例如:["eslint:recommended", "plugin:react/recommended", "plugin:prettier/recommended", "prettier"]。
    • 为了更保险,可以显式地添加一条规则:rules: { "prettier/prettier": "error" }。这条规则的作用是,让 ESLint 把 Prettier 识别出的格式问题也标记为错误,但它自己不会动手去修复,把修复权完全交给 Prettier。
    • 最后,记得清理掉所有手动编写的、与格式相关的 ESLint 规则。比如 "semi": ["error", "always"] 或者 "indent": ["error", 2] 这类,它们会直接和 Prettier 的配置打架。

    VSCode 设置必须关掉 ESLint 的 auto-fix

    很多人以为装好插件就万事大吉,其实不然。VSCode 默认可不会自动协调这两个“工人”谁该干什么。关键的配置开关,还得我们手动设置到位。

    • 在 VSCode 的设置中搜索 eslint.autoFixOnSa ve,将其设置为 false。这一步至关重要,直接关掉 ESLint 在保存时的自动修复功能。
    • 确认 editor.formatOnSa ve 设置为 true,并且将 editor.defaultFormatter 明确指定为 esbenp.prettier-vscode(即 Prettier 官方插件)。
    • 为了防止不同语言文件的特例干扰,一个稳妥的做法是在项目根目录的 .vscode/settings.json 文件里进行针对性设置。例如:"[ja vascript]": { "editor.defaultFormatter": "esbenp.prettier-vscode" }。
    • 注意,不要开启那个已经废弃的旧选项 prettier.eslintIntegration。这个配置会让 Prettier 反过来去读取 ESLint 的规则,等于又绕回了冲突的原点。

    验证配置是否生效的三个硬指标

    配置做完,不能光看编辑器里暂时没有波浪线就掉以轻心。得用下面三个动作来检验,看看结果是否符合预期:保存文件时是否只触发了一次格式化、ESLint 是否只报告逻辑错误、手动运行修复命令时它是否不动格式。

    • 测试保存格式化: 打开一个函数,故意把缩进改成空格(假设 Prettier 配置用制表符),保存后观察它是否被统一修正为 .prettierrc 里定义的 tabWidth 格式,而没有被 ESLint 的 indent 规则再改回去。
    • 测试规则静默: 删掉一行 console.log 语句末尾的分号。此时,ESLint 应该保持沉默,不再报错——因为 semi(分号)规则已经被 eslint-config-prettier 关闭了。但如果你的 .prettierrc 里设置了 "semi": false,那么 Prettier 会在你保存时,自动把这个分号删掉。
    • 测试命令行行为: 在终端里执行 npx eslint src/ --fix。理想的输出结果里,不应该出现诸如 ✖ 123 problems (0 errors, 123 warnings) 这样大片的格式警告,而应该只包含像 no-unused-vars(未使用变量)或 no-undef(未定义变量)这类真正的逻辑错误。

    这里有个最容易被忽略的坑:VSCode 的工作区设置和全局设置的优先级。即使你在项目的 .vscode/settings.json 里写得明明白白,如果用户之前在全局设置里把 editor.defaultFormatter 指定成了其他插件,那么全局设置依然会生效。所以,每次遇到一些诡异的、不符合预期的格式化行为,第一反应应该是打开命令面板(Ctrl+Shift+P),输入 Preferences: Open Workspace Settings (JSON),直接查看当前项目真正生效的配置到底是什么,这样才能精准定位问题所在。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    精品专题 更多
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    macOS软件

    正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

    IOS软件

    正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

    AI

    正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw macOS版
    AionClaw macOS版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy macOS版
    Loomy macOS版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

    AirBuddy 3 macOS版
    AirBuddy 3 macOS版

    AirBuddy 3 是面向 macOS 的蓝牙外设增强工具,可集中查看 AirPods、Beats 与苹果设备电量,提供快速连接、播放控制、电量提醒、桌面小组件和多台 Mac 外设接力等功能。

    AirServer macOS版
    AirServer macOS版

    AirServer macOS版可把 Mac 转换为无线投屏接收端,通过 AirPlay 或 Google Cast 接收手机、平板和电脑画面,并支持多设备同时连接、高清镜像及会话录制,适合家庭娱乐、课堂教学、会议演示和应用展示。

    AnyDesk macOS版
    AnyDesk macOS版

    AnyDesk macOS版是一款适用于远程办公、设备维护和客户支持的远程桌面工具,可连接并操作异地计算机,支持文件传输、无人值守访问、会话权限控制及跨平台协作。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。

    讯飞绘文 网页版
    讯飞绘文 网页版

    讯飞绘文网页版是科大讯飞推出的AI图文创作与内容运营工具,覆盖热点选题、文章生成、稿件校对、智能配图、排版发布和数据复盘等环节,适合自媒体创作者及内容团队在线使用。

    Maya(Autodesk Maya) Windows版
    Maya(Autodesk Maya) Windows版

    Autodesk Maya 是面向影视、电视、动画和游戏行业的专业三维制作软件,集多边形与 NURBS 建模、角色绑定、关键帧和动作捕捉动画、Bifrost 特效模拟、材质开发及 Arnold 渲染于一体,

    Aperty Windows版
    Aperty Windows版

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw Windows版
    AionClaw Windows版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy Windows版
    Loomy Windows版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。