meta-json-schema

用法

Visual Studio Code中使用

1. 安装YAML语法支持插件redhat.vscode-yaml。
2. 在.vscode目录下的settings.json文件中（如不存在则手动创建），填入以下内容。其中，key为schema文件的地址，value为路径通配符，请根据需求自行修改。

   {
     "yaml.schemas": {
       "https://fastly.jsdelivr.net/gh/dongchengjie/meta-json-schema@main/schemas/meta-json-schema.json": "**/*.yaml"
     }
   }

Monaco Editor中使用

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://fastly.jsdelivr.net/gh/dongchengjie/airport@main/meta-json-schema.json',
         fileMatch: ['**/*.clash.yaml']
       }
     ]
   });

可视化

• meta-json-schema

• clash-verge-merge-json-schema

开发

1. 下载代码

git clone https://github.com/dongchengjie/meta-json-schema.git

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

code /path/to/project/location

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

3. 安装依赖

npm install

4. 启动项目。执行下列命令后,会对src目录进行监视,如果发生变动则会对项目进行bundle,输出到.temp目录下。

npm run dev

5. 测试schema。由于.vscode目录下settings.json中已事先配置了如下配置（test目录下的文件使用.temp目录下输出的schema文件）。因此可以对src进行修改,并在test目录下新增测试文件,及时观察变动并做出修正。

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

6. 发布release。执行下列命令后,会根据package.json文件中定义的releases进行输出,并根据optimization决定是否进行压缩。

npm run release

语法参考

JSON Schema标准语法

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

Monaco Editor扩展语法

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

interface JSONSchema {
  // 自定义Snippet建议(数组)
  defaultSnippets?: {
    label?: string; // 标题
    description?: string; // 描述
    markdownDescription?: string; // 描述(markdown格式)
    body?: any; // 内容
    bodyText?: string; // 内容文本
  }[];
  errorMessage?: string; // 错误信息
  patternErrorMessage?: string; // 格式错误信息(优先级高于errorMessage)
  deprecationMessage?: string; // 过时错误信息
  enumDescriptions?: string[]; // 枚举描述信息(数组)
  markdownEnumDescriptions?: string[]; // 枚举描述信息(markdown格式)
  markdownDescription?: string; // 描述信息(markdown格式)
  doNotSuggest?: boolean; // 不显示建议
  suggestSortText?: string; // 属性值建议排序符(默认为属性名)
  allowComments?: boolean; // 允许注释
  allowTrailingCommas?: boolean; // 允许尾随逗号
}

FAQ

definitions中的compatible.json文件的用途是什么？

YAML支持Folded Style和Inline Style的写法。 使用"type": "boolean"来定义某个属性,那么'true'和'false'就会提示Incorrect type. Expected "boolean".。因此引入compatible类型,以兼容多种编码风格。

Inline Style

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

Folded Style

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

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