WebStorm 2025.2 Help

Prettier

Prettier 是一款用于格式化多种语言文件的工具,例如 TypeScript、JavaScript、CSS、HTML、JSON 等。 借助 WebStorm,您可以使用 使用 Prettier 重新格式化 操作对选定的代码片段、整个文件或目录进行格式化。 一旦将 Prettier 安装为项目中或计算机中的依赖项,WebStorm 即会添加此操作。

您可以配置 Prettier 以便在所选文件发生更改并自动或手动保存更改时重新格式化该文件,详见 保存时自动运行 Prettier

此外,Prettier 也可以 设置为默认格式化程序 ,用于特定文件。 每次使用 Ctrl+Alt+L 重新格式化代码时,它都将针对这些文件运行。

如需了解详情,请参阅 使用 Prettier 重新格式化代码

开始之前

  1. 请确保您的计算机上已安装 Node.js

  2. 请确保项目中已配置本地 Node.js 解释器:打开 设置 对话框(Ctrl+Alt+S ),转到 语言和框架 | Node.jsNode 解释器(I) 字段显示默认的项目 Node.js 解释器。 相关内容请参阅 配置本地 Node.js 解释器

  3. 请确保在设置中启用了 Prettier 插件。 按 Ctrl+Alt+S 打开设置,然后选择 插件。 单击 已安装 选项卡。 在搜索字段中键入 Prettier。 有关插件的更多信息,请参阅 管理插件

安装 Prettier

  1. 打开嵌入的 终端Alt+F12)。

  2. 输入以下命令之一:

    • npm install --save-dev --save-exact prettier

    • npm install --global prettier

有关安装模式的详细信息,请参阅 Prettier 官方网站

在 WebStorm 中配置 Prettier

WebStorm 启用 Prettier,并在您 按上述说明安装后立即添加 使用 Prettier 重新格式化 操作。 要关闭 Prettier,请打开 设置 对话框(Ctrl+Alt+S ),转到 语言与框架 | JavaScript | Prettier ,然后选择 禁用 Prettier

配置文件的支持格式

WebStorm 可识别以下文件类型中的 Prettier 配置:

  • .prettierrc.json .prettierrc.yml .prettierrc.yaml .prettierrc.json5

  • .prettierrc.js prettier.config.js .prettierrc.mjs prettier.config.mjs .prettierrc.cjs prettier.config.cjs .prettierrc.toml

  • .prettierrc.ts prettier.config.ts .prettierrc.mts prettier.config.mts .prettierrc.cts prettier.config.cts

详细内容请参阅 Prettier 官方网站

自动 Prettier 配置

在该模式下,对于每个匹配 run-for-files 模式 的文件:

  • WebStorm 使用最靠近要重新格式化文件所在目录或其父目录中的 node_modules 文件夹中的 Prettier 包。

  • WebStorm 会自动检测最近的 配置文件 并应用其中的设置。

  • WebStorm 向上搜索 .prettierignore 文件,并使用找到的第一个文件中的设置(如果存在)。

使用 自动 Prettier 配置 后,Prettier 仅应用于相应 package.json 中声明了 Prettier 依赖项范围内的文件。 如需更改此行为,请选择 手动 Prettier 配置 并勾选 对 Prettier 依赖范围之外的文件应用 Prettier 复选框,详细信息请参阅 手动配置 Prettier

假设您的项目结构如下:

项目结构:Prettier 应用于 Prettier 依赖范围内的文件

该项目在项目根目录中包含一个 .prettierrc 配置文件。 此外还有四个 package.json 文件,其中一个位于项目根目录,其余在子项目中。 如您所见,Prettier 仅在来自 packages/package_c_with_prettier_dependency 子项目的 package.json 中声明为依赖项。 因此,仅 packages/package_c_with_prettier_dependency/src 中的文件将使用 Prettier 进行格式化。

如果在任何 package.json 中声明了 Prettier 依赖项,并且项目中至少包含一个 Prettier 配置文件,则在没有 .idea 文件夹的新项目中,默认启用 自动 Prettier 配置

因此,如果您的项目由多个具有不同 Prettier 配置的模块组成,则每个模块将使用其自身 Prettier 配置文件中的规则(如果找到该配置文件)。

