介绍
代码格式化始终是一项挑战,但现代开发者工具可以自动维护团队代码库的一致性。本文将指导您如何在 Visual Studio Code(简称 VS Code)中设置 Prettier,使其自动格式化代码。.
为了演示,以下是您正在格式化的代码示例:
const name = "James";
const person ={first: name
}
console.log(person);
const sayHelloLinting = (fName) => {
console.log(`Hello linting, ${fName}`)
}
sayHelloLinting('James');如果您熟悉代码格式,您可能会注意到其中一些步骤是错误的:
- 单引号和双引号的组合。.
- Person 对象的第一个属性应该放在它自己的行上。.
- 函数内部的 Console 语句必须缩进。.
- 你可能喜欢也可能不喜欢箭头函数参数周围的可选括号。.
先决条件
- 下载并安装 Visual Studio Code。.
- 要在 Visual Studio Code 中使用 Prettier,您需要安装该插件。为此,请在 VS Code 插件面板中搜索“Prettier – 代码格式化程序”。如果您是第一次安装,您会看到“安装”按钮,而不是此处显示的“卸载”按钮:

步骤 1 – 使用“设置文档格式”命令
安装 Prettier 插件后,您现在可以用它来格式化代码。首先,我们来了解如何使用“格式化文档”命令。该命令可以使您的代码格式更加统一,包括格式化间距、自动换行和引号。.
要打开命令面板,您可以使用 COMMAND + SHIFT + P 在 macOS 上或 Ctrl + Shift + P 在Windows系统上使用。.
在命令面板中,搜索“格式”,然后 文档格式 选择。.
接下来,系统可能会要求您选择要使用的格式。为此,请单击“配置”按钮:
然后选择 Prettier – 代码格式化工具。.
您的代码现在已格式化,包含空格、自动换行和固定引号:
const name = "James";
const person = { first: name };
console.log(person);
const sayHelloLinting = (fName) => {
console.log(`Hello linting, ${fName}`);
};
sayHelloLinting("James");这也适用于 CSS 文件。您可以将缩进、括号、换行符和分号不一致的代码转换为格式正确的代码。例如:
body {color: red;
}
h1 {
color: purple;
font-size: 24px
}其格式如下:
body {
color: red;
}
h1 {
color: purple;
font-size: 24px;
}现在我们已经了解了这个命令,让我们看看如何让它自动运行。.
步骤 2 – 格式化保存中的代码
以前,你需要手动运行命令来格式化代码。为了实现自动化,你可以在 VS Code 中选择一项设置,使其在保存文件时自动格式化。这样也能确保未格式化的代码不会被提交到版本控制系统中。.
要更改此设置, COMMAND + 在 macOS 上或 Ctrl + 在Windows系统中按下[按键]打开“设置”菜单。菜单打开后, 编辑器:保存时格式化 找到并确保该选项已勾选:
设置完成后,您可以像往常一样编写代码,保存文件时代码会自动格式化。.
步骤 3 – 更改 Prettier 配置设置
Prettier 默认会为你完成很多工作,但你也可以自定义设置。.
打开“设置”菜单。然后,搜索“Prettier”。这将显示所有可以更改的设置:
以下是一些最常见的设置:
- 单引号 – 选择单引号或双引号。.
- 分号 – 选择行尾是否要加分号。.
- 制表符宽度 – 指定要插入的制表符的空格数。.
使用 VS Code 内置设置菜单的缺点是,它不能保证团队中开发人员之间的一致性。.
步骤 4 – 创建更友好的配置文件
如果您更改了 VS Code 中的设置,其他人的计算机上可能拥有完全不同的配置。您可以通过为项目创建配置文件来确保团队内部格式的一致性。.
一个名为 prettierrc.extension 使用以下扩展程序之一进行创建:
ymlyamlJSONjs托姆
以下是一个使用 JSON 的简单配置文件示例:
{
"trailingComma": "es5",
"tabWidth": 4,
"semi": false,
"singleQuote": true
}有关配置文件的更多详细信息,请参阅更精美的文档。创建配置文件并将其部署到项目中后,您可以确保团队中的每个人都遵循相同的格式规则。.
介绍
保持代码风格的一致性是一种良好的实践。这在与多个协作者共同开发项目时尤为重要。达成一致的设置有助于提高代码的可读性和易懂性。这样,我们就可以将更多的时间用于解决更具挑战性的技术问题,而不是纠结于诸如代码缩进之类的已解决的问题。.















