0

0

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

狼影

狼影

发布时间:2026-01-22 11:56:03

|

288人浏览过

|

来源于php中文网

原创

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

vscode中如何配置eslint和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 必须放在 extends 数组最后;若手动写一堆 quotes: 'off' 类规则,容易漏、难维护。

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

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

Kive
Kive

一站式AI图像生成和管理平台

下载
  • .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 下的可执行文件。

相关专题

更多
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数据方法,阅读专题下面的文章了解更多详细内容。

75

2025.09.10

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

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

659

2023.07.31

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

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

431

2024.06.27

堆和栈的区别
堆和栈的区别

堆和栈的区别:1、内存分配方式不同;2、大小不同;3、数据访问方式不同;4、数据的生命周期。本专题为大家提供堆和栈的区别的相关的文章、下载、课程内容,供大家免费下载体验。

393

2023.07.18

堆和栈区别
堆和栈区别

堆(Heap)和栈(Stack)是计算机中两种常见的内存分配机制。它们在内存管理的方式、分配方式以及使用场景上有很大的区别。本文将详细介绍堆和栈的特点、区别以及各自的使用场景。php中文网给大家带来了相关的教程以及文章欢迎大家前来学习阅读。

573

2023.08.10

Golang 性能分析与pprof调优实战
Golang 性能分析与pprof调优实战

本专题系统讲解 Golang 应用的性能分析与调优方法,重点覆盖 pprof 的使用方式,包括 CPU、内存、阻塞与 goroutine 分析,火焰图解读,常见性能瓶颈定位思路,以及在真实项目中进行针对性优化的实践技巧。通过案例讲解,帮助开发者掌握 用数据驱动的方式持续提升 Go 程序性能与稳定性。

9

2026.01.22

热门下载

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

精品课程

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

共42课时 | 6.9万人学习

Vue3.x 工具篇--十天技能课堂
Vue3.x 工具篇--十天技能课堂

共26课时 | 1.4万人学习

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

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