0

0

VSCode的Prettier - Code formatter配置最佳实践

P粉986688829

P粉986688829

发布时间:2026-01-11 19:20:37

|

819人浏览过

|

来源于php中文网

原创

VSCode中Prettier需配置为默认格式化工具、项目级.prettierrc、EditorConfig统一编辑行为、.prettierignore排除路径,并启用按语言保存自动格式化。

vscode的prettier - code formatter配置最佳实践

如果您在使用 VSCode 编辑代码时发现格式化结果不符合团队规范或个人预期,则可能是 Prettier 的配置未正确对齐项目需求或编辑器设置。以下是实现 Prettier 高度可控、一致且可复用的配置方法:

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

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

此步骤确保 VSCode 在执行格式化操作(如快捷键 Cmd+Shift+I)时调用 Prettier 而非内置 JavaScript 或 TypeScript 格式化器,避免规则冲突与行为不一致。

1、打开 VSCode 设置(Cmd+,),切换至“工作区”标签页。

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

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

4、确认已禁用其他格式化扩展的自动格式化功能,例如禁用 TypeScript 自动格式化:
"typescript.format.enable": false

二、配置项目级 .prettierrc 文件

通过本地配置文件定义格式规则,使 Prettier 行为与团队约定完全一致,并优先于用户级设置,保障跨编辑器与 CI 环境的一致性。

1、在项目根目录创建名为 .prettierrc 的文件(支持 JSON、YAML 或 JS 格式)。

2、写入标准兼容性配置示例:
{ "semi": true, "singleQuote": true, "tabWidth": 2, "trailingComma": "es5", "printWidth": 80 }

3、保存后重启 VSCode 窗口,验证修改是否生效:打开任意 .js 文件并触发格式化。

三、集成 EditorConfig 统一基础编辑行为

EditorConfig 在 Prettier 执行前统一缩进、换行符等底层编辑属性,防止因操作系统或编辑器差异导致意外格式偏移。

PaperFake
PaperFake

AI写论文

下载

1、在项目根目录创建 .editorconfig 文件。

2、填入以下内容:
root = true\n[*]\nindent_style = space\nindent_size = 2\nend_of_line = lf\ncharset = utf-8\ntrim_trailing_whitespace = true\ninsert_final_newline = true

3、确保已安装 VSCode 的 EditorConfig for VS Code 扩展,并确认其状态栏图标显示为激活状态。

四、配置 .prettierignore 排除无关路径

避免 Prettier 对构建产物、依赖包或特定配置文件进行无意义格式化,提升性能并防止误改生成文件。

1、在项目根目录新建 .prettierignore 文件。

2、逐行写入需跳过格式化的路径模式,例如:
node_modules/\nbuild/\ndist/\n*.min.js\ncoverage/

3、验证忽略逻辑:在 dist/ 目录下新建 test.js 并尝试格式化,确认无任何变更发生。

五、绑定保存时自动格式化并限制作用域

启用保存即格式化可减少手动操作,但需限定仅对受支持语言生效,避免对 Markdown、JSON 等非代码文件误触发。

1、在工作区 settings.json 中添加:
"editor.formatOnSave": true

2、为 JavaScript 和 TypeScript 单独启用格式化:
"[javascript]": { "editor.formatOnSave": true }, "[typescript]": { "editor.formatOnSave": true }

3、禁用对 JSON 文件的保存格式化(因其结构敏感):
"[json]": { "editor.formatOnSave": false }

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

49

2026.02.13

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

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

196

2026.02.25

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

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

36

2026.03.13

json数据格式
json数据格式

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

457

2023.08.07

json是什么
json是什么

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

549

2023.08.23

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

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

337

2023.10.13

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

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

82

2025.09.10

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

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

888

2023.07.31

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

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

26

2026.03.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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号