- Update validations example to show environment variable validation

Author: DannyBen

examples/README.md

@@ -61,7 +61,7 @@ Each of these examples demonstrates one aspect or feature of bashly.
 - [yaml](yaml#readme) - using the YAML reading functions
 - [colors](colors#readme) - using the color print feature
 - [completions](completions#readme) - adding bash completion functionality
-- [validations](validations#readme) - adding argument validation functions
+- [validations](validations#readme) - adding validation functions for arguments, flags or environment variables
 - [hooks](hooks#readme) - adding before/after hooks
 
 ## Real-world-like examples

examples/needs/README.md

@@ -83,15 +83,15 @@ Options:
 ### `$ ./cli --add deploy`
 
 ````shell
---add requires --command
+--add needs --command
 
 
 ````
 
 ### `$ ./cli --add deploy --command 'git push'`
 
 ````shell
---add requires --target
+--add needs --target
 
 
 ````

examples/validations/README.md

@@ -50,6 +50,15 @@ commands:
 
     # Validations also work on flags (when they have arguments)
     validate: file_exists
+
+- name: build
+  environment_variables:
+  - name: build_dir
+    help: Path to the build directory
+    default: release
+
+    # Validations also work on environment variables
+    validate: dir_exists
 ````
 
 
@@ -97,5 +106,28 @@ must be an existing file
 
 ````
 
+### `$ ./validate build`
+
+````shell
+validation error in environment variable BUILD_DIR:
+must be an existing directory
+
+
+````
+
+### `$ BUILD_DIR=src ./validate build`
+
+````shell
+# this file is located in 'src/build_command.sh'
+# code for 'validate build' goes here
+# you can edit it freely and regenerate (it will not be overwritten)
+args: none
+
+environment variables:
+- $BUILD_DIR = src
+
+
+````
+
 
 

examples/validations/src/bashly.yml

@@ -27,3 +27,11 @@ commands:
     # Validations also work on flags (when they have arguments)
     validate: file_exists
 
+- name: build
+  environment_variables:
+  - name: build_dir
+    help: Path to the build directory
+    default: release
+
+    # Validations also work on environment variables
+    validate: dir_exists

examples/validations/src/build_command.sh

@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/build_command.sh'"
+echo "# code for 'validate build' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args

examples/validations/test.sh

@@ -14,3 +14,6 @@ bashly generate
 ./validate calc A
 ./validate calc 1 B
 ./validate calc 1 2 --save no-such-file.txt
+
+./validate build
+BUILD_DIR=src ./validate build

spec/approvals/examples/validations

@@ -6,6 +6,7 @@ created src/lib/validations/validate_not_empty.sh
 + bashly generate
 creating user files in src
 created src/calc_command.sh
+created src/build_command.sh
 created ./validate
 run ./validate --help to test your bash script
 + ./validate calc 1 2 --save README.md
@@ -25,3 +26,15 @@ must be an integer
 + ./validate calc 1 2 --save no-such-file.txt
 validation error in --save PATH:
 must be an existing file
++ ./validate build
+validation error in environment variable BUILD_DIR:
+must be an existing directory
++ BUILD_DIR=src
++ ./validate build
+# this file is located in 'src/build_command.sh'
+# code for 'validate build' goes here
+# you can edit it freely and regenerate (it will not be overwritten)
+args: none
+
+environment variables:
+- $BUILD_DIR = src