VSCode中如何配置ESLint和Prettier以统一代码风格【教程】

发布时间 - 2026-01-22 00:00:00    点击率:
ESLint与Prettier需协同工作:ESLint管逻辑规范,Prettier管格式化;须安装官方扩展及项目本地依赖(eslint v8+、prettier v3+),配置.eslintrc.cjs禁用格式规则并启用eslint-plugin-prettier,.prettierrc定义格式,VSCode设置中开启formatOnSave和codeActionsOnSave修复,并确保Prettier为默认格式器。

VSCode 里配 ESLint 和 Prettier 不是为了“装插件就完事”,而是要让两者不打架、各司其职:ESLint 负责代码质量与逻辑规范(比如 no-unused-vars),Prettier 负责格式化(缩进、引号、换行)。配错顺序或冲突规则,反而会导致保存时代码反复被改、报红、甚至格式化失效。

确认已安装核心扩展和依赖

缺一不可,且版本需兼容(推荐 ESLint v8+、Prettier v3+):

  • VSCode 扩展:必须装 ESLint(by Dirk Baeumer)和 Prettier(by Esben Petersen)——注意不是“Prettier ESLint”之类合体插件
  • 项目本地依赖:npm install --save-dev eslint prettier eslint-config-prettier eslint-plugin-prettier
  • 全局安装 eslintprettier 无意义,VSCode 默认优先用项目内二进制

配置 .eslintrc.cjs 让 ESLint 不干涉格式

关键在禁用所有和格式相关的 ESLint 规则,把格式控制权完全交给 Prettier:

module.exports = {
  extends: [
    'eslint:recommended',
    'plugin:prettier/recommended', // 这行会自动启用 eslint-plugin-prettier 并关闭冲突规则
  ],
  plugins: ['prettier'],
  rules: {
    'prettier/prettier': 'error', // 把 Prettier 错误当 ESLint 错误提示
  },
};

⚠️ 常见错误:eslint-config-prettier 必须放在 extend

s 数组最后;若手动写一堆 quotes: 'off' 类规则,容易漏、难维护。

设置 .prettierrc + VSCode 用户/工作区配置

格式规则只在 .prettierrc 定义,VSCode 设置里不要重复指定(尤其别开 "editor.formatOnSave": true 同时又设 "editor.defaultFormatter": "esbenp.prettier-vscode" 却没关 ESLint 自动修复):

  • .prettierrc 示例(JSON 格式):
    {"semi": false,"singleQuote": true,"tabWidth": 2,"printWidth": 100}
  • VSCode settings.json(工作区级更安全):
    {
      "editor.formatOnSave": true,
      "editor.defaultFormatter": "esbenp.prettier-vscode",
      "editor.codeActionsOnSave": {
        "source.fixAll.eslint": true // ✅ 关键:保存时触发 ESLint 自动修复(含 prettier/prettier 报错)
      },
      "eslint.validate": ["javascript", "typescript", "vue"] // 按需加语言
    }
    

⚠️ 若发现保存后引号变双、分号又回来了,大概率是 eslint-plugin-prettier 没生效,或 eslint-config-prettier 位置不对。

遇到 “Prettier not found” 或格式化不触发?查这三处

这类问题几乎都出在路径或作用域上:

  • 打开命令面板(Ctrl+Shift+P),运行 Developer: Toggle Developer Tools,看 Console 是否有 Cannot find module 'prettier' ——说明 VSCode 没找到项目内的 prettier,检查 node_modules 是否存在、是否在工作区根目录下
  • 右下角状态栏点击格式化器名称,确认当前激活的是 Prettier 而非 ESLintNone
  • 打开一个 .js 文件,按 Ctrl+Shift+PFormat Document With...,看列表里是否有 Prettier 选项;没有则插件未正确识别项目配置

真实场景中,最常被忽略的是:项目用了 pnpm/yarn 2+,但 VSCode 启动时没走正确的 shell 环境,导致找不到本地 node_modules/.bin 下的可执行文件。


# vue  # javascript  # java  # vscode  # js  # json  # node  # typescript  # npm  # 作用域  # yarn  # format  #  


相关栏目: 【 网站优化151355 】 【 网络推广146373 】 【 网络技术251813 】 【 AI营销90571


相关推荐: Laravel与Inertia.js怎么结合_使用Laravel和Inertia构建现代单页应用  网站制作报价单模板图片,小松挖机官方网站报价?  如何为不同团队 ID 动态生成多个非值班状态按钮  微信小程序 wx.uploadFile无法上传解决办法  jQuery validate插件功能与用法详解  如何快速生成凡客建站的专业级图册?  php 三元运算符实例详细介绍  瓜子二手车官方网站在线入口 瓜子二手车网页版官网通道入口  免费网站制作appp,免费制作app哪个平台好?  Laravel如何监控和管理失败的队列任务_Laravel失败任务处理与监控  Claude怎样写约束型提示词_Claude约束提示词写法【教程】  如何实现建站之星域名转发设置?  Android仿QQ列表左滑删除操作  简单实现jsp分页  Laravel怎么自定义错误页面_Laravel修改404和500页面模板  Laravel如何实现多级无限分类_Laravel递归模型关联与树状数据输出【方法】  如何用狗爹虚拟主机快速搭建网站?  网站制作软件有哪些,制图软件有哪些?  如何续费美橙建站之星域名及服务?  Laravel如何实现多对多模型关联?(Eloquent教程)  如何在宝塔面板创建新站点?  大学网站设计制作软件有哪些,如何将网站制作成自己app?  胶州企业网站制作公司,青岛石头网络科技有限公司怎么样?  Laravel如何与Docker(Sail)协同开发?(环境搭建教程)  Python函数文档自动校验_规范解析【教程】  Laravel如何自定义错误页面(404, 500)?(代码示例)  如何在Windows 2008云服务器安全搭建网站?  bootstrap日历插件datetimepicker使用方法  如何挑选优质建站一级代理提升网站排名?  如何快速建站并高效导出源代码?  Laravel如何处理和验证JSON类型的数据库字段  Laravel表单请求验证类怎么用_Laravel Form Request分离验证逻辑教程  Python自然语言搜索引擎项目教程_倒排索引查询优化案例  详解ASP.NET 生成二维码实例(采用ThoughtWorks.QRCode和QrCode.Net两种方式)  Laravel如何实现用户注册和登录?(Auth脚手架指南)  香港服务器建站指南:免备案优势与SEO优化技巧全解析  🚀拖拽式CMS建站能否实现高效与个性化并存?  如何获取免费开源的自助建站系统源码?  海南网站制作公司有哪些,海口网是哪家的?  高防服务器租用首荐平台,企业级优惠套餐快速部署  网站制作价目表怎么做,珍爱网婚介费用多少?  Laravel如何处理JSON字段的查询和更新_Laravel JSON列操作与查询技巧  php嵌入式断网后怎么恢复_php检测网络重连并恢复硬件控制【操作】  Laravel如何记录日志_Laravel Logging系统配置与自定义日志通道  软银砸40亿美元收购DigitalBridge 强化AI资料中心布局  JavaScript 输出显示内容(document.write、alert、innerHTML、console.log)  Laravel Facade的原理是什么_深入理解Laravel门面及其工作机制  教你用AI将一段旋律扩展成一首完整的曲子  HTML透明颜色代码怎么让下拉菜单透明_下拉菜单透明背景指南【技巧】  家族网站制作贴纸教程视频,用豆子做粘帖画怎么制作?