Merge pull request #334 from DannyBen/fix/env-var

Fix environment variables

Author: DannyBen

lib/bashly/config_validator.rb

@@ -132,10 +132,6 @@ def assert_env_var(key, value)
       assert_optional_string "#{key}.default", value['default']
       assert_boolean "#{key}.required", value['required']
       assert_boolean "#{key}.private", value['private']
-
-      if value['private']
-        assert value['default'], "#{key}.private makes no sense without default"
-      end
     end
 
     def assert_command(key, value)

lib/bashly/docs/env.yml

@@ -36,7 +36,7 @@ environment_variable.name:
       help: Your API key
 
 environment_variable.private:
-  help: Specify that this environment variable should not be advertised in the usage text. Only makes sense when accompanied by `default`.
+  help: Specify that this environment variable should not be advertised in the usage text.
   url: https://bashly.dannyb.co/configuration/environment-variable/#private
   example: |-
     environment_variables:

lib/bashly/script/command.rb

@@ -217,6 +217,11 @@ def public_commands
         commands.reject(&:private)
       end
 
+      # Returns only environment variables that are not private
+      def public_environment_variables
+        environment_variables.reject(&:private)
+      end
+
       # Returns only flags that are not private
       def public_flags
         flags.reject(&:private)

lib/bashly/views/command/long_usage.gtx

@@ -6,7 +6,7 @@
 = render(:usage_flags).indent 2 if public_flags.any?
 = render(:usage_fixed_flags).indent 2
 = render(:usage_args).indent 2 if args.any? or catch_all.help
-= render(:usage_environment_variables).indent 2 if environment_variables.any?
+= render(:usage_environment_variables).indent 2 if public_environment_variables.any?
 = render(:usage_examples).indent 2 if examples
 = render(:footer).indent 2 if footer
 >

lib/bashly/views/command/usage_environment_variables.gtx

@@ -3,7 +3,7 @@
 > printf "%s\n" "{{ strings[:environment_variables].color(:caption) }}"
 > 
 
-environment_variables.reject(&:private).each do |env_var|
+public_environment_variables.each do |env_var|
   = env_var.render :usage
 end
 

spec/approvals/cli/doc/full

@@ -517,7 +517,7 @@ environment_variable.name
 environment_variable.private
 
   Specify that this environment variable should not be advertised in the usage
-  text. Only makes sense when accompanied by default.
+  text.
 
     environment_variables:
     - name: editor

spec/approvals/fixtures/environment-variables-private

@@ -0,0 +1,20 @@
+creating user files in src
+created src/initialize.sh
+created src/root_command.sh
+created ./cli
+run ./cli --help to test your bash script
++ ./cli --help
+cli
+
+Usage:
+  cli
+  cli --help | -h
+  cli --version | -v
+
+Options:
+  --help, -h
+    Show this help
+
+  --version, -v
+    Show version number
+

spec/approvals/validations/env_var_private_without_default

@@ -147,13 +147,6 @@
     default: development
     private: 1
 
-:env_var_private_without_default:
-  name: invalid
-  help: env_var.private makes no sense without default
-  environment_variables:
-  - name: server_env
-    private: true
-
 :flag_long:
   name: invalid
   help: the long flag is not in the form of --force

spec/fixtures/script/validations.yml

@@ -0,0 +1,2 @@
+cli
+src/*.sh