如何在 VSCode 中配置 Prettier 插件

1,648 阅读2分钟

背景

经常在项目中使用 Prettier 作为代码格式化的工具,但是总感觉每次遇到新项目时,配置的过程有点乱,尤其是遇到项目中本身就拥有 Prettier 的配置文件,比如常见的 prettier.config.js.prettierrc,以及其他 Prettier 配置文件,要各种配置,才能使其生效,因此把配置的核心步骤总结下来,方便以后使用。

目录

  • 准备工作
  • 安装 Prettier 插件
  • 配置 VSCode 默认的 Formatter 工具
  • 配置 VSCode 文件保存时自动格式化
  • 测试效果

准备工作

确保你已经在本地安装了 VS Code 编辑器,如果没有安装,可以通过官网安装,Visual Studio Code

这里简单说明下在我们配置 VS Code 时,经常会遇到的 User 和 Workspace 配置,官网说明:User and Workspace Settings。请根据自己的实际需要做特殊设置。

  • User settings:全局应用你打开的任何 VS Code 设置。
  • Workspace settings:存储在工作区中的设置,仅在工作区打开时应用。

安装 Prettier 插件

打开 VS Code 的左侧 EXTENSIONS(插件) ,输入 Prettier

图2-1.png

配置 VSCode 默认的 Formatter 工具

  • 打开 VSCode 左下角的 Setting 选项

图3-1.png

  • 输入 Formatter ,点击 Text Editor ,设置 Editor: Default Formatter 为 Prettier

图3-2.png

配置 VSCode 文件保存时自动格式化

在实际写代码时,我们期望每次保存代码时,自动触发格式化。此时将 Editor:Format On Save 选中即可。

图4-1.png

测试效果

  • 手动格式化,可以在需要格式化的文件中右键,选择 Format Document,即可看到效果。

图5-1.gif

  • 自动格式化,每当我们保存时,代码将自动格式化。

图5-2.gif

杂谈

  • 需要注意,如果存在任何本地配置文件(即 .prettierrc),则不会使用 VS Code 设置。
  • 如果想指定某个配置文件,建议使用 Workspace Setting ,设置 Prettier:Config Path,但是,请注意,如果设置了此值,将始终使用此值,并且将忽略本地配置文件。如果没有生效,可以尝试直接输入对应文件的绝对路径。

图6.png

参考文档

浏览知识共享许可协议

知识共享许可协议
本作品采用知识共享署名-相同方式共享 4.0 国际许可协议进行许可。