- Fix environment variables caption to not show if all are private

Author: DannyBen

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 true if one of the args is repeatable
       def repeatable_arg_exist?
         args.select(&:repeatable).any?

lib/bashly/views/command/long_usage.gtx

@@ -6,7 +6,7 @@
 = render(:usage_flags).indent 2 if 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/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/fixtures/workspaces/environment-variables-private/.gitignore

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

spec/fixtures/workspaces/environment-variables-private/README.md

@@ -0,0 +1,3 @@
+This fixture tests that there is no group caption if all env vars are private
+
+Reference issue: https://github.com/DannyBen/bashly/issues/331

spec/fixtures/workspaces/environment-variables-private/src/bashly.yml

@@ -0,0 +1,8 @@
+name: cli
+version: 0.1.0
+
+environment_variables:
+  - name: example
+    default: value
+    private: true
+    help: A help message for EXAMPLE

spec/fixtures/workspaces/environment-variables-private/test.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+# This fixture tests that default values for environment variables exist in
+# the initialize function, and that required environment variables are NOT
+# blocking --help.
+# Reference issue: https://github.com/DannyBen/bashly/issues/265
+
+rm -f ./src/*.sh
+rm -f ./cli
+
+bundle exec bashly generate
+
+set -x
+
+./cli --help