show help when nonmatch command

Author: neuecc

sandbox/SingleContainedApp/Program.cs

@@ -50,6 +50,18 @@ public async Task Timer([Option(0)]uint waitSeconds)
 
  public class OverrideCheck : BatchBase
  {
+ [Command("encode", "encode input string to base64url")]
+ public void Encode([Option(0)]string input) => Console.WriteLine((input));
+
+ [Command("decode", "decode input base64url to string")]
+ public void Decode([Option(0)]string input) => Console.WriteLine((input));
+
+ [Command("escape", "escape base64 to base64url")]
+ public void Escape([Option(0)]string input) => Console.WriteLine((input));
+
+ [Command(new[] { "unescape", "-h" }, "unescape base64url to base64")]
+ public void Unescape([Option(0)]string input) => Console.WriteLine((input));
+
  [Command(new[] { "help", "-h", "-help", "--help" }, "show help")]
  public void Help()
  {
@@ -65,7 +77,6 @@ class Program
  {
  static async Task Main(string[] args)
  {
- args = new string[] { };
  await new HostBuilder().RunBatchEngineAsync<OverrideCheck>(args);
  }
  }

src/MicroBatchFramework/BatchEngine.cs

@@ -1,8 +1,10 @@
 using Microsoft.Extensions.Logging;
+using System.Linq;
 using System;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using System.Reflection;
+using System.Text;
 using System.Threading;
 using System.Threading.Tasks;
 using Utf8Json;
@@ -49,23 +51,39 @@ public async Task RunAsync(Type type, string[] args)
  }
 
  var methods = type.GetMethods(BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly);
+ if (methods.Length == 0)
+ {
+ await SetFailAsync(ctx, "Method can not select. T of Run/UseBatchEngine<T> have to be contain single method or command. Type:" + type.FullName);
+ return;
+ }
+
+ MethodInfo helpMethod = null;
  foreach (var item in methods)
  {
  var command = item.GetCustomAttribute<CommandAttribute>();
  if (command != null)
  {
  if (args.Length > 0 && command.EqualsAny(args[0]))
  {
+ // command alias is first priority(if duplicate with MethodName([Command("run")]Run()), okay to execute.
  method = item;
  argsOffset = 1;
- goto RUN;
+ continue;
+ }
+ else
+ {
+ if (command.EqualsAny("help"))
+ {
+ helpMethod = item;
+ }
  }
  }
  else
  {
  if (method != null)
  {
- goto FAIL;
+ await SetFailAsync(ctx, "Found duplicate method/command name, name or alias only allows unique name. Type:" + type.FullName + " Method:" + method.Name + " and " + item.Name);
+ return;
  }
  method = item;
  }
@@ -76,17 +94,25 @@ public async Task RunAsync(Type type, string[] args)
  goto RUN;
  }
 
- FAIL:
- await SetFailAsync(ctx, "Method can not select. T of Run/UseBatchEngine<T> have to be contain single method or command. Type:" + type.FullName);
- return;
+ // completely not found, invalid command name show help.
+ if (helpMethod != null)
+ {
+ method = helpMethod;
+ goto RUN;
+ }
+ else
+ {
+ Console.WriteLine(BatchEngine.BuildHelpParameter(methods));
+ return;
+ }
  }
  catch (Exception ex)
  {
  await SetFailAsync(ctx, "Fail to get method. Type:" + type.FullName, ex);
  return;
  }
 
- RUN:
+  RUN:
  await RunCore(ctx, type, method, args, argsOffset);
  }
 
@@ -291,5 +317,92 @@ struct OptionParameter
  public string Value;
  public bool BooleanSwitch;
  }
+
+ internal static string BuildHelpParameter(MethodInfo[] methods)
+ {
+ var sb = new StringBuilder();
+ foreach (var method in methods.OrderBy(x => x, new CustomSorter()))
+ {
+ var command = method.GetCustomAttribute<CommandAttribute>();
+ if (command != null)
+ {
+ sb.AppendLine(string.Join(", ", command.CommandNames) + ": " + command.Description);
+ }
+ else
+ {
+ sb.AppendLine("argument list:");
+ }
+
+ var parameters = method.GetParameters();
+ if (parameters.Length == 0)
+ {
+ sb.AppendLine("()");
+ }
+
+ foreach (var item in parameters)
+ {
+ // -i, -input | [default=foo]...
+
+ var option = item.GetCustomAttribute<OptionAttribute>();
+
+ if (option != null)
+ {
+ if (option.Index != -1)
+ {
+ sb.Append("[" + option.Index + "]");
+ goto WRITE_DESCRIPTION;
+ }
+ else
+ {
+ sb.Append("-" + option.ShortName.Trim('-') + ", ");
+ }
+ }
+
+ sb.Append("-" + item.Name);
+
+ WRITE_DESCRIPTION:
+ sb.Append(": ");
+
+ if (item.HasDefaultValue)
+ {
+ sb.Append("[default=" + (item.DefaultValue?.ToString() ?? "null") + "]");
+ }
+
+ if (option != null && !string.IsNullOrEmpty(option.Description))
+ {
+ sb.Append(option.Description);
+ }
+ else
+ {
+ sb.Append(item.ParameterType.Name);
+ }
+ sb.AppendLine();
+ }
+
+ sb.AppendLine();
+ }
+
+ return sb.ToString();
+ }
+
+ class CustomSorter : IComparer<MethodInfo>
+ {
+ public int Compare(MethodInfo x, MethodInfo y)
+ {
+ var xc = x.GetCustomAttribute<CommandAttribute>();
+ var yc = y.GetCustomAttribute<CommandAttribute>();
+
+ if (xc != null)
+ {
+ return 1;
+ }
+ if (yc != null)
+ {
+ return -1;
+ }
+
+ return x.Name.CompareTo(y.Name);
+ }
+ }
  }
 }

