WebStorm 2025.2 Help

YAML

WebStorm 允许您处理 YAML 文件( .yml .yaml ),并支持以下功能:

让我们来探索编辑器中提供的一些 YAML 专属功能。

锚点与别名

WebStorm 支持处理锚点与别名。 如果您在 YAML 文件中指定了一个新的锚点,编辑器会显示该锚点未被任何节点使用的警告。

YAML:未使用的锚点警告

现在,编辑器允许您为该锚点 补全 别名。

YAML:补全别名

若要快速查找锚点的用法,请将光标置于该锚点处并按 Ctrl+B

YAML:跳转到别名

WebStorm 支持锚点与别名的 重命名重构 :将光标置于锚点处并按 Shift+F6。 或者,右键点击锚点并选择 重构(R)| 重命名

重命名 YAML 锚点

使用 结构 工具窗口(Alt+7 )以便快速浏览 YAML 文件。 若要在 结构 工具窗口中显示或隐藏重用锚点的元素,请点击 视图选项 并使用 别名子树

YAML 结构视图

JSON 架构

WebStorm 使用 JSON 架构为 YAML 文件提供代码补全与检查支持。 WebStorm 可自动推断架构(基于文件位置或结构),或者您也可以 手动选择。 例如,如果您的 .github/workflows 目录中有 GitHub Actions 工作流文件,WebStorm 会基于从 schemastore.org 自动加载的 github-workflow.json 架构建议补全其选项:

YAML:基于架构进行补全

您可以在 设置 对话框的 语言与框架|架构与 DTD|远程 JSON 架构 页面中管理 JSON 架构的加载(Ctrl+Alt+S)。

如有需要,您可以在 语言与框架|架构与 DTD|JSON 架构映射 中指定所需架构文件的路径。

为文件选择 JSON 架构

您可以为特定文件指定自定义架构。

  1. 点击状态栏中的架构切换器。

    为文件选择架构
  2. 在打开的列表中,选择建议的架构之一或点击 新建架构映射…。 这将打开 JSON 架构映射 设置,您可以在其中为文件指定本地或远程架构。

从架构获取属性

如果 WebStorm 检测到您的 YAML 文件的架构,您可以使用专用操作快速将该架构的所有属性插入文件中,避免手动输入。

  • 如果架构包含必需属性,且您只想插入这些特定属性,请在文件任意位置按 Alt+Enter显示上下文操作 ),然后选择 添加缺失的属性

  • 如果您希望插入架构中提供的所有属性,请在文件任意位置按 Alt+Enter显示上下文操作 ),然后选择 从 JSON 架构填充所有属性

使用 $schema 关键字

您还可以在文件中直接引用架构。

  1. 在文件顶部输入 # $schema:

  2. 开始输入架构文件的名称。 您将获得从 schemastore.org 加载的架构名称的补全。

    如果您希望使用本地架构文件,请指定相对于要应用该架构的文件的路径,例如: # $schema: ./my-schema.json。 这样就可以获得与使用远程架构相同的编码支持功能,包括检查、补全和属性填充操作。

    使用本地架构进行补全

复制键

WebStorm 提供了复制 YAML 文件中某个选项完整路径的功能。 您可以通过以下两种方式完成此操作:

  • 将光标置于所需键上并按 Ctrl+Alt+Shift+C

  • 将鼠标悬停在所需键上,右键点击并选择 复制引用(Y)

YAML:复制引用

例如,在上图中,将复制 default.server.port

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