- Add support for private flags

Author: DannyBen

lib/bashly/config_validator.rb

@@ -99,6 +99,7 @@ def assert_flag(key, value)
       assert_optional_string "#{key}.default", value['default']
       assert_optional_string "#{key}.validate", value['validate']
 
+      assert_boolean "#{key}.private", value['private']
       assert_boolean "#{key}.repeatable", value['repeatable']
       assert_boolean "#{key}.required", value['required']
       assert_array "#{key}.allowed", value['allowed'], of: :string

lib/bashly/script/command.rb

@@ -217,6 +217,11 @@ def public_commands
         commands.reject(&:private)
       end
 
+      # Returns only flags that are not private
+      def public_flags
+        flags.reject(&:private)
+      end
+
       # Returns true if one of the args is repeatable
       def repeatable_arg_exist?
         args.select(&:repeatable).any?

lib/bashly/script/flag.rb

@@ -7,7 +7,7 @@ class << self
         def option_keys
           @option_keys ||= %i[
             allowed arg completions conflicts default help long repeatable
-            required short validate
+            required short validate private
           ]
         end
       end

lib/bashly/views/command/long_usage.gtx

@@ -3,7 +3,7 @@
 > if [[ -n $long_usage ]]; then
 >   printf "%s\n" "{{ strings[:options].color(:caption) }}"
 >
-= render(:usage_flags).indent 2 if flags.any?
+= 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?

lib/bashly/views/command/usage_flags.gtx

@@ -1,6 +1,6 @@
 = view_marker
 
-flags.each do |flag|
+public_flags.each do |flag|
   = flag.render :usage
 end
 

spec/approvals/fixtures/flag-private

@@ -0,0 +1,34 @@
++ bundle exec bashly generate
+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
+# this file is located in 'src/root_command.sh'
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[--log]} = 3
++ ./cli --help
+cli
+
+Usage:
+  cli [OPTIONS]
+  cli --help | -h
+  cli --version | -v
+
+Options:
+  --force, -f
+    Overwrite existing files
+
+  --help, -h
+    Show this help
+
+  --version, -v
+    Show version number
+
++ ./cli --log 5
+# this file is located in 'src/root_command.sh'
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[--log]} = 5

spec/fixtures/workspaces/flag-private/.gitignore

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

spec/fixtures/workspaces/flag-private/README.md

@@ -0,0 +1 @@
+Validate private flags

spec/fixtures/workspaces/flag-private/src/bashly.yml

@@ -0,0 +1,12 @@
+name: cli
+
+flags:
+- long: --log
+  short: -l
+  arg: level
+  help: Log level
+  private: true
+  default: '3'
+- long: --force
+  short: -f
+  help: Overwrite existing files

spec/fixtures/workspaces/flag-private/test.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+rm -f ./src/*.sh
+rm -f ./cli
+
+set -x
+
+bundle exec bashly generate
+
+./cli
+./cli --help
+./cli --log 5