feat: add route json schema

posva · Jul 4, 2022 · c5480e1 · c5480e1
1 parent 3791545
commit c5480e1
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/package.json b/package.json
@@ -52,6 +52,7 @@
   },
   "files": [
     "dist",
+    "./route.schema.json",
     "*.d.ts"
   ],
   "scripts": {

diff --git a/route.schema.json b/route.schema.json
@@ -0,0 +1,25 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/posva/unplugin-vue-router/main/route.schema.json",
+  "title": "Route custom block",
+  "description": "An SFC custom block to add information to a route",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the route"
+    },
+    "path": {
+      "type": "string",
+      "description": "The path of the route"
+    },
+    "meta": {
+      "type": "object",
+      "description": "The meta of the route"
+    },
+    "props": {
+      "type": "boolean",
+      "description": "Whether the route should be passed its params as props"
+    }
+  }
+}