Adds aliases to the dump-help output.

jglogan · jglogan · commit cc5ad952b5c5 · 2025-09-15T16:40:46.000-07:00
- Closes #812.
diff --git a/Sources/ArgumentParser/Usage/DumpHelpGenerator.swift b/Sources/ArgumentParser/Usage/DumpHelpGenerator.swift
@@ -87,6 +87,7 @@ extension CommandInfoV0 {
       superCommands: superCommands,
       shouldDisplay: command.configuration.shouldDisplay,
       commandName: command._commandName,
+      aliases: command.configuration.aliases,
       abstract: command.configuration.abstract,
       discussion: command.configuration.discussion,
       defaultSubcommand: defaultSubcommand,
diff --git a/Sources/ArgumentParserToolInfo/ToolInfo.swift b/Sources/ArgumentParserToolInfo/ToolInfo.swift
@@ -49,6 +49,8 @@ public struct CommandInfoV0: Codable, Hashable {
 
   /// Name used to invoke the command.
   public var commandName: String
+  /// List of command aliases.
+  public var aliases: [String]
   /// Short description of the command's functionality.
   public var abstract: String?
   /// Extended description of the command's functionality.
@@ -66,6 +68,7 @@ public struct CommandInfoV0: Codable, Hashable {
     superCommands: [String],
     shouldDisplay: Bool,
     commandName: String,
+    aliases: [String],
     abstract: String,
     discussion: String,
     defaultSubcommand: String?,
@@ -76,6 +79,7 @@ public struct CommandInfoV0: Codable, Hashable {
     self.shouldDisplay = shouldDisplay
 
     self.commandName = commandName
+    self.aliases = aliases
     self.abstract = abstract.nonEmpty
     self.discussion = discussion.nonEmpty
 
@@ -89,6 +93,7 @@ public struct CommandInfoV0: Codable, Hashable {
     self.superCommands = try container.decodeIfPresent(
       [String].self, forKey: .superCommands)
     self.commandName = try container.decode(String.self, forKey: .commandName)
+    self.aliases = try container.decode([String].self, forKey: .aliases)
     self.abstract = try container.decodeIfPresent(
       String.self, forKey: .abstract)
     self.discussion = try container.decodeIfPresent(
diff --git a/Tests/ArgumentParserUnitTests/Snapshots/testADumpHelp().json b/Tests/ArgumentParserUnitTests/Snapshots/testADumpHelp().json
@@ -1,5 +1,8 @@
 {
   "command" : {
+    "aliases" : [
+
+    ],
     "arguments" : [
       {
         "allValues" : [
@@ -179,6 +182,9 @@
     "subcommands" : [
       {
         "abstract" : "Show subcommand help information.",
+        "aliases" : [
+
+        ],
         "arguments" : [
           {
             "isOptional" : true,
diff --git a/Tests/ArgumentParserUnitTests/Snapshots/testBDumpHelp().json b/Tests/ArgumentParserUnitTests/Snapshots/testBDumpHelp().json
@@ -1,5 +1,8 @@
 {
   "command" : {
+    "aliases" : [
+
+    ],
     "arguments" : [
       {
         "isOptional" : true,
@@ -68,6 +71,9 @@
     "subcommands" : [
       {
         "abstract" : "Show subcommand help information.",
+        "aliases" : [
+
+        ],
         "arguments" : [
           {
             "isOptional" : true,
diff --git a/Tests/ArgumentParserUnitTests/Snapshots/testCDumpHelp().json b/Tests/ArgumentParserUnitTests/Snapshots/testCDumpHelp().json
@@ -1,5 +1,8 @@
 {
   "command" : {
+    "aliases" : [
+
+    ],
     "arguments" : [
       {
         "abstract" : "A color to select.",
@@ -202,6 +205,9 @@
     "subcommands" : [
       {
         "abstract" : "Show subcommand help information.",
+        "aliases" : [
+
+        ],
         "arguments" : [
           {
             "isOptional" : true,
diff --git a/Tests/ArgumentParserUnitTests/Snapshots/testMathAddDumpHelp().json b/Tests/ArgumentParserUnitTests/Snapshots/testMathAddDumpHelp().json
@@ -1,6 +1,9 @@
 {
   "command" : {
     "abstract" : "Print the sum of the values.",
+    "aliases" : [
+
+    ],
     "arguments" : [
       {
         "abstract" : "Use hexadecimal notation for the result.",
@@ -82,6 +85,9 @@
     "subcommands" : [
       {
         "abstract" : "Show subcommand help information.",
+        "aliases" : [
+
+        ],
         "arguments" : [
           {
             "isOptional" : true,
diff --git a/Tests/ArgumentParserUnitTests/Snapshots/testMathDumpHelp().json b/Tests/ArgumentParserUnitTests/Snapshots/testMathDumpHelp().json
@@ -1,6 +1,9 @@
 {
   "command" : {
     "abstract" : "A utility for performing maths.",
+    "aliases" : [
+
+    ],
     "arguments" : [
       {
         "abstract" : "Show the version.",
@@ -50,6 +53,9 @@
     "subcommands" : [
       {
         "abstract" : "Print the sum of the values.",
+        "aliases" : [
+
+        ],
         "arguments" : [
           {
             "abstract" : "Use hexadecimal notation for the result.",
@@ -134,6 +140,9 @@
       },
       {
         "abstract" : "Print the product of the values.",
+        "aliases" : [
+          "mul"
+        ],
         "arguments" : [
           {
             "abstract" : "Use hexadecimal notation for the result.",
@@ -218,6 +227,9 @@
       },
       {
         "abstract" : "Calculate descriptive statistics.",
+        "aliases" : [
+
+        ],
         "arguments" : [
           {
             "abstract" : "Show the version.",
@@ -267,6 +279,9 @@
         "subcommands" : [
           {
             "abstract" : "Print the average of the values.",
+            "aliases" : [
+              "avg"
+            ],
             "arguments" : [
               {
                 "abstract" : "The kind of average to provide.",
@@ -363,6 +378,9 @@
           },
           {
             "abstract" : "Print the standard deviation of the values.",
+            "aliases" : [
+
+            ],
             "arguments" : [
               {
                 "abstract" : "A group of floating-point values to operate on.",
@@ -425,6 +443,9 @@
           },
           {
             "abstract" : "Print the quantiles of the values (TBD).",
+            "aliases" : [
+
+            ],
             "arguments" : [
               {
                 "completionKind" : {
@@ -726,6 +747,9 @@
       },
       {
         "abstract" : "Show subcommand help information.",
+        "aliases" : [
+
+        ],
         "arguments" : [
           {
             "isOptional" : true,
diff --git a/Tests/ArgumentParserUnitTests/Snapshots/testMathMultiplyDumpHelp().json b/Tests/ArgumentParserUnitTests/Snapshots/testMathMultiplyDumpHelp().json
@@ -1,6 +1,9 @@
 {
   "command" : {
     "abstract" : "Print the product of the values.",
+    "aliases" : [
+      "mul"
+    ],
     "arguments" : [
       {
         "abstract" : "Use hexadecimal notation for the result.",
@@ -82,6 +85,9 @@
     "subcommands" : [
       {
         "abstract" : "Show subcommand help information.",
+        "aliases" : [
+
+        ],
         "arguments" : [
           {
             "isOptional" : true,
diff --git a/Tests/ArgumentParserUnitTests/Snapshots/testMathStatsDumpHelp().json b/Tests/ArgumentParserUnitTests/Snapshots/testMathStatsDumpHelp().json
@@ -1,6 +1,9 @@
 {
   "command" : {
     "abstract" : "Calculate descriptive statistics.",
+    "aliases" : [
+
+    ],
     "arguments" : [
       {
         "abstract" : "Show the version.",
@@ -50,6 +53,9 @@
     "subcommands" : [
       {
         "abstract" : "Print the average of the values.",
+        "aliases" : [
+          "avg"
+        ],
         "arguments" : [
           {
             "abstract" : "The kind of average to provide.",
@@ -146,6 +152,9 @@
       },
       {
         "abstract" : "Print the standard deviation of the values.",
+        "aliases" : [
+
+        ],
         "arguments" : [
           {
             "abstract" : "A group of floating-point values to operate on.",
@@ -208,6 +217,9 @@
       },
       {
         "abstract" : "Print the quantiles of the values (TBD).",
+        "aliases" : [
+
+        ],
         "arguments" : [
           {
             "completionKind" : {
@@ -504,6 +516,9 @@
       },
       {
         "abstract" : "Show subcommand help information.",
+        "aliases" : [
+
+        ],
         "arguments" : [
           {
             "isOptional" : true,

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,8 @@`
`1`	`1`	`{`
`2`	`2`	`"command" : {`
	`3`	`+ "aliases" : [`
	`4`	`+`
	`5`	`+ ],`
`3`	`6`	`"arguments" : [`
`4`	`7`	`{`
`5`	`8`	`"allValues" : [`
`@@ -179,6 +182,9 @@`
`179`	`182`	`"subcommands" : [`
`180`	`183`	`{`
`181`	`184`	`"abstract" : "Show subcommand help information.",`
	`185`	`+ "aliases" : [`
	`186`	`+`
	`187`	`+ ],`
`182`	`188`	`"arguments" : [`
`183`	`189`	`{`
`184`	`190`	`"isOptional" : true,`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,9 @@`
`1`	`1`	`{`
`2`	`2`	`"command" : {`
`3`	`3`	`"abstract" : "Print the sum of the values.",`
	`4`	`+ "aliases" : [`
	`5`	`+`
	`6`	`+ ],`
`4`	`7`	`"arguments" : [`
`5`	`8`	`{`
`6`	`9`	`"abstract" : "Use hexadecimal notation for the result.",`
`@@ -82,6 +85,9 @@`
`82`	`85`	`"subcommands" : [`
`83`	`86`	`{`
`84`	`87`	`"abstract" : "Show subcommand help information.",`
	`88`	`+ "aliases" : [`
	`89`	`+`
	`90`	`+ ],`
`85`	`91`	`"arguments" : [`
`86`	`92`	`{`
`87`	`93`	`"isOptional" : true,`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,9 @@`
`1`	`1`	`{`
`2`	`2`	`"command" : {`
`3`	`3`	`"abstract" : "A utility for performing maths.",`
	`4`	`+ "aliases" : [`
	`5`	`+`
	`6`	`+ ],`
`4`	`7`	`"arguments" : [`
`5`	`8`	`{`
`6`	`9`	`"abstract" : "Show the version.",`
`@@ -50,6 +53,9 @@`
`50`	`53`	`"subcommands" : [`
`51`	`54`	`{`
`52`	`55`	`"abstract" : "Print the sum of the values.",`
	`56`	`+ "aliases" : [`
	`57`	`+`
	`58`	`+ ],`
`53`	`59`	`"arguments" : [`
`54`	`60`	`{`
`55`	`61`	`"abstract" : "Use hexadecimal notation for the result.",`
`@@ -134,6 +140,9 @@`
`134`	`140`	`},`
`135`	`141`	`{`
`136`	`142`	`"abstract" : "Print the product of the values.",`
	`143`	`+ "aliases" : [`
	`144`	`+ "mul"`
	`145`	`+ ],`
`137`	`146`	`"arguments" : [`
`138`	`147`	`{`
`139`	`148`	`"abstract" : "Use hexadecimal notation for the result.",`
`@@ -218,6 +227,9 @@`
`218`	`227`	`},`
`219`	`228`	`{`
`220`	`229`	`"abstract" : "Calculate descriptive statistics.",`
	`230`	`+ "aliases" : [`
	`231`	`+`
	`232`	`+ ],`
`221`	`233`	`"arguments" : [`
`222`	`234`	`{`
`223`	`235`	`"abstract" : "Show the version.",`
`@@ -267,6 +279,9 @@`
`267`	`279`	`"subcommands" : [`
`268`	`280`	`{`
`269`	`281`	`"abstract" : "Print the average of the values.",`
	`282`	`+ "aliases" : [`
	`283`	`+ "avg"`
	`284`	`+ ],`
`270`	`285`	`"arguments" : [`
`271`	`286`	`{`
`272`	`287`	`"abstract" : "The kind of average to provide.",`
`@@ -363,6 +378,9 @@`
`363`	`378`	`},`
`364`	`379`	`{`
`365`	`380`	`"abstract" : "Print the standard deviation of the values.",`
	`381`	`+ "aliases" : [`
	`382`	`+`
	`383`	`+ ],`
`366`	`384`	`"arguments" : [`
`367`	`385`	`{`
`368`	`386`	`"abstract" : "A group of floating-point values to operate on.",`
`@@ -425,6 +443,9 @@`
`425`	`443`	`},`
`426`	`444`	`{`
`427`	`445`	`"abstract" : "Print the quantiles of the values (TBD).",`
	`446`	`+ "aliases" : [`
	`447`	`+`
	`448`	`+ ],`
`428`	`449`	`"arguments" : [`
`429`	`450`	`{`
`430`	`451`	`"completionKind" : {`
`@@ -726,6 +747,9 @@`
`726`	`747`	`},`
`727`	`748`	`{`
`728`	`749`	`"abstract" : "Show subcommand help information.",`
	`750`	`+ "aliases" : [`
	`751`	`+`
	`752`	`+ ],`
`729`	`753`	`"arguments" : [`
`730`	`754`	`{`
`731`	`755`	`"isOptional" : true,`