update terminal docs and schema for command.variables

Author: DannyBen

lib/bashly/docs/command.yml

@@ -310,7 +310,7 @@ command.private:
       private: true
 
 command.variables:
-  help: Define a list of global bash variables.
+  help: Define a list of global bash variables. See `variable` for reference.
   url: https://bashly.dannyb.co/configuration/command/#variables
   example: |-
     variables:
@@ -330,7 +330,6 @@ command.variables:
         pattern: "*.json"
         compression_level: fast
 
-
 command.version:
   help: Specify the version to show when running with `--version`.
   url: https://bashly.dannyb.co/configuration/command/#version

lib/bashly/docs/var.yml

@@ -0,0 +1,51 @@
+variable:
+  help: Define variables that will be available to your script.
+  url: https://bashly.dannyb.co/configuration/variable/
+  example: |-
+    variables:
+    # Simple value
+    - name: output_folder
+      value: output
+
+    # Array
+    - name: download_sources
+      value:
+      - youtube
+      - instagram
+
+    # Associative array
+    - name: zip_options
+      value:
+        pattern: "*.json"
+        compression_level: fast
+
+variable.name:
+  help: Specify the name of the variable.
+  url: https://bashly.dannyb.co/configuration/variable/#name
+  example: |-
+    variables:
+    - name: output_folder
+      value: output
+
+variable.value:
+  help: |-
+    Specify the value for this variable.
+    This can be any value type, including array and hash (associative array).
+  url: https://bashly.dannyb.co/configuration/variable/#value
+  example: |-
+    variables:
+    # Simple value
+    - name: output_folder
+      value: output
+
+    # Array
+    - name: download_sources
+      value:
+      - youtube
+      - instagram
+
+    # Associative array
+    - name: zip_options
+      value:
+        pattern: "*.json"
+        compression_level: fast

schemas/bashly.json

@@ -382,15 +382,15 @@
     },
     "variable": {
       "title": "variable",
-      "description": "A global bash variable\nhttps://bashly.dannyb.co/configuration/command/#variables",
+      "description": "A global bash variable\nhttps://bashly.dannyb.co/configuration/variable/#variable",
       "type": "object",
       "required": [
         "name"
       ],
       "properties": {
         "name": {
           "title": "name",
-          "description": "A name for the current variable",
+          "description": "A name for the current variable\nhttps://bashly.dannyb.co/configuration/variable/#name",
           "type": "string",
           "minLength": 1,
           "examples": [
@@ -399,9 +399,9 @@
         },
         "value": {
           "title": "value",
-          "description": "A value for the current variable",
+          "description": "A value for the current variable\nhttps://bashly.dannyb.co/configuration/variable/#value",
           "examples": [
-            "output_dir",
+            "./output",
             [
               "development",
               "production"

spec/approvals/cli/doc/full

@@ -469,7 +469,7 @@ command.private
 
 command.variables
 
-  Define a list of global bash variables.
+  Define a list of global bash variables. See variable for reference.
 
     variables:
     # Simple value
@@ -824,3 +824,60 @@ flag.validate
 
   See https://bashly.dannyb.co/configuration/flag/#validate
 
+variable
+
+  Define variables that will be available to your script.
+
+    variables:
+    # Simple value
+    - name: output_folder
+      value: output
+    
+    # Array
+    - name: download_sources
+      value:
+      - youtube
+      - instagram
+    
+    # Associative array
+    - name: zip_options
+      value:
+        pattern: "*.json"
+        compression_level: fast
+
+  See https://bashly.dannyb.co/configuration/variable/
+
+variable.name
+
+  Specify the name of the variable.
+
+    variables:
+    - name: output_folder
+      value: output
+
+  See https://bashly.dannyb.co/configuration/variable/#name
+
+variable.value
+
+  Specify the value for this variable.
+  This can be any value type, including array and hash (associative array).
+
+    variables:
+    # Simple value
+    - name: output_folder
+      value: output
+    
+    # Array
+    - name: download_sources
+      value:
+      - youtube
+      - instagram
+    
+    # Associative array
+    - name: zip_options
+      value:
+        pattern: "*.json"
+        compression_level: fast
+
+  See https://bashly.dannyb.co/configuration/variable/#value
+

spec/approvals/cli/doc/index

@@ -51,3 +51,6 @@ flag.required
 flag.short
 flag.unique
 flag.validate
+variable
+variable.name
+variable.value

support/schema/bashly.yml

@@ -339,23 +339,27 @@ definitions:
     title: variable
     description: |-
       A global bash variable
-      https://bashly.dannyb.co/configuration/command/#variables
+      https://bashly.dannyb.co/configuration/variable/#variable
     type: object
     required:
       - name
     properties:
       name:
         title: name
-        description: A name for the current variable
+        description: |-
+          A name for the current variable
+          https://bashly.dannyb.co/configuration/variable/#name
         type: string
         minLength: 1
         examples:
           - output_dir
       value:
         title: value
-        description: A value for the current variable
+        description: |-
+          A value for the current variable
+          https://bashly.dannyb.co/configuration/variable/#value
         examples:
-          - output_dir
+          - ./output
           - [development, production]
           - { verbosity: 3, debug: true }
     patternProperties: *custom-properties