meta-json-schema 1.18.3-beta

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["redhat.vscode-yaml"]
+}

package/.vscode/settings.json

@@ -0,0 +1,18 @@
+{
+  "json.schemas": [
+    {
+      "url": "http://json-schema.org/draft-07/schema",
+      "fileMatch": ["/src/**/*.json"]
+    }
+  ],
+  "yaml.schemas": {
+    ".temp/meta-json-schema.json": "test/clash-meta/**/*.yaml",
+    ".temp/clash-verge-merge-json-schema.json": "test/clash-verge/**/*.yaml"
+  },
+  "editor.tabSize": 2,
+  "files.exclude": {
+    ".gitattributes": true,
+    ".gitignore": true,
+    "package-lock.json": true
+  }
+}

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+## v1.18.3
+
+### Features
+
+- 首个JSON Schema版本
+
+### Bugs Fixes
+
+---

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 dongchengjie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,200 @@
+## 用法
+
+<details>
+<summary>Visual Studio Code中使用</summary>
+
+1. 安装YAML语法支持插件`redhat.vscode-yaml`。
+2. 在`.vscode`目录下的`settings.json`文件中（如不存在则手动创建），填入以下内容。其中，key为schema文件的地址，value为路径通配符，请根据需求自行修改。
+   ```json
+   {
+     "yaml.schemas": {
+       "https://fastly.jsdelivr.net/gh/dongchengjie/meta-json-schema@main/schemas/meta-json-schema.json": "**/*.yaml"
+     }
+   }
+   ```
+
+</details>
+<details>
+<summary>Monaco Editor中使用</summary>
+
+1.  安装`monaco-editor`（编辑器）和`monaco-yaml`（YAML支持）。
+
+    ```
+    npm install monaco-editor
+    npm install monaco-yaml
+    ```
+
+2.  如果是vite项目，可通过安装插件简化初始化（其他构建工具如`webpack`请参考[monaco-yaml文档](https://github.com/remcohaszing/monaco-yaml?tab=readme-ov-file#using-monaco-webpack-loader-plugin)）。
+
+    1.  安装`vite-plugin-monaco-editor`。
+
+    ```
+    npm install vite-plugin-monaco-editor
+    ```
+
+    2.  配置`vite.config.ts`。
+
+    ```javascript
+    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`）。
+
+    ```javascript
+    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']
+        }
+      ]
+    });
+    ```
+
+</details>
+
+## 可视化
+
+- <a href="https://dongchengjie.github.io/meta-json-schema/?schema=https://raw.githubusercontent.com/dongchengjie/meta-json-schema/main/schemas/meta-json-schema.json" target="_blank">meta-json-schema</a>
+
+- <a href="https://dongchengjie.github.io/meta-json-schema/?schema=https://raw.githubusercontent.com/dongchengjie/meta-json-schema/main/schemas/clash-verge-merge-json-schema.json" target="_blank">clash-verge-merge-json-schema</a>
+
+## 开发
+
+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
+"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
+```
+
+## 语法参考
+
+<details>
+<summary>JSON Schema标准语法</summary>
+
+项目使用的JSON Schema版本为[`draft-07`](https://json-schema.org/draft-07/json-schema-release-notes)，语法请参考[JSON Schema Reference](https://json-schema.org/understanding-json-schema/reference)。
+
+</details>
+
+<details>
+<summary>Monaco Editor扩展语法</summary>
+
+> Monaco 编辑器是为 VS Code 提供支持的开源代码编辑器，使用下列属性提供更丰富的`Snippet`支持。
+
+```typescript
+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; // 允许尾随逗号
+}
+```
+
+</details>
+
+## FAQ
+
+### definitions中的`compatible.json`文件的用途是什么？
+
+YAML支持`Folded Style`和`Inline Style`的写法。
+使用`"type": "boolean"`来定义某个属性,那么`'true'`和`'false'`就会提示`Incorrect type. Expected "boolean".`。因此引入compatible类型,以兼容多种编码风格。
+
+<details>
+<summary>Inline Style</summary>
+
+```
+proxies:
+  - {name: 'proxy1', type: 'ss', cipher: 'auto', tls: 'true'}
+  - {name: proxy2, type: ss, cipher: auto, tls: true}
+```
+
+</details>
+
+<details>
+<summary>Folded Style</summary>
+
+```
+proxies:
+- name: 'proxy1'
+  type: 'ss'
+  cipher: 'auto'
+  tls: 'true'
+- name: proxy1
+  type: ss
+  cipher: auto
+  tls: true
+```
+
+</details>
+
+> [!NOTE]
+> 由于这种情况多发生于`proxies`配置部分，所以目前仅`proxies`配置中使用了`compatible.json`,其余地方可视情况使用。

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "meta-json-schema",
+  "version": "1.18.3-beta",
+  "keywords": [
+    "clash",
+    "clash.meta",
+    "schema"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "config": {
+    "watches": [
+      "./src/meta-json-schema.json",
+      "./src/clash-verge-merge-json-schema.json"
+    ],
+    "releases": [
+      {
+        "enabled": true,
+        "source": "./src/meta-json-schema.json",
+        "target": "./schemas/meta-json-schema.json",
+        "optimization": true
+      },
+      {
+        "enabled": true,
+        "source": "./src/clash-verge-merge-json-schema.json",
+        "target": "./schemas/clash-verge-merge-json-schema.json",
+        "optimization": true
+      }
+    ]
+  },
+  "scripts": {
+    "dev": "node ./scripts/watch.mjs",
+    "release": "node ./scripts/release.mjs"
+  },
+  "devDependencies": {
+    "@apidevtools/json-schema-ref-parser": "^11.5.4",
+    "prettier": "^3.2.5"
+  }
+}