0

0

怎么为VSCode设置代码格式化规则?_Prettier与ESLint整合之道【教程】

幻影之瞳

幻影之瞳

发布时间:2026-01-20 22:05:03

|

777人浏览过

|

来源于php中文网

原创

需安装Prettier与ESLint插件、禁用VSCode内置格式器、配置.prettierrc和.eslintrc.js(eslint-config-prettier放extends末尾)、在.vscode/settings.json中启用formatOnSave和source.fixAll.eslint。

安装 Prettier 和 ESLint 插件并配置工作区

打开 vscode,进入扩展商店(ctrl+shift+x),搜索并安装官方插件:prettier - code formattereslint(由 dirk baeumer 维护)。确保两者都启用,并**禁用 vscode 内置的 javascript/typescript 格式化器**(在设置中搜索 javascript.format.enabletypescript.format.enable,设为 false)。

在项目根目录创建 .prettierrc(或 .prettierrc.json),定义基础格式规则:

{
  "semi": true,
  "singleQuote": true,
  "tabWidth": 2,
  "trailingComma": "es5",
  "printWidth": 80,
  "arrowParens": "avoid"
}

同时确保项目已安装 Prettier 与 ESLint 的本地依赖(推荐使用 --save-dev):

npm install --save-dev prettier eslint eslint-config-prettier eslint-plugin-prettier

让 ESLint 识别并尊重 Prettier 规则

关键在于避免规则冲突。在 .eslintrc.js(或 .eslintrc.json)中,将 eslint-config-prettier 放在 extends 数组**末尾**,它会关闭所有与 Prettier 冲突的 ESLint 格式类规则;再将 plugin:prettier/recommended 加入 extends,它等价于 plugin:prettier/recommended + eslint-config-prettier,但更明确:

module.exports = {
  extends: [
    "eslint:recommended",
    "plugin:react/recommended",
    "plugin:prettier/recommended" // ← 必须放在最后
  ],
  plugins: ["react", "prettier"],
  rules: {
    "prettier/prettier": "error"
  }
};

注意:plugin:prettier/recommended 本身已包含 eslint-config-prettier,因此无需重复引入。若你手动启用了某条格式规则(如 quotes),它会被 eslint-config-prettier 覆盖——这是预期行为,不必担心。

配置 VSCode 自动格式化与保存时修复

在项目根目录的 .vscode/settings.json 中写入以下内容(**不建议全局设置**,避免跨项目干扰):

Tellers AI
Tellers AI

Tellers是一款自动视频编辑工具,可以将文本、文章或故事转换为视频。

下载
{
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.formatOnSave": true,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },
  "editor.formatOnPaste": false,
  "editor.formatOnType": false,
  "[javascript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[typescript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[javascriptreact]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[typescriptreact]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  }
}

这样,保存文件时会先由 ESLint 自动修复可修复问题(如 no-unused-vars),再由 Prettier 统一格式化代码。若发现格式未生效,请检查是否打开了“仅活动编辑器”格式化开关(右下角状态栏 → 点击「Format Document」→ 选「Configure Default Formatter」→ 确保选中 Prettier)。

常见陷阱:为什么保存后没自动修复?

最常被忽略的是:VSCode 的 editor.codeActionsOnSave 默认**不启用 ESLint 修复**,必须显式开启。若只开了 formatOnSave,Prettier 只负责缩进/引号/分号等格式,而 ESLint 的逻辑类报错(如变量未使用、缺少 return)不会自动修复——除非你配了 "source.fixAll.eslint": true

另一个典型问题是:项目未正确安装 eslint-plugin-prettier 或未在 plugins 中声明 prettier,导致 "prettier/prettier" 规则不生效,VSCode 控制台可能报错 Definition for rule 'prettier/prettier' was not found。此时请检查 node_modules 是否存在该包,并确认 ESLint 配置中 plugins 字段包含 "prettier"

最后提醒:团队协作时,务必把 .prettierrc.eslintrc.*.vscode/settings.json 提交到 Git,否则成员间格式行为不一致。VSCode 的 settings.json 是推荐设置,不是强制锁死,所以仍需靠 prettiereslint CLI 在 CI 中兜底校验。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

556

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

374

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

734

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

477

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

434

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

1011

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

658

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

553

2023.09.20

Java JVM 原理与性能调优实战
Java JVM 原理与性能调优实战

本专题系统讲解 Java 虚拟机(JVM)的核心工作原理与性能调优方法,包括 JVM 内存结构、对象创建与回收流程、垃圾回收器(Serial、CMS、G1、ZGC)对比分析、常见内存泄漏与性能瓶颈排查,以及 JVM 参数调优与监控工具(jstat、jmap、jvisualvm)的实战使用。通过真实案例,帮助学习者掌握 Java 应用在生产环境中的性能分析与优化能力。

19

2026.01.20

热门下载

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

精品课程

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

共58课时 | 3.9万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.0万人学习

React核心原理新老生命周期精讲
React核心原理新老生命周期精讲

共12课时 | 1万人学习

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

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