Provide non-experimental help-hidden flags (#409)

Author: rauhul

Sources/ArgumentParser/Parsing/CommandParser.swift

@@ -76,16 +76,17 @@ extension CommandParser {
   /// Throws a `HelpRequested` error if the user has specified either of the
   /// built in help flags.
   func checkForBuiltInFlags(_ split: SplitArguments) throws {
-    guard !split.contains(Name.long("experimental-help-hidden")) else {
-      throw HelpRequested(visibility: .hidden)
-    }
-
     // Look for help flags
-    guard !split.contains(anyOf: self.commandStack.getHelpNames()) else {
+    guard !split.contains(anyOf: self.commandStack.getHelpNames(visibility: .default)) else {
       throw HelpRequested(visibility: .default)
     }
 
-    // Look for the "dump help" request
+    // Look for help-hidden flags
+    guard !split.contains(anyOf: self.commandStack.getHelpNames(visibility: .hidden)) else {
+      throw HelpRequested(visibility: .hidden)
+    }
+
+    // Look for dump-help flag
     guard !split.contains(Name.long("experimental-dump-help")) else {
       throw CommandError(commandStack: commandStack, parserError: .dumpHelpRequested)
     }

Sources/ArgumentParser/Usage/HelpGenerator.swift

@@ -265,20 +265,34 @@ fileprivate extension CommandConfiguration {
 }
 
 fileprivate extension NameSpecification {
-  func generateHelpNames() -> [Name] {
-    return self.makeNames(InputKey(rawValue: "help")).sorted(by: >)
+  func generateHelpNames(visibility: ArgumentVisibility) -> [Name] {
+    self
+      .makeNames(InputKey(rawValue: "help"))
+      .compactMap { name in
+        guard visibility != .default else { return name }
+        switch name {
+        case .long(let helpName):
+          return .long("\(helpName)-\(visibility)")
+        case .longWithSingleDash(let helpName):
+          return .longWithSingleDash("\(helpName)-\(visibility)")
+        case .short:
+          // Cannot create a non-default help flag from a short name.
+          return nil
+        }
+      }
+      .sorted(by: >)
   }
 }
 
 internal extension BidirectionalCollection where Element == ParsableCommand.Type {
-  func getHelpNames() -> [Name] {
+  func getHelpNames(visibility: ArgumentVisibility) -> [Name] {
     return self.last(where: { $0.configuration.helpNames != nil })
-      .map { $0.configuration.helpNames!.generateHelpNames() }
-      ?? CommandConfiguration.defaultHelpNames.generateHelpNames()
+      .map { $0.configuration.helpNames!.generateHelpNames(visibility: visibility) }
+      ?? CommandConfiguration.defaultHelpNames.generateHelpNames(visibility: visibility)
   }
 
   func getPrimaryHelpName() -> Name? {
-    getHelpNames().preferredName
+    getHelpNames(visibility: .default).preferredName
   }
 
   func versionArgumentDefinition() -> ArgumentDefinition? {
@@ -293,7 +307,7 @@ internal extension BidirectionalCollection where Element == ParsableCommand.Type
   }
 
   func helpArgumentDefinition() -> ArgumentDefinition? {
-    let names = getHelpNames()
+    let names = getHelpNames(visibility: .default)
     guard !names.isEmpty else { return nil }
     return ArgumentDefinition(
       kind: .named(names),

Sources/ArgumentParserTestHelpers/TestHelpers.swift

@@ -144,7 +144,7 @@ public func AssertHelpHidden<T: ParsableArguments>(
   file: StaticString = #file, line: UInt = #line
 ) {
   do {
-    _ = try T.parse(["--experimental-help-hidden"])
+    _ = try T.parse(["--help-hidden"])
     XCTFail(file: (file), line: line)
   } catch {
     let helpString = T.fullMessage(for: error)

Tests/ArgumentParserPackageManagerTests/HelpTests.swift

@@ -193,9 +193,11 @@ struct CustomHelp: ParsableCommand {
 
 extension HelpTests {
   func testCustomHelpNames() {
-    let names = [CustomHelp.self].getHelpNames()
-    XCTAssertEqual(names, [.short("?"), .long("show-help")])
-    
+    let helpNames = [CustomHelp.self].getHelpNames(visibility: .default)
+    XCTAssertEqual(helpNames, [.short("?"), .long("show-help")])
+    let helpHiddenNames = [CustomHelp.self].getHelpNames(visibility: .hidden)
+    XCTAssertEqual(helpHiddenNames, [.long("show-help-hidden")])
+
     AssertFullErrorMessage(CustomHelp.self, ["--error"], """
       Error: Unknown option '--error'
       Usage: custom-help
@@ -214,8 +216,10 @@ struct NoHelp: ParsableCommand {
 
 extension HelpTests {
   func testNoHelpNames() {
-    let names = [NoHelp.self].getHelpNames()
-    XCTAssertEqual(names, [])
+    let helpNames = [NoHelp.self].getHelpNames(visibility: .default)
+    XCTAssertEqual(helpNames, [])
+    let helpHiddenNames = [NoHelp.self].getHelpNames(visibility: .hidden)
+    XCTAssertEqual(helpHiddenNames, [])
 
     AssertFullErrorMessage(NoHelp.self, ["--error"], """
       Error: Missing expected argument '--count <count>'
@@ -257,12 +261,18 @@ struct SubCommandCustomHelp: ParsableCommand {
 
 extension HelpTests {
   func testSubCommandInheritHelpNames() {
-    let names = [SubCommandCustomHelp.self, SubCommandCustomHelp.InheritHelp.self].getHelpNames()
+    let names = [
+      SubCommandCustomHelp.self,
+      SubCommandCustomHelp.InheritHelp.self,
+    ].getHelpNames(visibility: .default)
     XCTAssertEqual(names, [.short("p"), .long("parent-help")])
   }
 
   func testSubCommandCustomHelpNames() {
-    let names = [SubCommandCustomHelp.self, SubCommandCustomHelp.ModifiedHelp.self].getHelpNames()
+    let names = [
+      SubCommandCustomHelp.self,
+      SubCommandCustomHelp.ModifiedHelp.self
+    ].getHelpNames(visibility: .default)
     XCTAssertEqual(names, [.short("s"), .long("subcommand-help")])
   }
 
@@ -271,7 +281,7 @@ extension HelpTests {
       SubCommandCustomHelp.self,
       SubCommandCustomHelp.ModifiedHelp.self,
       SubCommandCustomHelp.ModifiedHelp.InheritImmediateParentdHelp.self
-    ].getHelpNames()
+    ].getHelpNames(visibility: .default)
     XCTAssertEqual(names, [.short("s"), .long("subcommand-help")])
   }
 }