VSCode的Prettier – Code formatter:代码格式化的黄金标准

9次阅读

Prettier在vscode中稳定格式化的关键步骤包括:一、安装并启用官方Prettier扩展;二、在settings.json中禁用JS/TS内置格式器并设Prettier为默认格式化工具;三、项目根目录配置.prettierrc文件;四、开启保存时自动格式化;五、通过eslint-config-prettier解决与ESLint的规则冲突。

VSCode的Prettier – Code formatter:代码格式化的黄金标准

如果您在使用 VSCode 编辑代码时发现格式混乱、缩进不一致或括号风格杂乱,很可能是 Prettier 扩展未正确配置或未生效。以下是让 Prettier 在 VSCode 中稳定执行代码格式化的多种方法:

本文运行环境:MacBook Air,macos Sequoia。

一、安装并启用 Prettier 扩展

Prettier 必须作为 VSCode 扩展安装才能参与编辑器的格式化流程,仅靠全局 npm 安装无法触发编辑器内自动格式化。

1、打开 VSCode,点击左侧活动栏的扩展图标(或按 Cmd+Shift+X)。

2、在搜索框中输入 Prettier – Code formatter,确保作者为 Esben Petersen

3、点击“安装”按钮,安装完成后点击“重新加载”使扩展生效。

二、设置默认格式化工具为 Prettier

VSCode 默认可能使用内置格式化器或其他已安装扩展,必须显式指定 Prettier 为当前工作区或全局的默认 javaScript/typescript/markdown 等语言的格式化程序。

1、按下 Cmd+, 打开设置界面,在右上角点击“打开设置(json)”图标。

2、在 settings.json 文件中添加以下配置项:

3、对于 javascript 和 TypeScript:javascript.format.enable”: false, “typescript.format.enable”: false

4、指定默认格式化器:“editor.defaultFormatter”: “esbenp.prettier-vscode

三、配置 Prettier 配置文件

仅依赖 VSCode 设置无法覆盖项目级格式偏好,Prettier 会优先读取项目根目录下的配置文件(如 .prettierrc 或 prettier.config.js),这是实现团队统一格式的关键环节。

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

2、写入标准 JSON 格式配置,例如:{“semi”: true, “singleQuote”: true, “tabWidth”: 2}

3、保存后重启 VSCode 窗口,或执行命令面板(Cmd+Shift+P)中的 Developer: Reload Window

四、启用保存时自动格式化

手动触发格式化易被忽略,开启保存即格式化可确保每次提交前代码均符合预设规范,避免格式污染。

1、打开设置(Cmd+,),搜索 format on save

2、勾选 Editor: Format On Save 选项。

3、为防止与其他格式化器冲突,同时设置:“editor.formatOnSaveMode”: “modifications”

五、解决 Prettier 与 ESLint 冲突

当项目同时使用 ESLint 进行代码检查时,其修复功能(eslint –fix)可能与 Prettier 的格式规则反向冲突,导致保存后反复修改同一行。

1、在项目中安装 eslint-config-prettier 并将其加入 ESLint 配置的 extends 数组末尾。

2、确保不启用 ESLint 的格式类规则,例如 “no-mixed-spaces-and-tabs”“indent”

3、在 VSCode 设置中禁用 ESLint 的自动修复:“eslint.autoFixOnSave”: false,改由 Prettier 全权负责格式化。

text=ZqhQzanResources