Improve ToolInfoV0 HelpCommand injection.

rgoldberg · rgoldberg · commit 050a5367a4b6 · 2025-05-13T19:54:51.000-04:00
Signed-off-by: Ross Goldberg &lt;484615+rgoldberg@users.noreply.github.com&gt;
diff --git a/Sources/ArgumentParser/Usage/DumpHelpGenerator.swift b/Sources/ArgumentParser/Usage/DumpHelpGenerator.swift
@@ -57,11 +57,10 @@ extension ToolInfoV0 {
     self.init(command: CommandInfoV0(commandStack: commandStack))
     // FIXME: This is a hack to inject the help command into the tool info
     // instead we should try to lift this into the parseable command tree
-    var helpCommandInfo = CommandInfoV0(commandStack: [HelpCommand.self])
-    helpCommandInfo.superCommands =
-      (self.command.superCommands ?? []) + [self.command.commandName]
     self.command.subcommands =
-      (self.command.subcommands ?? []) + [helpCommandInfo]
+      (self.command.subcommands ?? []) + [
+        CommandInfoV0(commandStack: commandStack + [HelpCommand.self])
+      ]
   }
 }
 
diff --git a/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testMathDoccReference().md b/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testMathDoccReference().md
@@ -207,12 +207,17 @@ math stats quantiles [<one-of-four>] [<custom-arg>] [<custom-deprecated-arg>] [<
 Show subcommand help information.
 
 ```
-math help [<subcommands>...] 
+math help [<subcommands>...]  [--version]
 ```
 
 - term **subcommands**:
 
 
+- term **--version:**
+
+*Show the version.*
+
+
 
 
 
diff --git a/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testMathMarkdownReference().md b/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testMathMarkdownReference().md
@@ -207,12 +207,17 @@ math stats quantiles [<one-of-four>] [<custom-arg>] [<custom-deprecated-arg>] [<
 Show subcommand help information.
 
 ```
-math help [<subcommands>...] 
+math help [<subcommands>...]  [--version]
 ```
 
 **subcommands:**
 
 
+**--version:**
+
+*Show the version.*
+
+
 
 
 
diff --git a/Tests/ArgumentParserGenerateManualTests/Snapshots/testMathMultiPageManual().mdoc b/Tests/ArgumentParserGenerateManualTests/Snapshots/testMathMultiPageManual().mdoc
@@ -277,9 +277,12 @@ and
 .Sh SYNOPSIS
 .Nm
 .Op Ar subcommands...
+.Op Fl -version
 .Sh DESCRIPTION
 .Bl -tag -width 6n
 .It Ar subcommands...
+.It Fl -version
+Show the version.
 .El
 .Sh AUTHORS
 The
diff --git a/Tests/ArgumentParserGenerateManualTests/Snapshots/testMathSinglePageManual().mdoc b/Tests/ArgumentParserGenerateManualTests/Snapshots/testMathSinglePageManual().mdoc
@@ -93,6 +93,8 @@ Show help information.
 Show subcommand help information.
 .Bl -tag -width 6n
 .It Ar subcommands...
+.It Fl -version
+Show the version.
 .El
 .El
 .Sh AUTHORS
diff --git a/Tests/ArgumentParserUnitTests/Snapshots/testMathAddDumpHelp().json b/Tests/ArgumentParserUnitTests/Snapshots/testMathAddDumpHelp().json
@@ -110,6 +110,24 @@
             },
             "shouldDisplay" : false,
             "valueName" : "help"
+          },
+          {
+            "abstract" : "Show the version.",
+            "isOptional" : true,
+            "isRepeating" : false,
+            "kind" : "flag",
+            "names" : [
+              {
+                "kind" : "long",
+                "name" : "version"
+              }
+            ],
+            "preferredName" : {
+              "kind" : "long",
+              "name" : "version"
+            },
+            "shouldDisplay" : true,
+            "valueName" : "version"
           }
         ],
         "commandName" : "help",
diff --git a/Tests/ArgumentParserUnitTests/Snapshots/testMathDumpHelp().json b/Tests/ArgumentParserUnitTests/Snapshots/testMathDumpHelp().json
@@ -724,6 +724,24 @@
             },
             "shouldDisplay" : false,
             "valueName" : "help"
+          },
+          {
+            "abstract" : "Show the version.",
+            "isOptional" : true,
+            "isRepeating" : false,
+            "kind" : "flag",
+            "names" : [
+              {
+                "kind" : "long",
+                "name" : "version"
+              }
+            ],
+            "preferredName" : {
+              "kind" : "long",
+              "name" : "version"
+            },
+            "shouldDisplay" : true,
+            "valueName" : "version"
           }
         ],
         "commandName" : "help",
diff --git a/Tests/ArgumentParserUnitTests/Snapshots/testMathMultiplyDumpHelp().json b/Tests/ArgumentParserUnitTests/Snapshots/testMathMultiplyDumpHelp().json
@@ -110,6 +110,24 @@
             },
             "shouldDisplay" : false,
             "valueName" : "help"
+          },
+          {
+            "abstract" : "Show the version.",
+            "isOptional" : true,
+            "isRepeating" : false,
+            "kind" : "flag",
+            "names" : [
+              {
+                "kind" : "long",
+                "name" : "version"
+              }
+            ],
+            "preferredName" : {
+              "kind" : "long",
+              "name" : "version"
+            },
+            "shouldDisplay" : true,
+            "valueName" : "version"
           }
         ],
         "commandName" : "help",
diff --git a/Tests/ArgumentParserUnitTests/Snapshots/testMathStatsDumpHelp().json b/Tests/ArgumentParserUnitTests/Snapshots/testMathStatsDumpHelp().json
@@ -512,6 +512,24 @@
             },
             "shouldDisplay" : false,
             "valueName" : "help"
+          },
+          {
+            "abstract" : "Show the version.",
+            "isOptional" : true,
+            "isRepeating" : false,
+            "kind" : "flag",
+            "names" : [
+              {
+                "kind" : "long",
+                "name" : "version"
+              }
+            ],
+            "preferredName" : {
+              "kind" : "long",
+              "name" : "version"
+            },
+            "shouldDisplay" : true,
+            "valueName" : "version"
           }
         ],
         "commandName" : "help",

Original file line number	Diff line number	Diff line change
`@@ -57,11 +57,10 @@ extension ToolInfoV0 {`
`57`	`57`	`self.init(command: CommandInfoV0(commandStack: commandStack))`
`58`	`58`	`// FIXME: This is a hack to inject the help command into the tool info`
`59`	`59`	`// instead we should try to lift this into the parseable command tree`
`60`		`- var helpCommandInfo = CommandInfoV0(commandStack: [HelpCommand.self])`
`61`		`- helpCommandInfo.superCommands =`
`62`		`- (self.command.superCommands ?? []) + [self.command.commandName]`
`63`	`60`	`self.command.subcommands =`
`64`		`- (self.command.subcommands ?? []) + [helpCommandInfo]`
	`61`	`+ (self.command.subcommands ?? []) + [`
	`62`	`+ CommandInfoV0(commandStack: commandStack + [HelpCommand.self])`
	`63`	`+ ]`
`65`	`64`	`}`
`66`	`65`	`}`
`67`	`66`