src/MicroBatchFramework/BatchEngineHostBuilderExtensions.cs

@@ -32,7 +32,7 @@ public static IHostBuilder UseBatchEngine(this IHostBuilder hostBuilder, string[
  var (t, mi) = GetTypeFromAssemblies(args[1]);
  if (mi != null)
  {
- Console.WriteLine(BuildHelpParameter(new[] { mi }));
+ Console.WriteLine(BatchEngine.BuildHelpParameter(new[] { mi }));
  }
  else
  {
@@ -103,7 +103,7 @@ public static IHostBuilder UseBatchEngine<T>(this IHostBuilder hostBuilder, stri
  {
  if (!hasHelp)
  {
- Console.WriteLine(BuildHelpParameter(method));
+ Console.WriteLine(BatchEngine.BuildHelpParameter(method));
  hostBuilder.ConfigureServices(services =>
  {
  services.AddOptions<ConsoleLifetimeOptions>().Configure(x => x.SuppressStatusMessages = true);
@@ -132,7 +132,7 @@ public static IHostBuilder UseBatchEngine<T>(this IHostBuilder hostBuilder, stri
 
  if (!hasHelp && args.Length == 1 && args[0].Equals(HelpCommand, StringComparison.OrdinalIgnoreCase))
  {
- Console.WriteLine(BuildHelpParameter(method));
+ Console.WriteLine(BatchEngine.BuildHelpParameter(method));
  hostBuilder.ConfigureServices(services =>
  {
  services.AddOptions<ConsoleLifetimeOptions>().Configure(x => x.SuppressStatusMessages = true);
@@ -178,73 +178,6 @@ static void ShowMethodList()
  }
  }
 
- static string BuildHelpParameter(MethodInfo[] methods)
- {
- var sb = new StringBuilder();
- foreach (var method in methods.OrderBy(x => x, new CustomSorter()))
- {
- var command = method.GetCustomAttribute<CommandAttribute>();
- if (command != null)
- {
- sb.AppendLine(string.Join(", ", command.CommandNames) + ": " + command.Description);
- }
- else
- {
- sb.AppendLine("argument list:");
- }
-
- var parameters = method.GetParameters();
- if (parameters.Length == 0)
- {
- sb.AppendLine("()");
- }
-
- foreach (var item in parameters)
- {
- // -i, -input | [default=foo]...
-
- var option = item.GetCustomAttribute<OptionAttribute>();
-
- if (option != null)
- {
- if (option.Index != -1)
- {
- sb.Append("[" + option.Index + "]");
- goto WRITE_DESCRIPTION;
- }
- else
- {
- sb.Append("-" + option.ShortName.Trim('-') + ", ");
- }
- }
-
- sb.Append("-" + item.Name);
-
- WRITE_DESCRIPTION:
- sb.Append(": ");
-
- if (item.HasDefaultValue)
- {
- sb.Append("[default=" + (item.DefaultValue?.ToString() ?? "null") + "]");
- }
-
- if (option != null && !string.IsNullOrEmpty(option.Description))
- {
- sb.Append(option.Description);
- }
- else
- {
- sb.Append(item.ParameterType.Name);
- }
- sb.AppendLine();
- }
-
- sb.AppendLine();
- }
-
- return sb.ToString();
- }
-
  static List<Type> GetBatchTypes()
  {
  List<Type> batchBaseTypes = new List<Type>();
@@ -315,25 +248,5 @@ static List<Type> GetBatchTypes()
 
  return (null, null);
  }
-
- class CustomSorter : IComparer<MethodInfo>
- {
- public int Compare(MethodInfo x, MethodInfo y)
- {
- var xc = x.GetCustomAttribute<CommandAttribute>();
- var yc = y.GetCustomAttribute<CommandAttribute>();
-
- if (xc != null)
- {
- return 1;
- }
- if (yc != null)
- {
- return -1;
- }
-
- return x.Name.CompareTo(y.Name);
- }
- }
  }
 }