doc: Add ruleset schema

PRO-2684 · PRO-2684 · commit 4d3621549d18 · 2024-12-02T21:11:47.000+08:00
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1 @@
-.vscode
 rules
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,10 @@
+{
+    "json.schemas": [
+        {
+            "fileMatch": [
+                "/scripts/test-rules.json"
+            ],
+            "url": "/ruleset.schema.json"
+        }
+    ]
+}
diff --git a/README.md b/README.md
@@ -121,6 +121,8 @@ Community-contributed rulesets are hosted on GitHub, and you can find them at [p
 }
 ```
 
+Formal definition of the format can be found at [`ruleset.schema.json`](./ruleset.schema.json).
+
 ### ✅ Path Matching
 
 `<domain>`, `<path>`: The domain and a part of path, such as `example.com/`, `/^.+\.example\.com$`, `path/` and `page`. Here's an explanation of them:
diff --git a/README_zh.md b/README_zh.md
@@ -121,6 +121,8 @@ new Purlfy({
 }
 ```
 
+此格式的形式化定义可以参考 [`ruleset.schema.json`](./ruleset.schema.json)。
+
 ### ✅ 路径匹配
 
 `<domain>`, `<path>`: 域名和一部分路径，例如 `example.com/`, `/^.+\.example\.com$`, `path/` 和 `page`。以下是对它们的解释:
diff --git a/ruleset.schema.json b/ruleset.schema.json
@@ -0,0 +1,106 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Ruleset Schema",
+    "type": "object",
+    "patternProperties": {
+        "^[^/]+/$": {
+            "$ref": "#/definitions/recurse"
+        },
+        "^[^/]+$": {
+            "$ref": "#/definitions/rule"
+        },
+        "^/.+/$": {
+            "$ref": "#/definitions/recurse"
+        },
+        "^/.+[^/]$": {
+            "$ref": "#/definitions/rule"
+        }
+    },
+    "definitions": {
+        "rule": {
+            "type": "object",
+            "properties": {
+                "description": {
+                    "type": "string"
+                },
+                "mode": {
+                    "type": "string",
+                    "enum": [
+                        "white",
+                        "black",
+                        "param",
+                        "regex",
+                        "redirect",
+                        "visit",
+                        "lambda",
+                        "headers",
+                        "continue"
+                    ]
+                },
+                "params": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "author": {
+                    "type": "string"
+                },
+                "acts": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "lambda": {
+                    "type": "string"
+                },
+                "regex": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "replace": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "headers": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "string"
+                    }
+                },
+                "continue": {
+                    "type": "boolean"
+                }
+            },
+            "required": [
+                "mode",
+                "description",
+                "author"
+            ],
+            "additionalProperties": false
+        },
+        "recurse": {
+            "type": "object",
+            "patternProperties": {
+                "^[^/]+/$": {
+                    "$ref": "#/definitions/recurse"
+                },
+                "^[^/]+$": {
+                    "$ref": "#/definitions/rule"
+                },
+                "^/.+/$": {
+                    "$ref": "#/definitions/recurse"
+                },
+                "^/.+[^/]$": {
+                    "$ref": "#/definitions/rule"
+                }
+            }
+        }
+    },
+    "additionalProperties": false
+}
diff --git a/scripts/test-rules.json b/scripts/test-rules.json
@@ -64,4 +64,4 @@
             "author": "PRO-2684"
         }
     }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -121,6 +121,8 @@ Community-contributed rulesets are hosted on GitHub, and you can find them at [p`
`121`	`121`	`}`
`122`	`122`	```
`123`	`123`
	`124`	+Formal definition of the format can be found at [`ruleset.schema.json`](./ruleset.schema.json).
	`125`	`+`
`124`	`126`	`### ✅ Path Matching`
`125`	`127`
`126`	`128`	`<domain>`, `<path>`: The domain and a part of path, such as `example.com/`, `/^.+\.example\.com$`, `path/` and `page`. Here's an explanation of them:
Original file line number	Diff line number	Diff line change
`@@ -121,6 +121,8 @@ new Purlfy({`
`121`	`121`	`}`
`122`	`122`	```
`123`	`123`
	`124`	+此格式的形式化定义可以参考 [`ruleset.schema.json`](./ruleset.schema.json)。
	`125`	`+`
`124`	`126`	`### ✅ 路径匹配`
`125`	`127`
`126`	`128`	`<domain>`, `<path>`: 域名和一部分路径，例如 `example.com/`, `/^.+\.example\.com$`, `path/` 和 `page`。以下是对它们的解释:
Original file line number	Diff line number	Diff line change
`@@ -64,4 +64,4 @@`
`64`	`64`	`"author": "PRO-2684"`
`65`	`65`	`}`
`66`	`66`	`}`
`67`		`-}`
	`67`	`+}`