Merge pull request #268 from lets-cli/improve-json-schema

improve json schema
lets-cli · Oct 26, 2024 · 75d7fc6 · 75d7fc6
2 parents 4c4d312 + 8dc2c77
commit 75d7fc6
Showing 1 changed file with 99 additions and 68 deletions.
diff --git a/docs/static/schema.json b/docs/static/schema.json
@@ -16,7 +16,27 @@
       "type": "array",
       "description": "List of mixin files to include.",
       "items": {
-        "type": "string"
+        "oneOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "url": {
+                "type": "string",
+                "description": "URL to the mixin file."
+              },
+              "version": {
+                "type": "number",
+                "description": "Version of the mixin file."
+              }
+            },
+            "required": [
+              "url"
+            ]
+          }
+        ]
       }
     },
     "env": {
@@ -35,87 +55,98 @@
       "description": "Set of commands to execute.",
       "patternProperties": {
         "^[a-zA-Z][a-zA-Z0-9_:-]*$": {
-          "type": "object",
-          "properties": {
-            "description": {
+          "oneOf": [
+            {
               "type": "string",
-              "description": "A description of the command."
+              "description": "Command as a string."
             },
-            "options": {
+            {
+              "$ref": "#/definitions/command_object"
+            }
+          ]
+        }
+      }
+    }
+  },
+  "required": [
+    "commands"
+  ],
+  "definitions": {
+    "command_object": {
+      "type": "object",
+      "properties": {
+        "description": {
+          "type": "string",
+          "description": "A description of the command."
+        },
+        "options": {
+          "type": "string",
+          "description": "Options for the command in docopt format."
+        },
+        "cmd": {
+          "oneOf": [
+            {
               "type": "string",
-              "description": "Options for the command in docopt format."
-            },
-            "cmd": {
-              "oneOf": [
-                {
-                  "type": "string",
-                  "description": "Command as a string."
-                },
-                {
-                  "type": "array",
-                  "description": "Command as a list of strings.",
-                  "items": {
-                    "type": "string"
-                  }
-                },
-                {
-                  "type": "object",
-                  "description": "Command as an object with key as named command and value as a script",
-                  "patternProperties": {
-                    "^[a-zA-Z_][a-zA-Z0-9_]*$": {
-                      "oneOf": [
-                        {
-                          "type": "string",
-                          "description": "Command as a string."
-                        },
-                        {
-                          "type": "array",
-                          "description": "Command as a list of strings.",
-                          "items": {
-                            "type": "string"
-                          }
-                        }
-                      ]
-                    }
-                  }
-                }
-              ]
+              "description": "Command as a string."
             },
-            "depends": {
+            {
               "type": "array",
+              "description": "Command as a list of strings.",
               "items": {
                 "type": "string"
               }
             },
-            "persist_checksum": {
-              "type": "boolean"
-            },
-            "checksum": {
-              "type": "array",
-              "items": {
-                "type": "string"
+            {
+              "type": "object",
+              "description": "Command as an object with key as named command and value as a script",
+              "patternProperties": {
+                "^[a-zA-Z_][a-zA-Z0-9_]*$": {
+                  "oneOf": [
+                    {
+                      "type": "string",
+                      "description": "Command as a string."
+                    },
+                    {
+                      "type": "array",
+                      "description": "Command as a list of strings.",
+                      "items": {
+                        "type": "string"
+                      }
+                    }
+                  ]
+                }
               }
-            },
-            "env": {
-              "$ref": "#/definitions/env"
-            },
-            "after": {
-              "type": "string",
-              "description": "A shell sctipt to run after the command."
-            },
-            "work_dir": {
-              "type": "string",
-              "description": "A directory to run the command in."
             }
+          ]
+        },
+        "depends": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "persist_checksum": {
+          "type": "boolean"
+        },
+        "checksum": {
+          "type": "array",
+          "items": {
+            "type": "string"
           }
+        },
+        "env": {
+          "$ref": "#/definitions/env"
+        },
+        "after": {
+          "type": "string",
+          "description": "A shell sctipt to run after the command."
+        },
+        "work_dir": {
+          "type": "string",
+          "description": "A directory to run the command in."
         }
       }
-    }
-  },
-  "required": [
-    "commands"
-  ],
-  "definitions": {
+    },
     "env": {
       "type": "object",
       "description": "Environment variables to set.",