improve env var example

Author: DannyBen

examples/environment-variables/README.md

@@ -11,29 +11,30 @@ name: cli
 help: Sample application that requires environment variables
 version: 0.1.0
 
-# These two variable options add usage text to the help message in the
-# generated script.
-# In addition, the value of the variable `ENVIRONMENT` will be set to
-# `development` if it is not already set by the user.
+# This option adds usage text to the help message in the generated script.
 environment_variables:
 - name: api_key
   help: Set your API key
-- name: environment
-  help: One of development, production or test
-  default: development
 
 commands:
 - name: verify
   short: v
   help: Verify your user
 
   # This option belongs to the `verify` command and will appear in its help
-  # message. In addition, setting `required: true` will halt the script's 
-  # execution with a friendly error message, unless the variable is set.
+  # message.
   environment_variables:
+  # Setting `required: true` will halt the script's execution with a
+  # friendly error message, unless the variable is set.
   - name: my_secret
     help: Your secret
     required: true
+  
+  # Using the `default: value` option will cause the value to variable to be 
+  # set if it is not provided by the user.
+  - name: environment
+    help: One of development, production or test
+    default: development
 ```
 
 ## Generated script output
@@ -79,10 +80,6 @@ Environment Variables:
   API_KEY
     Set your API key
 
-  ENVIRONMENT
-    One of development, production or test
-    Default: development
-
 
 
 ```
@@ -106,6 +103,10 @@ Environment Variables:
   MY_SECRET (required)
     Your secret
 
+  ENVIRONMENT
+    One of development, production or test
+    Default: development
+
 
 
 ```
@@ -133,10 +134,17 @@ environment:
 
 ```
 
-### `$ ENVIRONMENT=production ./cli verify`
+### `$ ENVIRONMENT=production MY_SECRET=safe-with-me ./cli verify`
 
 ```shell
-missing required environment variable: MY_SECRET
+# this file is located in 'src/verify_command.sh'
+# code for 'cli verify' goes here
+# you can edit it freely and regenerate (it will not be overwritten)
+args: none
+environment:
+- API_KEY=
+- ENVIRONMENT=production
+- MY_SECRET=safe-with-me
 
 
 ```

examples/environment-variables/cli

@@ -44,12 +44,6 @@ cli_usage() {
     echo "  API_KEY"
     printf "    Set your API key\n"
     echo
-    
-    # :environment_variable.usage
-    echo "  ENVIRONMENT"
-    printf "    One of development, production or test\n"
-    printf "    Default: development\n"
-    echo
 
   fi
 }
@@ -86,6 +80,12 @@ cli_verify_usage() {
     echo "  MY_SECRET (required)"
     printf "    Your secret\n"
     echo
+    
+    # :environment_variable.usage
+    echo "  ENVIRONMENT"
+    printf "    One of development, production or test\n"
+    printf "    Default: development\n"
+    echo
 
   fi
 }
@@ -142,7 +142,6 @@ parse_requirements() {
 
   esac
   # :command.environment_variables_filter
-  export ENVIRONMENT="${ENVIRONMENT:-development}"
   # :command.dependencies_filter
   # :command.command_filter
   action=$1
@@ -206,6 +205,7 @@ cli_verify_parse_requirements() {
 
   esac
   # :command.environment_variables_filter
+  export ENVIRONMENT="${ENVIRONMENT:-development}"
   if [[ -z "$MY_SECRET" ]]; then
     printf "missing required environment variable: MY_SECRET\n"
     exit 1

examples/environment-variables/src/bashly.yml

@@ -2,26 +2,27 @@ name: cli
 help: Sample application that requires environment variables
 version: 0.1.0
 
-# These two variable options add usage text to the help message in the
-# generated script.
-# In addition, the value of the variable `ENVIRONMENT` will be set to
-# `development` if it is not already set by the user.
+# This option adds usage text to the help message in the generated script.
 environment_variables:
 - name: api_key
   help: Set your API key
-- name: environment
-  help: One of development, production or test
-  default: development
 
 commands:
 - name: verify
   short: v
   help: Verify your user
 
   # This option belongs to the `verify` command and will appear in its help
-  # message. In addition, setting `required: true` will halt the script's 
-  # execution with a friendly error message, unless the variable is set.
+  # message.
   environment_variables:
+  # Setting `required: true` will halt the script's execution with a
+  # friendly error message, unless the variable is set.
   - name: my_secret
     help: Your secret
     required: true
+  
+  # Using the `default: value` option will cause the value to variable to be 
+  # set if it is not provided by the user.
+  - name: environment
+    help: One of development, production or test
+    default: development

examples/environment-variables/test.sh

@@ -11,4 +11,4 @@ bashly generate
 ./cli verify -h
 ./cli verify
 MY_SECRET="there is no spoon" ./cli verify
-ENVIRONMENT=production ./cli verify
+ENVIRONMENT=production MY_SECRET=safe-with-me ./cli verify

spec/approvals/examples/environment-variables

@@ -37,10 +37,6 @@ Environment Variables:
   API_KEY
     Set your API key
 
-  ENVIRONMENT
-    One of development, production or test
-    Default: development
-
 + ./cli verify -h
 cli verify - Verify your user
 
@@ -58,6 +54,10 @@ Environment Variables:
   MY_SECRET (required)
     Your secret
 
+  ENVIRONMENT
+    One of development, production or test
+    Default: development
+
 + ./cli verify
 missing required environment variable: MY_SECRET
 + MY_SECRET='there is no spoon'
@@ -71,5 +71,13 @@ environment:
 - ENVIRONMENT=development
 - MY_SECRET=there is no spoon
 + ENVIRONMENT=production
++ MY_SECRET=safe-with-me
 + ./cli verify
-missing required environment variable: MY_SECRET
+# this file is located in 'src/verify_command.sh'
+# code for 'cli verify' goes here
+# you can edit it freely and regenerate (it will not be overwritten)
+args: none
+environment:
+- API_KEY=
+- ENVIRONMENT=production
+- MY_SECRET=safe-with-me