- Add command.deep_help option

Author: DannyBen

lib/bashly/concerns/command_scopes.rb

@@ -70,6 +70,39 @@ def required_flags
       flags.select &:required
     end
 
+    # Returns a data structure for displaying subcommands help
+    def commands_help_data
+      group_string = strings[:commands]
+      result = {}
+
+      commands.reject(&:private).each do |command|
+        summary = if command.default
+          strings[:default_command_summary] % { summary: command.summary } 
+        else
+          command.summary
+        end
+        
+        group_string = strings[:group] % { group: command.group } if command.group
+
+        result[group_string] ||= {}
+        result[group_string][command.name] = summary
+
+        if command.deep_help
+          command.commands.reject(&:private).each do |subcommand|
+            sub_summary = if subcommand.default
+              strings[:default_command_summary] % { summary: subcommand.summary } 
+            else
+              subcommand.summary
+            end
+            
+            result[group_string]["#{command.name} #{subcommand.name}"] = sub_summary
+          end
+        end
+      end
+
+      result
+    end
+
     # Returns an array of all the args with a whitelist
     def whitelisted_args
       args.select &:allowed

lib/bashly/script/command.rb

@@ -8,7 +8,7 @@ class << self
         def option_keys
           @option_keys ||= %i[
             alias args catch_all commands completions
-            default dependencies environment_variables examples
+            deep_help default dependencies environment_variables examples
             extensible filename filters flags
             footer group help name
             private version

lib/bashly/views/command/usage_commands.erb

@@ -1,18 +1,9 @@
 <%= view_marker %>
-% unless commands.first.group
-printf "<%= strings[:commands] %>\n"
-% end
-% maxlen = command_names.map(&:size).max
-% commands.reject(&:private).each do |command|
-% summary = command.summary
-% summary = strings[:default_command_summary] % { summary: summary } if command.default
-% if command.group
-% if command.name == commands.first.name
-printf "<%= strings[:group] % { group: command.group } %>\n"
-% else
-printf "\n<%= strings[:group] % { group: command.group } %>\n"
-% end
-% end
-echo "  <%= command.name.ljust maxlen %>   <%= summary %>"
+% maxlen = commands_help_data.values.map(&:keys).flatten.map(&:size).max
+% commands_help_data.each do |group, commands|
+printf "<%= group %>\n"
+% commands.each do |command, summary|
+echo "  <%= command.ljust maxlen %>   <%= summary %>"
 % end
 echo
+% end

spec/approvals/examples/command-private

@@ -15,7 +15,7 @@ Usage:
   cli --version | -v
 
 Commands:
-  connect       Connect to the metaverse
+  connect   Connect to the metaverse
 
 + ./cli -h
 cli - Sample application with private commands
@@ -26,7 +26,7 @@ Usage:
   cli --version | -v
 
 Commands:
-  connect       Connect to the metaverse
+  connect   Connect to the metaverse
 
 Options:
   --help, -h