[Chore]

Author: Bistard

…s/2024-11-07-VSCode配置系统 2：JSON Schema.md …CN] VSCode系列「系统篇」：配置系统2 - JSON Schema.mdSystems/2024-11-07-VSCode配置系统 2：JSON Schema.md renamed to Systems/2024-11-07-[CN] VSCode系列「系统篇」：配置系统2 - JSON Schema.md Systems/2024-11-07-VSCode配置系统 2：JSON Schema.md renamed to Systems/2024-11-07-[CN] VSCode系列「系统篇」：配置系统2 - JSON Schema.md

@@ -1,5 +1,6 @@
 ---
 layout: post
+title: "[CN] VSCode系列「系统篇」：配置系统2 - JSON Schema"
 categories: [VSCode, Systems]
 ---
 
@@ -100,10 +101,15 @@ export interface IJSONSchema {
 由于没有使用复杂的类型系统，VSCode 的 `IJSONSchema` 将所有的 schema 字段都放在一起，而不是基于类型进行分离。这种方式虽然使得接口定义较为简单，但也导致接口字段较为冗长。
 
 ### VSCode的验证过程
-在 `IJSONSchema` 接口中，虽然定义了大量的字段以方便开发者使用统一格式进行数据描述，但具体的runtime的验证过程在VSCode中我并没有找到哪里被明确规定。
+> 在typescript中光定义一个Interface当然是无法起到数据验证功能的，因为TypeScript其中的类型在编译期间会进行类型擦除，而runtime时则没有任何runtime手段进行验证数据是否符合schema。
+> 因此VSCode也会有相关的runtime代码来检查runtime读取的json数据是否匹配对应的schema。
+
+不过在 `IJSONSchema` 接口中，虽然定义了大量的字段以方便开发者使用统一格式进行数据描述，但具体的runtime的验证过程在VSCode中我并没有找到哪里被明确规定。
 
 我猜测实际的验证是由不同的组件各自负责处理的，这意味着 `IJSONSchema` 并没有提供一个集中化的验证过程，而是依赖于具体实现进行验证。
 
+> 如果在你的项目中，我个人是建议弄一套集中化的验证过程，而不是让各个系统自己负责手动监测。除非有非常特殊的需求/性能敏感的场景。
+
 我唯一能找到的相关验证文件是：
 1. `src\vs\workbench\services\preferences\common\preferencesValidation.ts`
 貌似是用来验证preference configuration时会检查`IJSONSchema`和给定的数据是否匹配。

Systems/2024-11-07-[EN] VSCode系列「系统篇」：配置系统2 - JSON Schema.md

@@ -0,0 +1,114 @@
+---
+layout: post
+title: "[EN] VSCode Series: Configuration System 2 - JSON Schema"
+categories: [VSCode, Systems]
+---
+
+# `IJSONSchema` Interface
+
+> Reference: [JSON Schema Official Website](https://json-schema.org/)
+
+`IJSONSchema` is a standard interface in Visual Studio Code used to describe the structure and content of JSON data. It provides a set of rules to constrain the format of JSON data. A `schema` can be understood as a collection of rules that define and validate whether incoming JSON data conforms to the expected format. Below is a simple example.
+
+### Data Example
+```typescript
+interface IPerson {
+    name: string;
+    age: number;
+}
+```
+
+### `schema` Example
+```typescript
+let personSchema: IJSONSchema = {
+    type: 'object',
+    properties: {
+        name: {
+            type: 'string',
+            minLength: 1
+        },
+        age: {
+            type: 'number',
+            minimum: 0
+        }
+    },
+    required: ['name', 'age']
+};
+```
+
+### Valid Data Example
+```typescript
+let userData = {
+    "name": "John Doe",
+    "age": 30,
+    "email": "john@example.com",
+    "address": {
+        "street": "123 Main St",
+        "city": "Springfield",
+        "country": "USA"
+    },
+    "hobbies": ["Reading", "Traveling", "Swimming"]
+}
+```
+
+In VSCode, the `IJSONSchema` interface definition can be found in the `vscode/src/vs/base/common/jsonSchema.ts` file. Here’s a snippet of the interface:
+
+```typescript
+export interface IJSONSchema {
+    id?: string;
+    $id?: string;
+    $schema?: string;
+    type?: JSONSchemaType | JSONSchemaType[];
+    title?: string;
+    default?: any;
+    definitions?: IJSONSchemaMap;
+    description?: string;
+    properties?: IJSONSchemaMap;
+    patternProperties?: IJSONSchemaMap;
+    additionalProperties?: boolean | IJSONSchema;
+    minProperties?: number;
+    maxProperties?: number;
+    dependencies?: IJSONSchemaMap | { [prop: string]: string[]; };
+    items?: IJSONSchema | IJSONSchema[];
+    minItems?: number;
+    maxItems?: number;
+    uniqueItems?: boolean;
+    additionalItems?: boolean | IJSONSchema;
+    pattern?: string;
+    minLength?: number;
+    maxLength?: number;
+    minimum?: number;
+    maximum?: number;
+    exclusiveMinimum?: boolean | number;
+    exclusiveMaximum?: boolean | number;
+    multipleOf?: number;
+    required?: string[];
+    $ref?: string;
+    anyOf?: IJSONSchema[];
+    allOf?: IJSONSchema[];
+    oneOf?: IJSONSchema[];
+    not?: IJSONSchema;
+}
+```
+
+The `IJSONSchema` interface is complex because it consolidates attributes for all types. Different data types correspond to different constraints:
+
+- When `type: 'number'`, attributes like `minimum` and `maximum` are used to limit the range of values.
+- When `type: 'string'`, attributes like `minLength` and `maxLength` constrain the length of the string.
+- When `type: 'array'`, attributes like `minItems` and `maxItems` specify the number of items.
+
+Since it doesn’t use an elaborate type system, VSCode’s `IJSONSchema` combines all schema fields into a single structure rather than segregating them by type. While this approach simplifies the interface definition, it makes the interface more verbose.
+
+### Validation Process in VSCode
+> In TypeScript, defining an interface alone does not enable data validation, as TypeScript's type system is erased during compilation, leaving no runtime means to validate data against the schema.
+> Therefore, VSCode includes runtime code to verify that JSON data conforms to the schema.
+
+Although the `IJSONSchema` interface includes many fields to help developers describe data in a unified format, the specific runtime validation process is not clearly documented in VSCode.
+
+I speculate that validation is handled by different components independently. This means `IJSONSchema` does not provide a centralized validation process but relies on specific implementations to perform the validation.
+
+> In your own project, I recommend implementing a centralized validation process rather than having different systems handle validation manually—unless you have highly specific requirements or performance-sensitive scenarios.
+
+The only related validation file I found is:
+1. `src/vs/workbench/services/preferences/common/preferencesValidation.ts`
+   It seems to validate `IJSONSchema` against provided data when checking preference configurations.