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 内联字段。

TeemIp - IPAM and DDI solution
TeemIp - IPAM and DDI solution

TeemIp是一个免费、开源、基于WEB的IP地址管理(IPAM)工具,提供全面的IP管理功能。它允许您管理IPv4、IPv6和DNS空间:跟踪用户请求,发现和分配IP,管理您的IP计划、子网空间、区域和DNS记录,符合最佳的DDI实践。同时,TeemIp的配置管理数据库(CMDB)允许您管理您的IT库存并将您的配置项(CIs)与它们使用的IP关联起来。项目源代码位于https://github.com/TeemIP

下载

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” 且无报错提示。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

552

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

374

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

730

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

475

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

394

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

990

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

656

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

551

2023.09.20

c++主流开发框架汇总
c++主流开发框架汇总

本专题整合了c++开发框架推荐,阅读专题下面的文章了解更多详细内容。

25

2026.01.09

热门下载

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

精品课程

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

共58课时 | 3.5万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 2.1万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.8万人学习

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

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