VSCode 配合 Prettier 实现保存即运行的自动化格式校验

梦敏酱_2281

梦敏酱_2281

2026-06-19

479人浏览

原创

必须同时满足三项硬性条件:editor.formatonsave为true、editor.defaultformatter精确设为"esbenp.prettier-vscode"、对应语言(如[javascript])单独绑定该格式化器,缺一即导致保存时不触发prettier。

vscode 配合 prettier 实现保存即运行的自动化格式校验

editor.formatOnSave 必须为 true,且 editor.defaultFormatter 必须设为 "esbenp.prettier-vscode" —— 否则保存时根本不会调用 Prettier,所谓“自动化”就是空谈。

为什么保存后代码毫无反应?三个硬性条件缺一不可

VSCode 不会主动把 Prettier 当成格式化工具,哪怕插件已装、配置文件已写,只要以下任意一项不满足,Ctrl+S 就等于没按:

  • editor.formatOnSave 在当前作用域(用户设置 / 工作区 .vscode/settings.json)中必须显式设为 true
  • editor.defaultFormatter 必须精确设为 "esbenp.prettier-vscode"(注意短横线和大小写,填 prettier 或 Prettier 都无效)
  • 对应语言必须有绑定:比如打开一个 .ts 文件,右下角状态栏显示的不是 Prettier,而是 ESLint 或空白,说明 "[typescript]" 块里没配 editor.defaultFormatter

最稳妥的做法是直接在项目根目录的 .vscode/settings.json 里写死:

{
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "[javascript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode",
    "editor.formatOnSave": true
  },
  "[typescript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode",
    "editor.formatOnSave": true
  },
  "[vue]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode",
    "editor.formatOnSave": true
  }
}

.prettierrc.json 不生效?路径和语法比内容还关键

VSCode 的 Prettier 插件只认项目根目录(即你执行 code . 打开的那个文件夹)下的配置文件,且只支持有限几种命名和格式:

  • 接受的文件名:.prettierrc.json(推荐)、.prettierrc、prettier.config.js(仅支持 module.exports = {},export default 在 ESM 项目中会静默失败)
  • 不允许 JSON 注释、末尾逗号、BOM 字符;.prettierrc.json 写错一个逗号,Prettier 就直接跳过,回退到默认规则(semi: true, tabWidth: 2)
  • 不读取 package.json 里的 prettier 字段 —— 这是 CLI 行为,VSCode 插件不认

一个最小可用示例:

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载
{"semi": false,"singleQuote": true,"tabWidth": 2,"printWidth": 80,"trailingComma": "es5"}

和 ESLint 一起用时,格式越修越乱?冲突点就在规则重叠

ESLint 自带的 quotes、semi、comma-dangle 等规则,和 Prettier 功能完全重复。两者同时启用自动修复,就会出现“保存一次,分号消失;再保存一次,分号又回来”的循环。

  • 必须安装 eslint-config-prettier:npm install --save-dev eslint-config-prettier
  • 在 .eslintrc 的 extends 数组里,把它放在**最后一位**:["eslint:recommended", "prettier"]
  • 关掉 ESLint 的格式化开关:"eslint.codeAction.onSave.fix": false(或删掉这一项),让 ESLint 只做质量检查,不动代码格式

如果用了 eslint-plugin-prettier,还需确认它已启用并配置了 "prettier/prettier": "error" 规则,否则 ESLint 不会校验 Prettier 格式是否合规。

TypeScript 或 Vue 文件不格式化?语言标识没对上

VSCode 对文件类型的识别有时很微妙:.ts 文件可能被识别为 typescriptreact(尤其在 Next.js 或 Vite + React 项目中),而你的配置只绑定了 [typescript],结果 <script setup lang="ts"></script> 里的代码就漏掉了。

  • 看右下角状态栏的语言模式名称,不是图标,是文字(比如显示 TypeScript React 而非 TypeScript)
  • 如果是 TypeScript React,就得加一条:"[typescriptreact]": {"editor.defaultFormatter": "esbenp.prettier-vscode"}
  • Vue 单文件组件需要单独声明 [vue] 块,否则 <script></script> 和 <template></template> 都不会被格式化
  • 若用 Astro、Svelte 等框架,同理需查清 VSCode 识别出的实际语言 ID,再补对应块

真正麻烦的不是配多少项,而是 VSCode 语言 ID 和你直觉认为的不一样 —— 多数问题都卡在这一步。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vscode

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1255

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

2652

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1909

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1707

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2587

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1798

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1242

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1116

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

454

5

热门下载

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

精品课程

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