讲师中心 微信公众号
AI工具推荐 视频效率加速

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

小磊小哥_9411

小磊小哥_9411

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

|

797人浏览过

|

来源于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 formatter 和 eslint(由 dirk baeumer 维护)。确保两者都启用,并**禁用 vscode 内置的 javascript/typescript 格式化器**(在设置中搜索 javascript.format.enable 和 typescript.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 中写入以下内容(**不建议全局设置**,避免跨项目干扰):

GitHub Actions Runtime Regression Audit
GitHub Actions Runtime Regression Audit

对比基线与当前 GitHub Actions 运行导出,在 CI 成本和交付周期激增前及时发现工作流或作业运行时性能退化。

下载
{
  "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 是推荐设置,不是强制锁死,所以仍需靠 prettier 和 eslint CLI 在 CI 中兜底校验。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

相关专题

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

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

252

2026.02.13

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

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

480

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

311

2026.03.13

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

246

2026.06.03

TypeScript Node.js 全栈工程化与Monorepo架构实践
TypeScript Node.js 全栈工程化与Monorepo架构实践

本专题围绕 TypeScript 在 Node.js 全栈开发中的工程化实践展开,系统讲解 Monorepo 架构设计、包管理策略、模块复用机制以及服务端与前端统一类型系统的构建方法。通过真实项目案例,帮助开发者提升大型全栈项目的可维护性与协作效率。

478

2026.06.16

json数据格式
json数据格式

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

1975

2023.08.07

json是什么
json是什么

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

2702

2023.08.23

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

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

936

2023.10.13

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

80

2026.09.23

热门下载

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

精品课程

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

共58课时 | 12万人学习

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

共12课时 | 1.4万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn