Merge pull request #35 from DannyBen/next

Next: Variable

Author: DannyBen

Gemfile.lock

@@ -24,7 +24,7 @@ GEM
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
       llhttp-ffi (~> 0.5.0)
-    http-cookie (1.0.6)
+    http-cookie (1.0.7)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
     httpme (0.2.2)
@@ -40,16 +40,16 @@ GEM
       colsole (>= 0.8.1, < 2)
       docopt_ng (~> 0.7, >= 0.7.1)
     module_methods (0.1.0)
-    mustermann (3.0.0)
+    mustermann (3.0.3)
       ruby2_keywords (~> 0.0.1)
     nio4r (2.7.3)
-    nokogiri (1.16.6-x86_64-linux)
+    nokogiri (1.16.7-x86_64-linux)
       racc (~> 1.4)
-    public_suffix (6.0.0)
-    puma (6.4.2)
+    public_suffix (6.0.1)
+    puma (6.4.3)
       nio4r (~> 2.0)
-    racc (1.8.0)
-    rack (3.1.6)
+    racc (1.8.1)
+    rack (3.1.8)
     rack-contrib (2.5.0)
       rack (< 4)
     rack-protection (4.0.0)
@@ -84,4 +84,4 @@ DEPENDENCIES
   sla
 
 BUNDLED WITH
-   2.5.14
+   2.5.22

retype.yml

@@ -13,7 +13,7 @@ editor:
 branding:
   logo: assets/logo.svg
   logoDark: assets/logo-dark.svg
-  label: v1.2.3
+  label: v1.2.4
 
 meta:
   title: " | Bashly - Bash Command Line Framework"

src/advanced/bash-completion.md

@@ -39,7 +39,7 @@ By running `bashly generate --upgrade`, your completions function
 
 ## Custom command completions
 
-In addition to the automatic suggestion of sub-commands and flags, you can
+In addition to the automatic suggestion of subcommands and flags, you can
 instruct bashly to also suggest files, directories, users, git branches and
 more. To do this, add another option in your `bashly.yml` on the command you
 wish to alter:

src/configuration/command.md

@@ -8,7 +8,7 @@ order: 100
 The `command` object serves two purposes, it:
 
 1. Defines the root CLI application (command).
