VSCode的Prettier Code Formatter配置最佳实践

11次阅读

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

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

text=ZqhQzanResources