override help/list command

Author: neuecc

src/MicroBatchFramework/BatchEngineHostBuilderExtensions.cs

@@ -92,10 +92,13 @@ public static Task RunBatchEngineAsync(this IHostBuilder hostBuilder, string[] a
         public static IHostBuilder UseBatchEngine<T>(this IHostBuilder hostBuilder, string[] args, IBatchInterceptor interceptor = null, bool useSimpleConosoleLogger = true)
             where T : BatchBase
         {
+            var method = typeof(T).GetMethods(BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly);
+            var defaultMethod = method.FirstOrDefault(x => x.GetCustomAttribute<CommandAttribute>() == null);
+            var hasList = method.Any(x => x.GetCustomAttribute<CommandAttribute>()?.EqualsAny(ListCommand) ?? false);
+            var hasHelp = method.Any(x => x.GetCustomAttribute<CommandAttribute>()?.EqualsAny(HelpCommand) ?? false);
+
             if (args.Length == 0)
             {
-                var method = typeof(T).GetMethods(BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly);
-                var defaultMethod = method.FirstOrDefault(x => x.GetCustomAttribute<CommandAttribute>() == null);
                 if (defaultMethod == null || (defaultMethod.GetParameters().Length != 0 && !defaultMethod.GetParameters().All(x => x.HasDefaultValue)))
                 {
                     Console.WriteLine(BuildHelpParameter(method));
@@ -108,7 +111,7 @@ public static IHostBuilder UseBatchEngine<T>(this IHostBuilder hostBuilder, stri
                 }
             }
 
-            if (args.Length == 1 && args[0].Equals(ListCommand, StringComparison.OrdinalIgnoreCase))
+            if (!hasList && args.Length == 1 && args[0].Equals(ListCommand, StringComparison.OrdinalIgnoreCase))
             {
                 ShowMethodList();
                 hostBuilder.ConfigureServices(services =>
@@ -118,9 +121,9 @@ public static IHostBuilder UseBatchEngine<T>(this IHostBuilder hostBuilder, stri
                 });
                 return hostBuilder;
             }
-            if (args.Length == 1 && args[0].Equals(HelpCommand, StringComparison.OrdinalIgnoreCase))
+
+            if (!hasHelp && args.Length == 1 && args[0].Equals(HelpCommand, StringComparison.OrdinalIgnoreCase))
             {
-                var method = typeof(T).GetMethods(BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly);
                 Console.WriteLine(BuildHelpParameter(method));
                 hostBuilder.ConfigureServices(services =>
                 {

src/MicroBatchFramework/CommandAttribute.cs

@@ -24,15 +24,6 @@ public CommandAttribute(string[] commandNames)
 
         public CommandAttribute(string[] commandNames, string description)
         {
-            foreach (var item in commandNames)
-            {
-                if (item.Equals("list", StringComparison.OrdinalIgnoreCase)
-                 || item.Equals("help", StringComparison.OrdinalIgnoreCase))
-                {
-                    throw new ArgumentException("`list` or `help` is system reserved commandName, can not use.");
-                }
-            }
-
             this.CommandNames = commandNames;
             this.Description = description;
         }

tests/MicroBatchFramework.Tests/SingleContainedTest.cs

@@ -77,7 +77,7 @@ public async Task SimpleTwoArgsTest()
                 {
                     var args = new string[0];
                     await new HostBuilder().RunBatchEngineAsync<SimpleTwoArgs>(args);
-                    log.ToStringInfo().Should().StartWith("argument list:"); // ok to show help
+                    log.ToStringInfo().Should().Contain("argument list:"); // ok to show help
                 }
             }
         }

tests/MicroBatchFramework.Tests/SubCommandTest.cs

@@ -143,6 +143,50 @@ public async Task AliasCommandTest()
             }
         }
 
+        public class OverrideDefaultCommand : BatchBase
+        {
+            [Command("list")]
+            public void List()
+            {
+                Context.Logger.LogInformation($"lst");
+            }
+
+            [Command(new[] { "help", "h" })]
+            public void Help()
+            {
+                Context.Logger.LogInformation($"hlp");
+            }
+        }
+
+        [Fact]
+        public async Task OverrideDefaultCommandTest()
+        {
+            {
+                var args = "list".Split(' ');
+                var log = new LogStack();
+                await new HostBuilder()
+                    .ConfigureTestLogging(testOutput, log, true)
+                    .RunBatchEngineAsync<OverrideDefaultCommand>(args);
+                log.InfoLogShouldBe(0, "lst");
+            }
+            {
+                var args = "help".Split(' ');
+                var log = new LogStack();
+                await new HostBuilder()
+                    .ConfigureTestLogging(testOutput, log, true)
+                    .RunBatchEngineAsync<OverrideDefaultCommand>(args);
+                log.InfoLogShouldBe(0, "hlp");
+            }
+            {
+                var args = "h".Split(' ');
+                var log = new LogStack();
+                await new HostBuilder()
+                    .ConfigureTestLogging(testOutput, log, true)
+                    .RunBatchEngineAsync<OverrideDefaultCommand>(args);
+                log.InfoLogShouldBe(0, "hlp");
+            }
+        }
+
         public class NotFoundPath : BatchBase
         {
             [Command("run")]