support command alias

Author: neuecc

sandbox/GeneratorSandbox/Program.cs

@@ -1,8 +1,23 @@
-using ConsoleAppFramework;
+using ConsoleAppFramework;
 
-args = "9999 --x 1000".Split(' ');
+// args = ["foo", "--help"];
 
-ConsoleApp.Run(args, (int x, [Argument] int y) =>
+var app = ConsoleApp.Create();
+
+app.Add("build|b", () => { });
+app.Add("test|t", () => { });
+app.Add("keyvault|kv", () => { });
+app.Add<Commands>();
+
+app.Run(args);
+
+public class Commands
 {
-    Console.WriteLine((x, y));
-});
+    /// <summary>Analyze the current package and report errors, but don't build object files.</summary>
+    [Command("check|c")]
+    public void Check() { }
+
+    /// <summary>Build this packages's and its dependencies' documenation.</summary>
+    [Command("doc|d")]
+    public void Doc() { }
+}

src/ConsoleAppFramework/CommandHelpBuilder.cs

@@ -1,4 +1,4 @@
-using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis;
 using System.Text;
 
 namespace ConsoleAppFramework;
@@ -222,7 +222,7 @@ static string BuildMethodListMessage(IEnumerable<Command> commands, out int maxW
             .Where(x => !x.IsHidden)
             .Select(x =>
             {
-                return (Command: x.Name, x.Description);
+                return (Command: string.Join(", ", x.Name.Split('|')), x.Description);
             })
             .ToArray();
         maxWidth = formatted.Max(x => x.Command.Length);

src/ConsoleAppFramework/Emitter.cs

@@ -465,8 +465,10 @@ public void EmitRun(SourceBuilder sb, CommandWithId commandWithId, bool isRunAsy
 
     public void EmitBuilder(SourceBuilder sb, CommandWithId[] commandIds, bool emitSync, bool emitAsync)
     {
-        // grouped by path
-        var commandGroup = commandIds.ToLookup(x => x.Command.Name.Split(' ')[0]);
+        // split command-alias and grouped by path
+        var commandGroup = commandIds
+            .SelectMany(x => x.Command.Name.Split('|'), (command, name) => command with { Command = command.Command with { Name = name } })
+            .ToLookup(x => x.Command.Name.Split(' ')[0]);
         var hasRootCommand = commandIds.Any(x => x.Command.IsRootCommand);
 
         using (sb.BeginBlock("partial class ConsoleAppBuilder"))
@@ -939,7 +941,7 @@ public void EmitConfigure(SourceBuilder sb, DllReference dllReference)
         {
             if (dllReference.HasDependencyInjection)
             {
-                using(sb.BeginBlock("if (!isRequireCallBuildAndSetServiceProvider)"))
+                using (sb.BeginBlock("if (!isRequireCallBuildAndSetServiceProvider)"))
                 {
                     sb.AppendLine("return;");
                 }

tests/ConsoleAppFramework.GeneratorTests/ConsoleAppBuilderTest.cs

@@ -278,4 +278,38 @@ public override Task InvokeAsync(ConsoleAppContext context,CancellationToken can
 
         verifier.Execute(code, "nomunomu", "filter1-filter2-command");
     }
+
+    [Fact]
+    public void CommandAlias()
+    {
+        var code = """
+var app = ConsoleApp.Create();
+
+app.Add("build|b", () => { Console.Write("build ok"); });
+app.Add("test|t", () => { Console.Write("test ok");  });
+app.Add<Commands>();
+
+app.Run(args);
+
+public class Commands
+{
+    /// <summary>Analyze the current package and report errors, but don't build object files.</summary>
+    [Command("check|c")]
+    public void Check() { Console.Write("check ok"); }
+
+    /// <summary>Build this packages's and its dependencies' documenation.</summary>
+    [Command("doc|d")]
+    public void Doc() { Console.Write("doc ok"); }
+}
+""";
+
+        verifier.Execute(code, "b", "build ok");
+        verifier.Execute(code, "build", "build ok");
+        verifier.Execute(code, "t", "test ok");
+        verifier.Execute(code, "test", "test ok");
+        verifier.Execute(code, "c", "check ok");
+        verifier.Execute(code, "check", "check ok");
+        verifier.Execute(code, "d", "doc ok");
+        verifier.Execute(code, "doc", "doc ok");
+    }
 }

tests/ConsoleAppFramework.GeneratorTests/HelpTest.cs

@@ -397,4 +397,40 @@ private static string GetEntryAssemblyVersion()
 
         return version;
     }
+
+    [Fact]
+    public void CommandAlias()
+    {
+        var code = """
+var app = ConsoleApp.Create();
+
+app.Add("build|b", () => { Console.Write("build ok"); });
+app.Add("test|t", () => { Console.Write("test ok");  });
+app.Add<Commands>();
+
+app.Run(args);
+
+public class Commands
+{
+    /// <summary>Analyze the current package and report errors, but don't build object files.</summary>
+    [Command("check|c")]
+    public void Check() { Console.Write("check ok"); }
+
+    /// <summary>Build this packages's and its dependencies' documenation.</summary>
+    [Command("doc|d")]
+    public void Doc() { Console.Write("doc ok"); }
+}
+""";
+
+        verifier.Execute(code, "--help", """
+Usage: [command] [-h|--help] [--version]
+
+Commands:
+  build, b
+  check, c    Analyze the current package and report errors, but don't build object files.
+  doc, d      Build this packages's and its dependencies' documenation.
+  test, t
+
+""");
+    }
 }