Merge pull request #589 from DannyBen/update/settings-schema

Update settings JSON schema
DannyBen · Dec 27, 2024 · 1da194d · 1da194d
2 parents e942477 + 74be3df
commit 1da194d
Show file tree

Hide file tree

Showing 2 changed files with 94 additions and 5 deletions.
diff --git a/schemas/settings.json b/schemas/settings.json
@@ -253,6 +253,66 @@
         }
       },
       "additionalProperties": false
+    },
+    "var_aliases": {
+      "title": "var_aliases",
+      "description": "Declare alias names for bashly's public global arrays\nhttps://bashly.dannyb.co/usage/settings/#var_aliases",
+      "type": "object",
+      "properties": {
+        "args": {
+          "title": "args",
+          "description": "Alias name for the args array\nhttps://bashly.dannyb.co/usage/settings/#var_aliases",
+          "oneOf": [
+            {
+              "type": "string",
+              "minLength": 1
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "other_args": {
+          "title": "other_args",
+          "description": "Alias name for the other_args array (used when catch_all is enabled)\nhttps://bashly.dannyb.co/usage/settings/#var_aliases",
+          "oneOf": [
+            {
+              "type": "string",
+              "minLength": 1
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "deps": {
+          "title": "deps",
+          "description": "Alias name for the deps array\nhttps://bashly.dannyb.co/usage/settings/#var_aliases",
+          "oneOf": [
+            {
+              "type": "string",
+              "minLength": 1
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "env_var_names": {
+          "title": "env_var_names",
+          "description": "Alias name for the env_var_names array\nhttps://bashly.dannyb.co/usage/settings/#var_aliases",
+          "oneOf": [
+            {
+              "type": "string",
+              "minLength": 1
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      },
+      "additionalProperties": false
     }
   },
   "additionalProperties": false

diff --git a/support/schema/settings.yml b/support/schema/settings.yml
@@ -68,7 +68,7 @@ properties:
     description: |-
       The path to use for command files, relative to source_dir
       https://bashly.dannyb.co/usage/settings/#commands_dir
-    oneOf:
+    oneOf: &optional_string
       - type: string
         minLength: 1
       - type: "null"
@@ -186,10 +186,7 @@ properties:
     description: |-
       The name of the environment variable (case sensitive) that, if set, will reveal private commands, flags and environment variables
       https://bashly.dannyb.co/usage/settings/#private_reveal_key
-    oneOf:
-      - type: string
-        minLength: 1
-      - type: "null"
+    oneOf: *optional_string
   usage_colors:
     title: usage colors
     description: |-
@@ -228,4 +225,36 @@ properties:
           https://bashly.dannyb.co/usage/settings/#usage_colors
         $ref: '#/definitions/color'
     additionalProperties: false
+  var_aliases:
+    title: var_aliases
+    description: |-
+      Declare alias names for bashly's public global arrays
+      https://bashly.dannyb.co/usage/settings/#var_aliases
+    type: object
+    properties:
+      args:
+        title: args
+        description: |-
+          Alias name for the args array
+          https://bashly.dannyb.co/usage/settings/#var_aliases
+        oneOf: *optional_string
+      other_args:
+        title: other_args
+        description: |-
+          Alias name for the other_args array (used when catch_all is enabled)
+          https://bashly.dannyb.co/usage/settings/#var_aliases
+        oneOf: *optional_string
+      deps:
+        title: deps
+        description: |-
+          Alias name for the deps array
+          https://bashly.dannyb.co/usage/settings/#var_aliases
+        oneOf: *optional_string
+      env_var_names:
+        title: env_var_names
+        description: |-
+          Alias name for the env_var_names array
+          https://bashly.dannyb.co/usage/settings/#var_aliases
+        oneOf: *optional_string
+    additionalProperties: false
 additionalProperties: false