-2. Defines any nested sub-commands, if any.
+2. Defines any nested subcommands, if any.
 
 ==- :icon-code-review: Show Me How
 ```yaml bashly.yml
@@ -52,7 +52,7 @@ commands:
 ===
 
 Unless otherwise specified, these definitions can be used for both the root
-command and sub-commands (under the `commands` definition).
+command and subcommands (under the `commands` definition).
 
 !!! Note
 Most properties are optional, unless specified otherwise.
@@ -66,17 +66,13 @@ Most properties are optional, unless specified otherwise.
 [!badge String]
 [!badge variant="danger" text="Required"]
 
-The name of the script or sub-command.
+The name of the script or subcommand.
 
 
 ### alias
 
 [!badge String / Array of Strings]
-[!badge variant="warning" text="Sub-Commands Only"]
-
-!!! Note
-This command used to be called `short` in bashly < 0.8.0
-!!!
+[!badge variant="warning" text="Subcommands Only"]
 
 One or more additional optional names for this command. This can be used to
 create a shortcut for a command, or provide alternative names for it.
@@ -124,9 +120,9 @@ Specify the array of positional arguments this script needs.
 Specify the array of option flags this script needs.
 
 !!! Note
-Flags that are defined in a command that has sub-commands, are considered
-"global flags", and will be available to all sub-commands, in addition to any
-flag defined in any of the sub-commands themselves.
+Flags that are defined in a command that has subcommands, are considered
+"global flags", and will be available to all subcommands, in addition to any
+flag defined in any of the subcommands themselves.
 
 The [docker-like example](https://github.com/DannyBen/bashly/tree/master/examples/docker-like#readme)
 demonstrates this feature.
@@ -145,7 +141,7 @@ Specify the array of commands. Each command will have its own args and flags.
 Using `commands` on a given command implies that this command does not have flags or args.
 !!!
 
-[!button variant="primary" icon="code-review" text="Commands Example"](https://github.com/DannyBen/bashly/tree/master/examples/commands#readme) [!button variant="primary" icon="code-review" text="Sub-Commands Example"](https://github.com/DannyBen/bashly/tree/master/examples/commands-nested#readme) 
+[!button variant="primary" icon="code-review" text="Commands Example"](https://github.com/DannyBen/bashly/tree/master/examples/commands#readme) [!button variant="primary" icon="code-review" text="Subcommands Example"](https://github.com/DannyBen/bashly/tree/master/examples/commands-nested#readme) 
 
 
 
@@ -164,7 +160,7 @@ The string to display when using `--version`.
 ### default
 
 [!badge Boolean / String]
-[!badge variant="warning" text="Sub-Commands Only"]
+[!badge variant="warning" text="Subcommands Only"]
 
 - Setting this to `true` on any command, will cause any **unrecognized**
   command line to be passed to this command.
@@ -204,7 +200,7 @@ Add a custom message that will be displayed at the end of the `--help` text.
 ### group
 
 [!badge String]
-[!badge variant="warning" text="Sub-Commands Only"]
+[!badge variant="warning" text="Subcommands Only"]
 
 In case you have many commands, use this option to specify a caption to display
 before this command.
@@ -213,7 +209,13 @@ This option is purely for display purposes.
 
 [!button variant="primary" icon="code-review" text="Command Groups Example"](https://github.com/DannyBen/bashly/tree/master/examples/command-groups#readme)
 
+### variables
+
+[!badge Array of Variables]
+
+Specify an array of variables that can be accessed globally in your script, or subcommands.
 
+[!ref](variable.md)
 
 ## Advanced Options
 
@@ -261,17 +263,17 @@ script.
 ### expose
 
 [!badge Boolean / String]
-[!badge variant="warning" text="Sub-Commands Only"]
+[!badge variant="warning" text="Subcommands Only"]
 
-Setting this to `true` or `always` on any command that has sub-commands, will
-show its sub-commands in the help or usage text of the parent command.
+Setting this to `true` or `always` on any command that has subcommands, will
+show its subcommands in the help or usage text of the parent command.
 
-- Set to `true` to show the sub-commands only when the parent command is
+- Set to `true` to show the subcommands only when the parent command is
   executed with `--help`.
-- Set to `always` to show the sub-commands also when the parent command is
+- Set to `always` to show the subcommands also when the parent command is
   executed without any arguments.
 
-You can use `expose` with the [`group`](#group) option, to show sub-commands
+You can use `expose` with the [`group`](#group) option, to show subcommands
 in a logical, visual grouping.
 
 [!button variant="primary" icon="code-review" text="Commands Expose Example"](https://github.com/DannyBen/bashly/tree/master/examples/commands-expose#readme)
@@ -341,7 +343,7 @@ as a "last resort" mechanism to help in solving more complex scenarios.
 ### private
 
 [!badge Boolean]
-[!badge variant="warning" text="Sub-Commands Only"]
+[!badge variant="warning" text="Subcommands Only"]
 
 Setting this to `true` on any command, will hide it from the command list.
 

src/configuration/variable.md

@@ -0,0 +1,60 @@
+---
+icon: dot
+order: 50
+---
+
+# Variable
+
+This option allows you to define bash variables that will be accessible in your
+script and its subcommands. While it's possible to define variables directly
+within your bash script, this feature provides a structured alternative by
+enabling you to centralize variable definitions in the YAML configuration file.
+
+This approach helps to organize your variables separately from the main script
+logic, improving readability and maintainability. It is important to note that
+using this option is optional, and you can continue to define variables
+directly in your bash script if preferred.
+
+==- :icon-code-review: Show Me How
+```yaml bashly.yml
+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
+```
+===
+
+!!!success Tip 
+Variables defined in the root command are available globally, while those
+defined in subcommands are only accessible within those specific commands.
+!!!
+
+[!button variant="primary" icon="code-review" text="Variables Example"](https://github.com/DannyBen/bashly/tree/master/examples/variables#readme)
+
+## Basic Options
+
+### name
+
+[!badge String]
+[!badge variant="danger" text="Required"]
+
+The name of the variable.
+
+### value
+
+[!badge Any Type]
+
+The variable's value can be a simple type such as a string, number, or boolean,
+or a one-level complex structure like an array or associative array (hash).

src/examples.md

@@ -16,8 +16,8 @@ All examples are listed below for convenience.
 ## Basic use
 
 - [minimal](https://github.com/DannyBen/bashly/tree/master/examples/minimal#readme) - the most basic "hello world" example
-- [commands](https://github.com/DannyBen/bashly/tree/master/examples/commands#readme) - a script with sub-commands
-- [commands-nested](https://github.com/DannyBen/bashly/tree/master/examples/commands-nested#readme) - a script with nested sub-commands
+- [commands](https://github.com/DannyBen/bashly/tree/master/examples/commands#readme) - a script with subcommands
+- [commands-nested](https://github.com/DannyBen/bashly/tree/master/examples/commands-nested#readme) - a script with nested subcommands
 
 ## Basic features
 
@@ -28,6 +28,7 @@ All examples are listed below for convenience.
 - [dependencies](https://github.com/DannyBen/bashly/tree/master/examples/dependencies#readme) - halting script execution unless certain dependencies are installed
 - [dependencies-alt](https://github.com/DannyBen/bashly/tree/master/examples/dependencies-alt#readme) - halting script execution unless one of the required dependencies is installed
 - [environment-variables](https://github.com/DannyBen/bashly/tree/master/examples/environment-variables#readme) - halting script execution unless certain environment variables are set
+- [variables](https://github.com/DannyBen/bashly/tree/master/examples/variables#readme) - defining bash variables
 - [default-values](https://github.com/DannyBen/bashly/tree/master/examples/default-values#readme) - arguments and flags with default values
 - [minus-v](https://github.com/DannyBen/bashly/tree/master/examples/minus-v#readme) - using `-v` and `-h` in your script
 - [multiline](https://github.com/DannyBen/bashly/tree/master/examples/multiline#readme) - help messages with multiple lines
@@ -49,14 +50,14 @@ All examples are listed below for convenience.
 - [private-reveal](https://github.com/DannyBen/bashly/tree/master/examples/private-reveal#readme) - allowing users to reveal private commands, flags or environment variables
 - [stdin](https://github.com/DannyBen/bashly/tree/master/examples/stdin#readme) - reading input from stdin
 - [filters](https://github.com/DannyBen/bashly/tree/master/examples/filters#readme) - preventing commands from running unless custom conditions are met
-- [commands-expose](https://github.com/DannyBen/bashly/tree/master/examples/commands-expose#readme) - showing sub-commands in the parent's help
+- [commands-expose](https://github.com/DannyBen/bashly/tree/master/examples/commands-expose#readme) - showing subcommands in the parent's help
 - [key-value-pairs](https://github.com/DannyBen/bashly/tree/master/examples/key-value-pairs#readme) - parsing key=value arguments and flags
 - [command-examples-on-error](https://github.com/DannyBen/bashly/tree/master/examples/command-examples-on-error#readme) - showing examples on error
 
 ## Customization
 
 - [colors-usage](https://github.com/DannyBen/bashly/tree/master/examples/colors-usage#readme) - adding colors to the usage text
-- [command-groups](https://github.com/DannyBen/bashly/tree/master/examples/command-groups#readme) - grouping sub-commands in logical sections
+- [command-groups](https://github.com/DannyBen/bashly/tree/master/examples/command-groups#readme) - grouping subcommands in logical sections
 - [custom-strings](https://github.com/DannyBen/bashly/tree/master/examples/custom-strings#readme) - configuring the script's error and usage texts
 - [custom-includes](https://github.com/DannyBen/bashly/tree/master/examples/custom-includes#readme) - adding and organizing your custom functions
 - [custom-script-header](https://github.com/DannyBen/bashly/tree/master/examples/custom-script-header#readme) - configuring a different script header
@@ -79,7 +80,7 @@ All examples are listed below for convenience.
 ## Real-world-like examples
 
 - [docker-like](https://github.com/DannyBen/bashly/tree/master/examples/docker-like#readme) - a sample script with deep commands (like `docker container run`)
-- [git-like](https://github.com/DannyBen/bashly/tree/master/examples/git-like#readme) - a sample script with sub-commands similar to git
+- [git-like](https://github.com/DannyBen/bashly/tree/master/examples/git-like#readme) - a sample script with subcommands similar to git
 
 ## Documentation generation
 

src/index.md

@@ -18,7 +18,7 @@ language.
 
 ## How it works
 
-1. You provide a YAML configuration file, describing commands, sub-commands,
+1. You provide a YAML configuration file, describing commands, subcommands,
    arguments, and flags. Running `bashly init` creates an initial sample YAML
    file for you ([example](https://github.com/DannyBen/bashly/tree/master/examples/minimal#bashlyyml)).
 2. Bashly then automatically generates a bash script (when you run
@@ -33,11 +33,11 @@ Bashly is responsible for:
 
 - Generating a **single, standalone bash script**.
 - Generating a **human readable, shellcheck-compliant and shfmt-compliant script**.
-- Generating **usage texts** and help screens, showing your tool's arguments, flags and commands (works for sub-commands also).
+- Generating **usage texts** and help screens, showing your tool's arguments, flags and commands (works for subcommands also).
 - Parsing the user's command line and extracting:
   - Optional or required **positional arguments**.
   - Optional or required **option flags** (with or without flag arguments).
-  - **Commands** (and sub-commands).
+  - **Commands** (and subcommands).
   - Standard flags (like **--help** and **--version**).
 - Preventing your script from running unless the command line is valid.
 - Providing you with a place to input your code for each of the functions your tool performs, and merging it back to the final script.

test/aspell-custom-dict.txt

@@ -43,6 +43,8 @@ img
 ini
 INI
 init
+instagram
+json
 kbgrep
 knowledgebases
 libyaml
@@ -75,6 +77,7 @@ shfmt
 src
 stdin
 subcommand
+subcommands
 sudo
 Suy
 td
@@ -91,6 +94,7 @@ YAML
 yml
 yourcli
 yourscript
+youtube
 ZSH
 Zsh
 zsh