如果由于某种原因未为 自动 Prettier 配置 默认启用,您可以自行启用。

启用自动 Prettier 配置

  1. 打开 设置 对话框(Ctrl+Alt+S ),转到 语言与框架 | JavaScript | Prettier ,然后选择 自动 Prettier 配置

    自动配置 Prettier
  2. 若要自动将 Prettier 应用于已保存的文件,请勾选 保存时运行 复选框。

  3. 对文件运行 字段中,指定在保存此类文件或调用 重新格式化代码 操作时将自动应用 Prettier 的文件模式。

    在默认模式下,Prettier 将应用于任意 JavaScript、TypeScript、JSX、TSX、HTML、Vue 或 Astro 文件。 若要重新格式化其他类型的文件或特定文件夹中的文件,请使用 glob patterns 来更新默认模式。

    • 例如,若要自动重构 CoffeeScript 文件,请将 coffee 添加到默认模式中,如下所示:

      **/*.{js,ts,jsx,tsx,cjs,cts,mjs,mts,vue,astro,coffee}
    • 如需格式化某个特定文件夹中的文件(包括其子文件夹),请将 **/* 替换为 <path to the folder>/**/*

      假设您有一个具有以下结构的项目:

      Prettier:自定义模式。 示例项目结构

      若要仅格式化 coffee 文件夹中的文件,请按如下方式更新模式:

      coffee/*.{js,ts,jsx,tsx,cjs,cts,mjs,mts,vue,astro,coffee}

      因此,文件 reformat.coffee 会被重新格式化,而 no_reformatting.coffee 不会。

    有关更多信息,请参阅 保存时自动运行 Prettier设置 Prettier 为默认格式化程序

手动 Prettier 配置

  1. 打开 设置 对话框(Ctrl+Alt+S ),转到 语言与框架 | JavaScript | Prettier ,然后选择 手动 Prettier 配置

  2. Prettier 包 列表中,选择要使用的 prettier 安装。 如果您遵循了标准安装流程,WebStorm 会自动定位 prettier 包并自动填写该字段。

    配置 Prettier:手动模式
  3. 将 Prettier 设置为默认格式化工具 ,请勾选 在“重新格式化代码”操作时运行 复选框。

  4. 若要自动将 Prettier 应用于已保存的文件,请勾选 保存时运行 复选框。

  5. 配置 Prettier 应用范围

配置 Prettier 的作用域

您可以指定文件名模式,以定义哪些文件将由 Prettier 自动处理。 您还可以通过将文件添加到 .prettierignore 文件中,从处理范围中排除某些文件。

默认情况下,Prettier 不仅应用于包含 prettier 包的模块,还应用于其他模块,这在 monorepo 中尤为有用。

  1. 设置 对话框(Ctrl+Alt+S )中,转到 语言与框架 | JavaScript | Prettier

  2. 对文件运行 字段中,指定在保存此类文件或调用 重新格式化代码 操作时将自动应用 Prettier 的文件模式。

    在默认模式下,Prettier 将应用于任意 JavaScript、TypeScript、JSX、TSX、HTML、Vue 或 Astro 文件。 若要重新格式化其他类型的文件或特定文件夹中的文件,请使用 glob patterns 更新默认模式。

    • 例如,若要自动重构 CoffeeScript 文件,请按如下方式将 coffee 添加到默认模式中:

      **/*.{js,ts,jsx,tsx,cjs,cts,mjs,mts,vue,astro,coffee}
    • 如需格式化某个特定文件夹中的文件(包括其子文件夹),请将 **/* 替换为 <path to the folder>/**/*

      假设您有一个结构如下的项目:

      Prettier:自定义模式。 示例项目结构

      仅格式化 coffee 文件夹内的文件,请按如下方式更新模式:

      coffee/*.{js,ts,jsx,tsx,cjs,cts,mjs,mts,vue,astro,coffee}

      因此,文件 reformat.coffee 被重新格式化,而 no_reformatting.coffee 不会。

    有关更多信息,请参阅 保存时自动运行 Prettier设置 Prettier 为默认格式化程序

  3. 指定要使用的 .prettierignore 文件

    对于匹配 上述指定模式 的每个文件,WebStorm 会默认向上搜索 .prettierignore 并使用找到的第一个配置文件。 每当选择 自动 Prettier 配置 时,始终应用此默认方式。

    使用 手动 Prettier 配置 时,默认情况下 .prettierignore 路径 字段还会显示 Detect the .prettierignore file automatically。 接受此建议,或单击 “浏览”按钮 并选择要使用的 .prettierignore

  4. 默认情况下,无论项目树中更高层的 node_modules 文件夹是否包含 prettier 包,Prettier 都会自动应用于每个匹配 上述指定模式 的文件。 这使您能够在所有子项目中使用 Prettier,而无需在每个子项目中安装 prettier 包。

    若要禁止处理没有 prettier 包的子项目中的文件,请选择 手动 Prettier 配置 并取消选中 对 Prettier 依赖范围之外的文件应用 Prettier 复选框。

使用 Prettier 重新格式化代码

  1. 在编辑器中,选择要重新格式化的代码片段。 要重新格式化文件或文件夹,请在 项目 工具窗口中进行选择 Alt+1

  2. 然后按 Ctrl+Alt+Shift+P ,或在上下文菜单中选择 使用 Prettier 重新格式化

您可以将 Prettier 配置为在每次文件更改并自动或手动保存时重新格式化特定文件,参见 保存时自动运行 Prettier

另外,Prettier 还可以 设置为特定文件的默认格式化程序。 每次使用 Ctrl+Alt+L 重新格式化代码时,它都会应用于这些文件。

此行为既可在 当前项目中启用,也可 对所有新项目启用。

保存时自动运行 Prettier

  1. 打开 设置 对话框(Ctrl+Alt+S ),进入 语言与框架 | JavaScript | Prettier ,然后选中 保存时运行 复选框。

  2. 对文件运行 字段中,指定定义每次保存时需要重新格式化的文件集合的模式。 您可以接受默认模式,也可以输入自定义模式。

    使用默认模式时,Prettier 会在更新并保存 JavaScript、TypeScript、JSX、TSX、HTML、Vue、Astro、 .ml 或 CSS 文件时自动处理这些文件。 要重新格式化其他类型的文件或特定文件夹中的文件,请使用 glob 模式 修改默认模式。

    • 例如,要自动重新格式化 sass .scss 文件,请按如下方式将 sass, scss 添加到默认模式中:

      **/*.{js,ts,jsx,tsx,cjs,cts,mjs,mts,vue,astro,ml,css,scss,sass}
    • 要重新格式化某个特定文件夹(含子文件夹)中的文件,请将 **/* 替换为 <path to the folder>/**/*

      假设您有一个具有以下结构的项目:

      Prettier:自定义模式。 示例项目结构

      若要仅自动应用 Prettier 于 src 文件夹中的文件,请按以下方式修改模式:

      src/*.{js,ts,jsx,tsx,cjs,cts,mjs,mts,vue,astro,ml,css}

      结果是,文件 dog.ts 将在保存时被重新格式化,而 animal.ts 将保持不变。

将 Prettier 设置为默认格式化程序

  1. 打开 设置 对话框(Ctrl+Alt+S ),进入 语言与框架 | JavaScript | Prettier

  2. 选择 手动 Prettier 配置 ,然后选中 在“重新格式化代码”操作时运行 复选框。 详细了解 Prettier 配置,请参见 选择如何检测 Prettier 包和配置文件

  3. 对文件运行 字段中,指定始终使用 Prettier 重新格式化的文件集合模式。 接受默认模式,或按 配置 Prettier 的作用范围 中所述进行自定义。

配置 Prettier 以在新项目中保存或重新格式化时运行

  1. 前往 文件 | 新建项目设置 | 新项目的 设置。 在打开的对话框中,进入 语言与框架 | JavaScript | Prettier

  2. 使用 在“重新格式化代码”操作时运行On save 复选框指定将触发 Prettier 的操作。

  3. 如有需要,请按照 保存时自动运行 Prettier 中的说明更新 对文件运行 字段中的默认模式。

最后修改日期: 2025年 9月 26日