Hide optional flags when a command has too many options (#416)

The usage string feature that only shows positional args and required options/flags was incorrectly allowing through flags with type `Bool?`.
apple · Mar 8, 2022 · c959b3a · c959b3a
1 parent b3a9c24
commit c959b3a
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 5 deletions.
diff --git a/Sources/ArgumentParser/Parsable Properties/Flag.swift b/Sources/ArgumentParser/Parsable Properties/Flag.swift
@@ -209,7 +209,14 @@ extension Flag where Value == Optional<Bool> {
     help: ArgumentHelp? = nil
   ) {
     self.init(_parsedValue: .init { key in
-      .flag(key: key, name: name, default: nil, inversion: inversion, exclusivity: exclusivity, help: help)
+      .flag(
+        key: key,
+        name: name,
+        default: nil,
+        required: false,
+        inversion: inversion,
+        exclusivity: exclusivity,
+        help: help)
     })
   }
 }
@@ -257,7 +264,14 @@ extension Flag where Value == Bool {
     help: ArgumentHelp?
   ) {
     self.init(_parsedValue: .init { key in
-      .flag(key: key, name: name, default: initial, inversion: inversion, exclusivity: exclusivity, help: help)
+      .flag(
+        key: key,
+        name: name,
+        default: initial,
+        required: initial == nil,
+        inversion: inversion,
+        exclusivity: exclusivity,
+        help: help)
       })
   }
 

diff --git a/Sources/ArgumentParser/Parsing/ArgumentSet.swift b/Sources/ArgumentParser/Parsing/ArgumentSet.swift
@@ -106,9 +106,16 @@ extension ArgumentSet {
   }
 
   /// Creates an argument set for a pair of inverted Boolean flags.
-  static func flag(key: InputKey, name: NameSpecification, default initialValue: Bool?, inversion: FlagInversion, exclusivity: FlagExclusivity, help: ArgumentHelp?) -> ArgumentSet {
-    // The flag is required if initialValue is `nil`, otherwise it's optional
-    let helpOptions: ArgumentDefinition.Help.Options = initialValue != nil ? .isOptional : []
+  static func flag(
+    key: InputKey,
+    name: NameSpecification,
+    default initialValue: Bool?,
+    required: Bool,
+    inversion: FlagInversion,
+    exclusivity: FlagExclusivity,
+    help: ArgumentHelp?) -> ArgumentSet
+  {
+    let helpOptions: ArgumentDefinition.Help.Options = required ? [] : .isOptional
 
     let enableHelp = ArgumentDefinition.Help(options: helpOptions, help: help, defaultValue: initialValue.map(String.init), key: key, isComposite: true)
     let disableHelp = ArgumentDefinition.Help(options: [.isOptional], help: help, key: key)

diff --git a/Tests/ArgumentParserUnitTests/UsageGenerationTests.swift b/Tests/ArgumentParserUnitTests/UsageGenerationTests.swift
@@ -175,6 +175,10 @@ extension UsageGenerationTests {
   }
 
   struct M: ParsableArguments {
+    enum Color: String, EnumerableFlag {
+      case green, blue, yellow
+    }
+
     @Flag var a: Bool = false
     @Flag var b: Bool = false
     @Flag var c: Bool = false
@@ -187,6 +191,12 @@ extension UsageGenerationTests {
     @Flag var j: Bool = false
     @Flag var k: Bool = false
     @Flag var l: Bool = false
+
+    @Flag(inversion: .prefixedEnableDisable)
+    var optionalBool: Bool?
+
+    @Flag var optionalColor: Color?
+
     @Option var option: Bool
     @Argument var input: String
     @Argument var output: String?