1. 安装YAML语法支持插件 redhat.vscode-yaml 。

2.1. 如果只针对单个文件，可在 YAML 文件首行添加 modeline 配置：

使用最新版本：

# yaml-language-server: $schema=https://unpkg.com/meta-json-schema/schemas/meta-json-schema.json
mode: rule

使用指定版本：

# yaml-language-server: $schema=https://unpkg.com/meta-json-schema@1.19.25/schemas/meta-json-schema.json
mode: rule

2.2. 如需一次性为多个文件配置：

在 .vscode 目录下的 settings.json 文件中（如不存在则手动创建），填入以下内容。

其中：

• key为schema文件的地址(url或本地文件)

• value为路径通配符

  使用最新版本：

  {
    "yaml.schemas": {
      "https://unpkg.com/meta-json-schema/schemas/meta-json-schema.json": "**/*.yaml"
    }
  }

  使用指定版本：

  {
    "yaml.schemas": {
      "https://unpkg.com/meta-json-schema@1.19.25/schemas/meta-json-schema.json": "**/*.yaml"
    }
  }

1. 安装 monaco-editor （编辑器）和 monaco-yaml （YAML支持）。

   npm install monaco-editor
   npm install monaco-yaml
   

2. 如果是vite项目，可通过安装插件简化初始化（其他构建工具如 webpack 请参考monaco-yaml文档）。

   1. 安装 vite-plugin-monaco-editor 。

   npm install vite-plugin-monaco-editor
   

   2. 配置 vite.config.ts 。

   import { defineConfig } from "vite";
   import monacoEditor from "vite-plugin-monaco-editor";
   
   export default defineConfig({
     plugins: [
       monacoEditor({
         languageWorkers: ["editorWorkerService"],
         customWorkers: [
           {
             label: "yaml",
             entry: "monaco-yaml/yaml.worker"
           }
         ]
       })
     ]
   });

   3. 代码中配置schema（请根据需求自行修改 fileMatch ）。

   import * as monaco from "monaco-editor";
   import { configureMonacoYaml } from "monaco-yaml";
   
   configureMonacoYaml(monaco, {
     validate: true,
     enableSchemaRequest: true,
     schemas: [
       {
         uri: "https://unpkg.com/meta-json-schema/schemas/meta-json-schema.json",
         fileMatch: ["**/*.clash.yaml"]
       }
     ]
   });

项目使用的JSON Schema版本为draft-07，语法请参考JSON Schema Reference。

Monaco 编辑器是为 VS Code 提供支持的开源代码编辑器，使用下列属性提供更丰富的 Snippet 支持。

interface JSONSchema {
  // 自定义 Snippet 建议（数组）
  defaultSnippets?: {
    label?: string; // 标签文本（显示在补全列表中）
    description?: string; // 标签描述（需要点击展开）
    markdownDescription?: string; // 标签描述（Markdown 格式，优先级高于 description）
    body?: any; // 实际插入内容（对象，会被序列化为 JSON 字符串）
    bodyText?: string; // 实际插入内容（纯文本形式，暂无实际作用）
  }[];
  errorMessage?: string; // 校验失败时的自定义错误信息
  patternErrorMessage?: string; // pattern 校验失败时的错误信息（优先级高于 errorMessage）
  deprecationMessage?: string; // 属性已过时时的提示信息（显示删除线警告）
  enumDescriptions?: string[]; // 枚举值的描述信息（与 enum 数组一一对应）
  enumSortTexts?: string[]; // 枚举值在补全列表中的排序文本（与 enum 数组一一对应）
  enumDetails?: string[]; // 枚举值的详细说明（与 enum 数组一一对应）
  markdownEnumDescriptions?: string[]; // 枚举值的描述信息（Markdown 格式，优先级高于 enumDescriptions）
  markdownDescription?: string; // 属性描述信息（Markdown 格式，优先级高于 description）
  doNotSuggest?: boolean; // 为 true 时不在补全建议中显示该属性
  suggestSortText?: string; // 属性在补全列表中的排序文本（默认为属性名）
  allowComments?: boolean; // 允许 JSON 文件中包含注释（JSONC 模式）
  allowTrailingCommas?: boolean; // 允许 JSON 文件中出现尾随逗号
  completionDetail?: string; // 补全项的附加说明文本（显示在补全列表右侧）
}