- Add support for global command flags

Author: DannyBen

lib/bashly/config_validator.rb

@@ -112,7 +112,7 @@ def assert_command(key, value)
       assert_hash key, value, Script::Command.option_keys
 
       refute value['commands'] && value['args'], "#{key} cannot have both commands and args"
-      refute value['commands'] && value['flags'], "#{key} cannot have both commands and flags"
+      # refute value['commands'] && value['flags'], "#{key} cannot have both commands and flags"
 
       assert_string "#{key}.name", value['name']
       assert_optional_string "#{key}.help", value['help']

lib/bashly/script/command.rb

@@ -177,6 +177,12 @@ def full_name
         parents.any? ? (parents + [name]).join(' ') : name
       end
 
+      # Returns true if this command's flags should be considered as gloal
+      # flags, and cascade to subcommands
+      def global_flags?
+        flags.any? and commands.any?
+      end
+
       # Returns the string for the group caption
       def group_string
         if group
@@ -239,11 +245,12 @@ def summary_string
       # Returns a constructed string suitable for Usage pattern
       def usage_string
         result = [full_name]
-        result << "[command]" if commands.any?
+        result << "[OPTIONS]" if global_flags?
+        result << "COMMAND" if commands.any?
         args.each do |arg|
           result << arg.usage_string
         end
-        result << "[options]" unless flags.empty?
+        result << "[OPTIONS]" unless flags.empty? || global_flags?
         result << catch_all.usage_string if catch_all.enabled?
         result.join " "
       end

lib/bashly/views/command/fixed_flags_filter.gtx

@@ -16,5 +16,12 @@ end
 >   exit
 >   ;;
 > 
+
+if global_flags?
+  flags.each do |flag|
+    = flag.render(:case)
+  end
+end
+
 > esac
 >

lib/bashly/views/command/parse_requirements_while.gtx

@@ -4,8 +4,10 @@
 >   key="$1"
 >   case "$key" in
 
-flags.each do |flag|
-  = flag.render(:case).indent 2
+unless global_flags?
+  flags.each do |flag|
+    = flag.render(:case).indent 2
+  end
 end
 
 >

lib/bashly/views/command/usage.gtx

@@ -29,7 +29,7 @@ end
 >   printf "  {{ usage_string }}\n"
 
 if commands.any?
-  >   printf "  {{ full_name }} [command] --help{{ " | -h" unless short_flag_exist? "-h" }}\n"
+  >   printf "  {{ full_name }} [COMMAND] --help{{ " | -h" unless short_flag_exist? "-h" }}\n"
 else
   >   printf "  {{ full_name }} --help{{ " | -h" unless short_flag_exist? "-h" }}\n"
 end

spec/approvals/examples/catch-all-advanced

@@ -9,8 +9,8 @@ run ./cli --help to test your bash script
 cli - Sample application
 
 Usage:
-  cli [command]
-  cli [command] --help | -h
+  cli COMMAND
+  cli [COMMAND] --help | -h
   cli --version | -v
 
 Commands:
@@ -23,7 +23,7 @@ cli download - Download a file
 Alias: d
 
 Usage:
-  cli download SOURCE [TARGET] [options] [AWS PARAMS...]
+  cli download SOURCE [TARGET] [OPTIONS] [AWS PARAMS...]
   cli download --help | -h
 
 Options:

spec/approvals/examples/catch-all-stdin

@@ -6,7 +6,7 @@ run ./cli --help to test your bash script
 cli - Sample application
 
 Usage:
-  cli [options] [FILE...]
+  cli [OPTIONS] [FILE...]
   cli --help | -h
   cli --version | -v
 

spec/approvals/examples/command-aliases

@@ -9,8 +9,8 @@ run ./cli --help to test your bash script
 cli - Sample application
 
 Usage:
-  cli [command]
-  cli [command] --help | -h
+  cli COMMAND
+  cli [COMMAND] --help | -h
   cli --version | -v
 
 Commands:
@@ -21,8 +21,8 @@ Commands:
 cli - Sample application
 
 Usage:
-  cli [command]
-  cli [command] --help | -h
+  cli COMMAND
+  cli [COMMAND] --help | -h
   cli --version | -v
 
 Commands:

spec/approvals/examples/command-default

@@ -9,8 +9,8 @@ run ./ftp --help to test your bash script
 ftp - Sample application that uses the default command option
 
 Usage:
-  ftp [command]
-  ftp [command] --help | -h
+  ftp COMMAND
+  ftp [COMMAND] --help | -h
   ftp --version | -v
 
 Commands:
@@ -21,8 +21,8 @@ Commands:
 ftp - Sample application that uses the default command option
 
 Usage:
-  ftp [command]
-  ftp [command] --help | -h
+  ftp COMMAND
+  ftp [COMMAND] --help | -h
   ftp --version | -v
 
 Commands:

spec/approvals/examples/command-filenames

@@ -11,8 +11,8 @@ run ./cli --help to test your bash script
 cli - Demonstrate custom command filenames
 
 Usage:
-  cli [command]
-  cli [command] --help | -h
+  cli COMMAND
+  cli [COMMAND] --help | -h
   cli --version | -v
 
 Commands:
@@ -23,8 +23,8 @@ Commands:
 cli - Demonstrate custom command filenames
 
 Usage:
-  cli [command]
-  cli [command] --help | -h
+  cli COMMAND
+  cli [COMMAND] --help | -h
   cli --version | -v
 
 Commands: