Improve help text output

Author: ethanhann

src/InEngine.Commands/Sample/Minimal.cs

@@ -11,7 +11,7 @@ namespace InEngine.Commands.Sample
      */
     public class Minimal : AbstractCommand
     {
-        public void Run()
+        public override void Run()
         {
         }
     }

src/InEngine.Commands/Sample/RegisterCommands.cs renamed to src/InEngine.Commands/Sample/SampleCommandsPlugin.cs

@@ -3,15 +3,15 @@
 
 namespace InEngine.Commands.Sample
 {
-    public class RegisterCommands : AbstractPlugin
+    public class SampleCommandsPlugin : AbstractPlugin
     {
         [VerbOption("sample:show-progress", HelpText = "A sample command to demonstrate the progress bar.")]
         public ShowProgress ShowProgress { get; set; }
 
         [VerbOption("sample:say-hello", HelpText = "A sample command to say \"hello\".")]
         public SayHello SayHello { get; set; }
 
-        [VerbOption("sample:minimal")]
+        [VerbOption("sample:minimal", HelpText = "A minimal implementation of a command - does nothing.")]
         public Minimal Minimal { get; set; }
     }
 }

src/InEngine.Core/AbstractPlugin.cs

@@ -1,11 +1,13 @@
 using System;
+using System.Collections.Generic;
+using System.Linq;
 using CommandLine;
 using CommandLine.Text;
 using InEngine.Core.Scheduling;
 
 namespace InEngine.Core
 {
-    public class AbstractPlugin : IPlugin
+    abstract public class AbstractPlugin : IPlugin
     {
         public virtual void Schedule(ISchedule schedule)
         {}
@@ -20,9 +22,36 @@ public string GetUsage(string verb)
 
         public virtual string GetUsageWithoutHeader()
         {
-            var helpText = new HelpText();
-            helpText.AddOptions(this);
-            return helpText;
+            var verbs = GetType()
+                .GetProperties()
+                .ToList()
+                .SelectMany(x => {
+                    return x.GetCustomAttributes(typeof(VerbOptionAttribute), true).Select(y => y as VerbOptionAttribute);
+                });
+            var maxWidth = 0;
+            foreach (var verb in verbs)
+                if (verb.LongName != null && verb.LongName.Length > maxWidth)
+                    maxWidth = verb.LongName.Length;
+
+            var helpTextLine = verbs.Select(x => {
+                var name = (x.LongName ?? "");
+                var padding = maxWidth - name.Length + 2;
+                return $"  {name}" + string.Join("", Enumerable.Range(0, padding).Select(y => " ")) + (x.HelpText ?? "");
+            });
+
+            return string.Join(Environment.NewLine, helpTextLine);
+        }
+
+        public IList<VerbOptionAttribute> GetVerbOptions()
+        {
+            return GetType()
+                .GetProperties()
+                .SelectMany(property => {
+                    return property.GetCustomAttributes(typeof(VerbOptionAttribute), true)
+                                   .Select(verb => verb as VerbOptionAttribute);
+                })
+                .OrderBy(x => x.LongName)
+                .ToList();
         }
     }
 }

src/InEngine.Core/PluginAssembly.cs

@@ -37,7 +37,7 @@ public List<T> Make<T>() where T : class, IPlugin
         {
             return Assembly
                 .GetTypes()
-                .Where(x => x.IsClass && typeof(T).IsAssignableFrom(x))
+                .Where(x => x.IsClass && typeof(T).IsAssignableFrom(x) && !x.IsAbstract)
                 .Select(x => Assembly.CreateInstance(x.FullName) as T)
                 .ToList();
         }
@@ -62,7 +62,7 @@ public static List<PluginAssembly> Load<T>() where T : IPlugin
             {
                 try
                 {
-                    if (assembly.GetTypes().Any(y => y.IsClass && typeof(T).IsAssignableFrom(y)))
+                    if (assembly.GetTypes().Any(x => x.IsClass && typeof(T).IsAssignableFrom(x) && !x.IsAbstract))
                         pluginList.Add(new PluginAssembly(assembly));
                 }
                 catch (Exception exception)

src/InEngine/ArgumentInterpreter.cs

@@ -159,17 +159,42 @@ public void PrintPluginHelpTextAndExit(PluginAssembly plugin, List<AbstractPlugi
             ExitWithSuccess();
         }
 
-        public void PrintInEngineHelpTextAndExit(List<PluginAssembly> plugins, Options options)
+        public void PrintInEngineHelpTextAndExit(List<PluginAssembly> pluginAssemblies, Options options)
         {
             Write.Info(CliLogo);
             Write.Text(options.GetUsage(""));
-            plugins.ForEach(x => {
-                Write.Warning(x.Name);
-                x.Plugins.ForEach(y => {
-                    Write.Line(string.Join(Environment.NewLine, y.GetUsageWithoutHeader().Split('\n').Where(s => !string.IsNullOrWhiteSpace(s))))
-                         .Newline();
+
+            /*
+             * Compute the max width of a command verb name to allow for proper padding.
+             */
+            var maxWidth = 0;
+            pluginAssemblies.ForEach(pluginAssembly => {
+                pluginAssembly.Plugins.ForEach(plugin => {
+                    foreach (var verb in plugin.GetVerbOptions())
+                        if (verb.LongName != null && verb.LongName.Length > maxWidth)
+                            maxWidth = verb.LongName.Length;
                 });
             });
+
+            /*
+             * Print out each plugin's commands.
+             */
+            pluginAssemblies.ForEach(pluginAssembly => {
+                Write.Warning(pluginAssembly.Name);
+                pluginAssembly
+                    .Plugins
+                    .OrderBy(x => x.GetType().Name)
+                    .ToList()
+                    .ForEach(plugin => {
+                        plugin.GetVerbOptions().ToList().ForEach(verb => {
+                            var name = (verb.LongName ?? "");
+                            var padding = new string(' ', maxWidth - name.Length + 2);
+                            Write.InfoText($"  {name}")
+                                 .Line(padding + (verb.HelpText ?? ""));
+                        });
+                    });
+            });
+
             ExitWithSuccess();
         }
     }

src/InEngine/appsettings.json

@@ -1,7 +1,7 @@
 {
   "InEngine": {
     "Plugins": [
-      
+      "InEngine.Commands"
     ],
     "Mail": {
       "Host": "localhost",