如何在VS代码中使用Prettier

619 阅读2分钟

一个关于如何在VS Code(Visual Studio Code)中安装和使用Prettier的简单步骤教程。Prettier是一个有主见的代码格式化器,它确保了一个统一的代码格式。它可以通过从VS Code Marketplace中安装来使用VS Code。一旦你在VS Code中集成了它,你就可以在保存文件或提交文件到版本控制系统(如Git)时配置Prettier来格式化你的文件。这样,你永远不需要担心你的源代码的格式问题,因为Prettier会照顾到这一点。它不仅适用于个人项目,而且在与一个开发团队合作时也能简化项目。

我们将首先安装VS Code的Prettier扩展。一旦你安装了它,你可以用CTRL + CMD + P (MacOS)或CTRL + Shift + P (Windows)来手动格式化一个文件或选定的代码。

如果你不想每次都用给定的快捷方式手动格式化你的文件,你也可以在保存时格式化它。因此,你需要打开你的VS Code用户的设置/偏好为JSON,并输入以下配置。

// enable globally (here: format on save)
"editor.formatOnSave": true
// enable per-language (here: Prettier as formatter)
"[javascript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
}

之后,一旦你保存一个JavaScript文件,它就会自动格式化。现在你不需要再担心你的代码格式问题了,因为Prettier会处理好这个问题。Prettier带有一些选项,你也可以全局应用;我喜欢在我的个人项目中这样做。

"editor.formatOnSave": true
"prettier.singleQuote": true,
"prettier.printWidth": 70,
"[javascript]": {
  "editor.defaultFormatter": "esbenp.prettier-vscode"
},

在设置了这个配置后,Prettier会确保只使用单引号,并且行长被设置为给定的字符数。

然而,请注意,现在这适用于每个项目。如果你碰巧和一个团队一起工作,而这个项目没有使用Prettier,那么一旦你保存文件,你就会对每个文件进行格式化。如果没有和你的队友达成一致,这可能会引起麻烦。因此,我建议安装PrettierFormatting Toggle,它允许你在一个项目中全局地切换Prettier。

此外,如果你正在进行的项目使用一个本地的*.prettierrc*文件进行本地配置,它可以用来覆盖全局设置。这就是我在一个团队中与多个开发人员一起工作时推荐的项目。

{
  "singleQuote": false,
  "printWidth": 120,
}

就这样了。你在保存时对JavaScript文件进行格式化,同时能够为单个项目切换关闭Prettier。此外,你正在使用你个人的Prettier默认值,然而,当你和一个团队在一个项目上工作时,你也可以使用.prettierrc文件。就这样,你已经在Visual Studio Code中成功集成了Prettier。