Ability to exclude super commands from --help

Author: Miguel Perez

Sources/ArgumentParser/Parsable Types/CommandConfiguration.swift

@@ -47,6 +47,8 @@ public struct CommandConfiguration {
   /// Flag names to be used for help.
   public var helpNames: NameSpecification?
 
+  public var includeSuperCommandInHelp: Bool?
+  
   /// Creates the configuration for a command.
   ///
   /// - Parameters:
@@ -76,7 +78,8 @@ public struct CommandConfiguration {
     shouldDisplay: Bool = true,
     subcommands: [ParsableCommand.Type] = [],
     defaultSubcommand: ParsableCommand.Type? = nil,
-    helpNames: NameSpecification? = nil
+    helpNames: NameSpecification? = nil,
+    includeSuperCommandInHelp: Bool? = nil
   ) {
     self.commandName = commandName
     self.abstract = abstract
@@ -86,6 +89,7 @@ public struct CommandConfiguration {
     self.subcommands = subcommands
     self.defaultSubcommand = defaultSubcommand
     self.helpNames = helpNames
+    self.includeSuperCommandInHelp = includeSuperCommandInHelp
   }
 
   /// Creates the configuration for a command with a "super-command".
@@ -99,7 +103,8 @@ public struct CommandConfiguration {
     shouldDisplay: Bool = true,
     subcommands: [ParsableCommand.Type] = [],
     defaultSubcommand: ParsableCommand.Type? = nil,
-    helpNames: NameSpecification? = nil
+    helpNames: NameSpecification? = nil,
+    includeSuperCommandInHelp: Bool? = nil
   ) {
     self.commandName = commandName
     self._superCommandName = _superCommandName
@@ -110,5 +115,6 @@ public struct CommandConfiguration {
     self.subcommands = subcommands
     self.defaultSubcommand = defaultSubcommand
     self.helpNames = helpNames
+    self.includeSuperCommandInHelp = includeSuperCommandInHelp
   }
 }

Sources/ArgumentParser/Parsable Types/ParsableCommand.swift

@@ -22,6 +22,7 @@ public protocol ParsableCommand: ParsableArguments {
   /// can pass through the wrapped type's name.
   static var _commandName: String { get }
 
+  static var includeSuperCommandInHelp: Bool { get }
   /// Runs this command.
   ///
   /// After implementing this method, you can run your command-line
@@ -41,6 +42,10 @@ extension ParsableCommand {
     CommandConfiguration()
   }
 
+  public static var includeSuperCommandInHelp: Bool {
+    configuration.includeSuperCommandInHelp ?? true
+  }
+    
   public mutating func run() throws {
     throw CleanExit.helpRequest(self)
   }

Sources/ArgumentParser/Usage/HelpGenerator.swift

@@ -144,8 +144,16 @@ internal struct HelpGenerator {
     var optionElements: [Section.Element] = []
     /// Used to keep track of elements already seen from parent commands.
     var alreadySeenElements = Set<Section.Element>()
-
+    
+    var commandsToShowHelp = [ParsableCommand.Type]()
     for commandType in commandStack {
+      // This will remove all super commands in the event that a subcommand does not
+      // want to include their respective help
+      if !commandType.includeSuperCommandInHelp { commandsToShowHelp.removeAll() }
+      commandsToShowHelp.append(commandType)
+    }
+
+    for commandType in commandsToShowHelp {
       let args = Array(ArgumentSet(commandType))
 
       var i = 0