0

0

VSCode的Prettier Code Formatter配置最佳实践

P粉986688829

P粉986688829

发布时间:2026-01-10 18:18:03

|

717人浏览过

|

来源于php中文网

原创

Prettier 配置需五步实现跨环境一致:一、设为默认格式化器;二、禁用冲突扩展;三、用 prettier.config.js 统一规则;四、启用保存时格式化并排除不兼容文件;五、按语言配置解析器与规则。

如果您在使用 vscode 编辑代码时发现格式化结果不符合团队规范或个人预期,则可能是 prettier 的配置未正确对齐项目需求。以下是实现稳定、可复用、跨环境一致的 prettier 配置的关键步骤:

本文运行环境:MacBook Pro,macOS Sequoia。

一、启用 Prettier 作为默认格式化工具

该设置确保 VSCode 在执行格式化操作(如快捷键 Cmd+Shift+P → “Format Document”)时,优先调用 Prettier 而非内置或其他扩展的格式化器。

1、打开 VSCode 设置(Cmd+,),切换至“Workspace”选项卡。

2、搜索 setting.json 并点击“在 settings.json 中编辑”链接。

3、在 JSON 文件中添加以下键值对:
"editor.defaultFormatter": "esbenp.prettier-vscode"

4、确认该配置未被用户级设置覆盖,且 workspace 设置优先级高于全局设置。

二、禁用冲突的自动格式化扩展

部分扩展(如 ESLint、TypeScript 自带格式化器)可能在保存时触发自身格式逻辑,与 Prettier 输出产生冲突,导致代码反复重排或报错。

1、在 VSCode 左侧活动栏点击扩展图标(方块拼图)。

2、搜索并定位到 ESLint 扩展。

3、点击其右下角齿轮图标,选择“Extension Settings”。

4、取消勾选 "ESLint: Auto Fix On Save" 选项。

5、对其他可能启用保存时格式化的扩展(如 “TypeScript and JavaScript Language Features”)执行相同检查。

三、配置 prettier.config.js 统一项目规则

将 Prettier 规则以 JavaScript 文件形式置于项目根目录,可确保所有开发者及 CI 环境读取完全一致的配置,避免依赖 VSCode UI 设置或 package.json 内联字段。

Chromox
Chromox

Chromox是一款领先的AI在线生成平台,专为喜欢AI生成技术的爱好者制作的多种图像、视频生成方式的内容型工具平台。

下载

1、在项目根目录创建文件:prettier.config.js

2、写入标准导出对象,例如:
module.exports = { semi: true, singleQuote: true, tabWidth: 2, trailingComma: 'es5' };

3、确保该文件未被 .gitignore 排除。

4、重启 VSCode 或重新加载窗口(Cmd+Shift+P → “Developer: Reload Window”)使配置生效。

四、设置保存时自动格式化并排除特定文件类型

启用保存即格式化可减少手动操作,但需排除不兼容 Prettier 的文件(如 JSON Schema、YAML 配置等),防止格式破坏结构或语法。

1、在 workspace settings.json 中添加:
"editor.formatOnSave": true

2、继续添加:
"editor.formatOnSaveMode": "file"

3、添加排除规则:
"[jsonc]": { "editor.formatOnSave": false }, "[yaml]": { "editor.formatOnSave": false }

五、为多语言项目指定语言专属配置

Prettier 对不同语言支持程度不同,部分语言需显式声明解析器或禁用特定规则,否则可能报错或忽略格式化请求。

1、在 prettier.config.js 中使用 overrides 字段:
overrides: [{ files: '*.ts', options: { parser: 'typescript' } }, { files: '*.md', options: { proseWrap: 'always' } }]

2、确保项目已安装对应解析器包:npm install --save-dev @prettier/plugin-typescript

3、验证 TypeScript 文件能否被正确识别:打开任意 .ts 文件,按下 Cmd+Shift+P → 输入 “Format Document With...”,确认列表中显示 “Prettier” 且无报错提示。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

47

2026.02.13

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

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

194

2026.02.25

json数据格式
json数据格式

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

457

2023.08.07

json是什么
json是什么

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

547

2023.08.23

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

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

335

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方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

462

2024.06.27

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

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

精品课程

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

共58课时 | 6万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 3.4万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.6万人学习

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

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