Combine HelpCommand and HelpHiddenCommand (#408)

Author: rauhul

Sources/ArgumentParser/CMakeLists.txt

@@ -34,7 +34,6 @@ add_library(ArgumentParser
 
   Usage/DumpHelpGenerator.swift
   Usage/HelpCommand.swift
-  Usage/HelpHiddenCommand.swift
   Usage/HelpGenerator.swift
   Usage/MessageInfo.swift
   Usage/UsageGenerator.swift

Sources/ArgumentParser/Parsable Types/ParsableArguments.swift

@@ -95,10 +95,8 @@ extension ParsableArguments {
   ) throws -> Self {
     // Parse the command and unwrap the result if necessary.
     switch try self.asCommand.parseAsRoot(arguments) {
-    case is HelpCommand:
-      throw ParserError.helpRequested
-    case is HelpHiddenCommand:
-      throw ParserError.helpHiddenRequested
+    case let helpCommand as HelpCommand:
+      throw ParserError.helpRequested(visibility: helpCommand.visibility)
     case let result as _WrappedParsableCommand<Self>:
       return result.options
     case var result as Self:

Sources/ArgumentParser/Parsing/CommandParser.swift

@@ -14,8 +14,9 @@ struct CommandError: Error {
   var parserError: ParserError
 }
 
-struct HelpRequested: Error {}
-private struct HelpHiddenRequested: Error {}
+struct HelpRequested: Error {
+  var visibility: ArgumentVisibility
+}
 
 struct CommandParser {
   let commandTree: Tree<ParsableCommand.Type>
@@ -76,12 +77,12 @@ extension CommandParser {
   /// built in help flags.
   func checkForBuiltInFlags(_ split: SplitArguments) throws {
     guard !split.contains(Name.long("experimental-help-hidden")) else {
-      throw HelpHiddenRequested()
+      throw HelpRequested(visibility: .hidden)
     }
 
     // Look for help flags
     guard !split.contains(anyOf: self.commandStack.getHelpNames()) else {
-      throw HelpRequested()
+      throw HelpRequested(visibility: .default)
     }
 
     // Look for the "dump help" request
@@ -233,20 +234,16 @@ extension CommandParser {
         try helpResult.buildCommandStack(with: self)
         return .success(helpResult)
       }
-      if var helpResult = result as? HelpHiddenCommand {
-        try helpResult.buildCommandStack(with: self)
-        return .success(helpResult)
-      }
       return .success(result)
     } catch let error as CommandError {
       return .failure(error)
     } catch let error as ParserError {
       let error = arguments.isEmpty ? ParserError.noArguments(error) : error
       return .failure(CommandError(commandStack: commandStack, parserError: error))
-    } catch is HelpRequested {
-      return .success(HelpCommand(commandStack: commandStack))
-    } catch is HelpHiddenRequested {
-      return .success(HelpHiddenCommand(commandStack: commandStack))
+    } catch let helpRequest as HelpRequested {
+      return .success(HelpCommand(
+        commandStack: commandStack,
+        visibility: helpRequest.visibility))
     } catch {
       return .failure(CommandError(commandStack: commandStack, parserError: .invalidState))
     }

Sources/ArgumentParser/Parsing/ParserError.swift

@@ -11,8 +11,7 @@
 
 /// Gets thrown while parsing and will be handled by the error output generation.
 enum ParserError: Error {
-  case helpRequested
-  case helpHiddenRequested
+  case helpRequested(visibility: ArgumentVisibility)
   case versionRequested
   case dumpHelpRequested
 

Sources/ArgumentParser/Usage/HelpCommand.swift

@@ -23,11 +23,14 @@ struct HelpCommand: ParsableCommand {
   var help = false
 
   private(set) var commandStack: [ParsableCommand.Type] = []
-  
+  private(set) var visibility: ArgumentVisibility = .default
+
   init() {}
 
   mutating func run() throws {
-    throw CommandError(commandStack: commandStack, parserError: .helpRequested)
+    throw CommandError(
+      commandStack: commandStack,
+      parserError: .helpRequested(visibility: visibility))
   }
 
   mutating func buildCommandStack(with parser: CommandParser) throws {
@@ -50,8 +53,9 @@ struct HelpCommand: ParsableCommand {
     self.help = try container.decode(Bool.self, forKey: .help)
   }
 
-  init(commandStack: [ParsableCommand.Type]) {
+  init(commandStack: [ParsableCommand.Type], visibility: ArgumentVisibility) {
     self.commandStack = commandStack
+    self.visibility = visibility
     self.subcommands = commandStack.map { $0._commandName }
     self.help = false
   }

Sources/ArgumentParser/Usage/HelpHiddenCommand.swift

@@ -27,12 +27,8 @@ enum MessageInfo {
 
       // Exit early on built-in requests
       switch e.parserError {
-      case .helpRequested:
-        self = .help(text: HelpGenerator(commandStack: e.commandStack).rendered())
-        return
-
-      case .helpHiddenRequested:
-        self = .help(text: HelpGenerator(commandStack: e.commandStack, includeHidden: true).rendered())
+      case .helpRequested(let visibility):
+        self = .help(text: HelpGenerator(commandStack: e.commandStack, includeHidden: visibility != .default).rendered())
         return
 
       case .dumpHelpRequested:

Sources/ArgumentParser/Usage/MessageInfo.swift

@@ -161,7 +161,7 @@ struct ErrorMessageGenerator {
 extension ErrorMessageGenerator {
   func makeErrorMessage() -> String? {
     switch error {
-    case .helpRequested, .helpHiddenRequested, .versionRequested, .completionScriptRequested, .completionScriptCustomResponse, .dumpHelpRequested:
+    case .helpRequested, .versionRequested, .completionScriptRequested, .completionScriptCustomResponse, .dumpHelpRequested:
       return nil
 
     case .unsupportedShell(let shell?):