Merge branch 'main' into async

Author: rauhul

Sources/ArgumentParser/Completions/BashCompletionsGenerator.swift

@@ -180,7 +180,7 @@ struct BashCompletionsGenerator {
 extension ArgumentDefinition {
   /// Returns the different completion names for this argument.
   fileprivate func bashCompletionWords() -> [String] {
-    return help.visibility == .default
+    return help.visibility.base == .default
       ? names.map { $0.synopsisString }
       : []
   }

Sources/ArgumentParser/Completions/FishCompletionsGenerator.swift

@@ -100,7 +100,7 @@ extension Name {
 
 extension ArgumentDefinition {
   fileprivate func argumentSegments(_ commandChain: [String]) -> [([String], String)] {
-    guard help.visibility == .default else { return [] }
+    guard help.visibility.base == .default else { return [] }
 
     var results = [([String], String)]()
     var formattedFlags = [String]()

Sources/ArgumentParser/Completions/ZshCompletionsGenerator.swift

@@ -134,7 +134,7 @@ extension ArgumentDefinition {
   }
 
   func zshCompletionString(_ commands: [ParsableCommand.Type]) -> String? {
-    guard help.visibility == .default else { return nil }
+    guard help.visibility.base == .default else { return nil }
 
     var inputs: String
     switch update {

Sources/ArgumentParser/Parsable Properties/ArgumentHelp.swift

@@ -33,7 +33,7 @@ public struct ArgumentHelp {
   @available(*, deprecated, message: "Use visibility level instead.")
   public var shouldDisplay: Bool {
     get {
-      return visibility == .default
+      return visibility.base == .default
     }
     set {
       visibility = newValue ? .default : .hidden

Sources/ArgumentParser/Parsable Properties/ArgumentVisibility.swift

@@ -10,25 +10,35 @@
 //===----------------------------------------------------------------------===//
 
 /// Visibility level of an argument's help.
-public enum ArgumentVisibility {
-    /// Show help for this argument whenever appropriate.
+public struct ArgumentVisibility {
+  /// Internal implementation of `ArgumentVisibility` to allow for easier API
+  /// evolution.
+  internal enum Representation {
     case `default`
-
-    /// Only show help for this argument in the extended help screen.
     case hidden
-
-    /// Never show help for this argument.
     case `private`
+  }
+
+  internal var base: Representation
+
+  /// Show help for this argument whenever appropriate.
+  public static let `default` = Self(base: .default)
+
+  /// Only show help for this argument in the extended help screen.
+  public static let hidden = Self(base: .hidden)
+
+  /// Never show help for this argument.
+  public static let `private` = Self(base: .private)
 }
 
-extension ArgumentVisibility {
+extension ArgumentVisibility.Representation {
   /// A raw Integer value that represents each visibility level.
   ///
   /// `_comparableLevel` can be used to test if a Visibility case is more or
   /// less visible than another, without committing this behavior to API.
   /// A lower `_comparableLevel` indicates that the case is less visible (more
   /// secret).
-  private var _comparableLevel: Int {
+  internal var _comparableLevel: Int {
     switch self {
     case .default:
       return 2
@@ -38,9 +48,11 @@ extension ArgumentVisibility {
       return 0
     }
   }
+}
 
+extension ArgumentVisibility {
   /// - Returns: true if `self` is at least as visible as the supplied argument.
-  func isAtLeastAsVisible(as other: Self) -> Bool {
-    self._comparableLevel >= other._comparableLevel
+  internal func isAtLeastAsVisible(as other: Self) -> Bool {
+    self.base._comparableLevel >= other.base._comparableLevel
   }
 }

Sources/ArgumentParser/Parsable Types/ParsableArguments.swift

@@ -270,7 +270,6 @@ extension ArgumentSetProvider {
 
 extension ArgumentSet {
   init(_ type: ParsableArguments.Type, visibility: ArgumentVisibility) {
-    
     #if DEBUG
     do {
       try type._validate()
@@ -286,7 +285,7 @@ extension ArgumentSet {
 
         if let parsed = child.value as? ArgumentSetProvider {
           guard parsed._visibility.isAtLeastAsVisible(as: visibility)
-          else { return nil }
+            else { return nil }
 
           // Property wrappers have underscore-prefixed names
           codingKey = String(codingKey.first == "_"
@@ -296,17 +295,12 @@ extension ArgumentSet {
           return parsed.argumentSet(for: key)
         } else {
           // Save a non-wrapped property as is
-          var definition = ArgumentDefinition(
-            key: InputKey(rawValue: codingKey),
-            kind: .default,
-            parser: { _ in nil },
-            default: nilOrValue(child.value),
-            completion: .default)
-          definition.help.updateArgumentHelp(help: .hidden)
-          return ArgumentSet(definition)
+          return ArgumentSet(
+            ArgumentDefinition(unparsedKey: codingKey, default: nilOrValue(child.value)))
         }
       }
-    self.init(sets: a)
+    self.init(
+      a.joined().filter { $0.help.visibility.isAtLeastAsVisible(as: visibility) })
   }
 }
 

Sources/ArgumentParser/Parsing/ArgumentSet.swift

@@ -190,6 +190,23 @@ extension ArgumentDefinition {
   }
 }
 
+extension ArgumentDefinition {
+  /// Creates an argument definition for a property that isn't parsed from the
+  /// command line.
+  ///
+  /// This initializer is used for any property defined on a `ParsableArguments`
+  /// type that isn't decorated with one of ArgumentParser's property wrappers.
+  init(unparsedKey: String, default defaultValue: Any?) {
+    self.init(
+      key: InputKey(rawValue: unparsedKey),
+      kind: .default,
+      parser: { _ in nil },
+      default: defaultValue,
+      completion: .default)
+    help.updateArgumentHelp(help: .private)
+  }
+}
+
 // MARK: - Parsing from SplitArguments
 extension ArgumentSet {
   /// Parse the given input for this set of defined arguments.

Sources/ArgumentParser/Usage/DumpHelpGenerator.swift

@@ -125,7 +125,7 @@ fileprivate extension ArgumentInfoV0 {
     guard let kind = ArgumentInfoV0.KindV0(argument: argument) else { return nil }
     self.init(
       kind: kind,
-      shouldDisplay: argument.help.visibility == .default,
+      shouldDisplay: argument.help.visibility.base == .default,
       isOptional: argument.help.options.contains(.isOptional),
       isRepeating: argument.help.options.contains(.isRepeating),
       names: argument.names.map(ArgumentInfoV0.NameInfoV0.init),

Sources/ArgumentParser/Usage/HelpGenerator.swift

@@ -106,7 +106,8 @@ internal struct HelpGenerator {
     if let usage = currentCommand.configuration.usage {
       self.usage = usage
     } else {
-      var usage = UsageGenerator(toolName: toolName, definition: [currentArgSet]).synopsis
+      var usage = UsageGenerator(toolName: toolName, definition: [currentArgSet])
+        .synopsis
       if !currentCommand.configuration.subcommands.isEmpty {
         if usage.last != " " { usage += " " }
         usage += "<subcommand>"
@@ -140,7 +141,7 @@ internal struct HelpGenerator {
     /// more elements at a time.
     var args = commandStack.argumentsForHelp(visibility: visibility)[...]
     while let arg = args.popFirst() {
-      guard arg.help.visibility == .default else { continue }
+      assert(arg.help.visibility.isAtLeastAsVisible(as: visibility))
 
       let synopsis: String
       let description: String
@@ -154,7 +155,6 @@ internal struct HelpGenerator {
 
         synopsis = groupedArgs
           .lazy
-          .filter { $0.help.visibility == .default }
           .map { $0.synopsisForHelp }
           .joined(separator: "/")
 
@@ -172,9 +172,7 @@ internal struct HelpGenerator {
           .filter { !$0.isEmpty }
           .joined(separator: " ")
       } else {
-        synopsis = arg.help.visibility == .default
-          ? arg.synopsisForHelp
-          : ""
+        synopsis = arg.synopsisForHelp
 
         let defaultValue = arg.help.defaultValue.flatMap { $0.isEmpty ? nil : "(default: \($0))" }
         description = [arg.help.abstract, defaultValue]
@@ -275,10 +273,10 @@ fileprivate extension NameSpecification {
     self
       .makeNames(InputKey(rawValue: "help"))
       .compactMap { name in
-        guard visibility != .default else { return name }
+        guard visibility.base != .default else { return name }
         switch name {
         case .long(let helpName):
-          return .long("\(helpName)-\(visibility)")
+          return .long("\(helpName)-\(visibility.base)")
         case .longWithSingleDash(let helpName):
           return .longWithSingleDash("\(helpName)-\(visibility)")
         case .short:

Sources/ArgumentParser/Usage/UsageGenerator.swift

@@ -22,10 +22,10 @@ extension UsageGenerator {
     self.init(toolName: toolName, definition: definition)
   }
 
-  init(toolName: String, parsable: ParsableArguments) {
+  init(toolName: String, parsable: ParsableArguments, visibility: ArgumentVisibility) {
     self.init(
       toolName: toolName,
-      definition: ArgumentSet(type(of: parsable), visibility: .default))
+      definition: ArgumentSet(type(of: parsable), visibility: visibility))
   }
 
   init(toolName: String, definition: [ArgumentSet]) {
@@ -38,9 +38,7 @@ extension UsageGenerator {
   ///
   /// In `roff`.
   var synopsis: String {
-    // Filter out options that should not be displayed.
-    var options = definition
-      .filter { $0.help.visibility == .default }
+    var options = Array(definition)
     switch options.count {
     case 0:
       return toolName
@@ -346,7 +344,7 @@ extension ErrorMessageGenerator {
   func noValueMessage(key: InputKey) -> String? {
     let args = arguments(for: key)
     let possibilities: [String] = args.compactMap {
-      $0.help.visibility == .default
+      $0.help.visibility.base == .default
         ? $0.nonOptional.synopsis
         : nil
     }

Sources/ArgumentParserTestHelpers/TestHelpers.swift

@@ -122,7 +122,7 @@ public func AssertHelp<T: ParsableArguments>(
   let flag: String
   let includeHidden: Bool
 
-  switch visibility {
+  switch visibility.base {
   case .default:
     flag = "--help"
     includeHidden = false
@@ -158,7 +158,7 @@ public func AssertHelp<T: ParsableCommand, U: ParsableCommand>(
 ) {
   let includeHidden: Bool
 
-  switch visibility {
+  switch visibility.base {
   case .default:
     includeHidden = false
   case .hidden:

Tests/ArgumentParserUnitTests/HelpGenerationTests.swift

@@ -72,11 +72,6 @@ extension HelpGenerationTests {
 
             """)
 
-#if !os(Linux)
-    XCTExpectFailure("""
-            The following test fails to properly generate the help-hidden
-            message properly because help-hidden is not fully supported yet.
-            """)
     AssertHelp(.hidden, for: B.self, equals: """
             USAGE: b --name <name> [--title <title>] [<hidden-name>] [--hidden-title <hidden-title>] [--hidden-flag] [--hidden-inverted-flag] [--no-hidden-inverted-flag]
 
@@ -93,7 +88,6 @@ extension HelpGenerationTests {
               -h, --help              Show help information.
 
             """)
-#endif
   }
 
   struct C: ParsableArguments {