🧩 VSCode 插件

VS Code 扩展商店搜索 Meta JSON Schema 或 ClashMeta.meta-json-schema ，安装扩展后即可获取 Clash.Meta 的语法支持。

💡 用法

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

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/[email protected]/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可视化

• meta-json-schema

• clash-verge-merge-json-schema

• clash-nyanpasu-merge-json-schema

🖥️ 贡献代码

1. Fork仓库代码

2. 使用Visual Studio Code打开项目（工作目录为.vscode所在目录）

code path/to/project

[!NOTE] 项目打开后会弹出建议安装YAML插件的提示，请点击确认安装或手动安装，以获取良好的开发体验。

3. 安装依赖

pnpm install

4. 启动项目。

• 执行下列命令后，会对 src 目录进行监视。
• 如果发生变动则会对项目进行打包，输出到 schemas 目录下。

pnpm dev

5. 测试验证生成的schema文件

• 由于 .vscode 目录下 settings.json 中已事先配置了如下配置（ test 目录下的文件使用 schemas 目录下输出的schema文件）。于是可以对src目录中的内容进行修改，通过自动打包更新schema文件。
• 通过在 test 目录下新增测试文件，观察并验证校验结果，并及时做出修正。

"yaml.schemas": {
  "schemas/meta-json-schema.json": "test/clash-meta/**/*.yaml",
  "schemas/clash-verge-merge-json-schema.json": "test/clash-verge/**/*.yaml",
  "schemas/clash-verge-nyanpasu-json-schema.json": "test/clash-nyanpasu/**/*.yaml"
}

6. 输出打包

• 执行下列命令后，会根据 package.json 文件中定义的releases进行输出，并根据 optimize 中的配置决定是否进行压缩。

pnpm release

📖 JSON Schema 语法参考

项目使用的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; // 补全项的附加说明文本（显示在补全列表右侧）
}

❓ FAQ

definitions目录下的 compatible.json 文件的用途是什么？

与 JSON 严格的值格式不同，YAML 支持 Folded Style（折叠风格）与 Inline Style（内联风格），同时兼容 Quoted（带引号）与 Unquoted（不带引号）字符串写法。

例如，将某属性定义为 "type": "boolean" 时，若值为字符串 'true' 或 'false'，校验器将报错 Incorrect type. Expected "boolean"..。

因此引入compatible类型，以兼容多种编码风格。

proxies:
  - { name: "proxy1", type: "ss", cipher: "auto", tls: "true" }
  - { name: proxy2, type: ss, cipher: auto, tls: true }

proxies:
  - name: "proxy1"
    type: "ss"
    cipher: "auto"
    tls: "true"
  - name: proxy1
    type: ss
    cipher: auto
    tls: true

[!NOTE] 由于这种情况多发生于 proxies 配置部分，所以目前仅 proxies 配置中使用了 compatible.json ，其余地方可视情况使用。