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 中写入以下内容(**不建议全局设置**,避免跨项目干扰):

Stable Diffusion Online
Stable Diffusion Online

基于Stable Diffusion搭建的AI绘图工具

下载
{
  "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 中兜底校验。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

45

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

189

2026.02.25

json数据格式
json数据格式

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

454

2023.08.07

json是什么
json是什么

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

546

2023.08.23

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

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

331

2023.10.13

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

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

82

2025.09.10

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

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

887

2023.07.31

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

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

459

2024.06.27

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

59

2026.03.06

热门下载

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

精品课程

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

共58课时 | 5.9万人学习

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

共12课时 | 1万人学习

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

共12课时 | 1.1万人学习

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

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