Add alignment component to UsageBuilder, fixes #32 (#46)

Author: Matthiee

CommandLineParser.Tests/Usage/UsagePrinterTests.cs

@@ -101,7 +101,7 @@ public void CustomInvokedPrinterWorksCorrectly(string[] args, bool cmdPassed, bo
 
             builderMock.Verify(mock => mock.Print(), Times.Never());
             builderMock.Verify(mock => mock.PrintCommand(It.IsAny<string>(), It.IsAny<ICommandLineCommandContainer>()), Times.Never());
-            builderMock.Verify(mock => mock.PrintOption(It.IsAny<ICommandLineOption>(), It.IsAny<int>(), It.IsAny<bool>()), Times.Never());
+            builderMock.Verify(mock => mock.PrintOption(It.IsAny<ICommandLineOption>()), Times.Never());
 
             if (result.HelpRequested)
                 parser.Printer.PrintUsage(result.HelpRequestedFor);
@@ -125,7 +125,7 @@ public void CustomInvokedPrinterWorksCorrectly(string[] args, bool cmdPassed, bo
                 ToTimes(cmdPassed));
 
             builderMock.Verify(
-                mock => mock.PrintOption(It.IsAny<ICommandLineOption>(), It.IsAny<int>(), It.IsAny<bool>()),
+                mock => mock.PrintOption(It.IsAny<ICommandLineOption>()),
                 ToTimes(optPassed));
         }
 

CommandLineParser/Abstractions/Usage/IUsageBuilder.cs

@@ -7,10 +7,10 @@ public interface IUsageBuilder
     {
         void Print();
         void PrintUsage(string name, bool hasOptions, bool hasCommands);
-        void PrintOptions(IEnumerable<ICommandLineOption> options, int descriptionShift = 4);
-        void PrintOption(ICommandLineOption option, int descriptionShift = 4, bool compensateSeparator = false);
-        void PrintCommandDescriptions(IEnumerable<ICommandLineCommand> commands, int descriptionShift = 4);
-        void PrintCommandDescription(ICommandLineCommand command, int descriptionShift = 4);
+        void PrintOptions(IEnumerable<ICommandLineOption> options);
+        void PrintOption(ICommandLineOption option);
+        void PrintCommandDescriptions(IEnumerable<ICommandLineCommand> commands);
+        void PrintCommandDescription(ICommandLineCommand command);
         void PrintCommand(string name, ICommandLineCommandContainer container);
     }
 }

CommandLineParser/CommandLineParser.xml

@@ -47,21 +47,20 @@ public void PrintCommand(string name, ICommandLineCommandContainer container)
             PrintCommandDescriptions(container.Commands);
         }
 
-        public void PrintCommandDescription(ICommandLineCommand command, int descriptionShift = 4)
-            => stringBuilder.AppendLine($"  {command.Name}{new string(' ', descriptionShift)}{command.Description}");
+        public void PrintCommandDescription(ICommandLineCommand command)
+            => stringBuilder.AppendLine($"  {command.Name,-20}{command.Description,-50}");
 
-        public void PrintCommandDescriptions(IEnumerable<ICommandLineCommand> commands, int descriptionShift = 4)
+        public void PrintCommandDescriptions(IEnumerable<ICommandLineCommand> commands)
         {
             if (!commands.Any()) return;
 
             stringBuilder.AppendLine().AppendLine("Commands: ");
 
-            var longestCommandName = commands.Max(x => x.Name.Length);
             foreach (var cmd in commands)
-                PrintCommandDescription(cmd, longestCommandName - cmd.Name.Length + descriptionShift);
+                PrintCommandDescription(cmd);
         }
 
-        public void PrintOption(ICommandLineOption option, int descriptionShift = 4, bool compensateSeparator = false)
+        public void PrintOption(ICommandLineOption option)
         {
             bool hasShort = option.HasShortName;
             bool hasLong = option.HasLongName;
@@ -71,29 +70,20 @@ public void PrintOption(ICommandLineOption option, int descriptionShift = 4, boo
             string shortName = hasShort ? option.ShortName : string.Empty;
             string longName = hasLong ? option.LongName : string.Empty;
 
-            // We neeed to compensate a separator if given option doesn't have both (short & long) names.
-            int indentationLength = descriptionShift + ((compensateSeparator && !hasBoth) ? optionSeparator.Length : 0);
-            string indentation = new string(' ', indentationLength);
+            string key = $"{shortName}{hasBothSeparator}{longName}";
 
-            stringBuilder.AppendLine($"  {shortName}{hasBothSeparator}{longName}{indentation}{option.Description}");
+            stringBuilder.AppendLine($"  {key,-20}{option.Description,-50}");
         }
 
-        public void PrintOptions(IEnumerable<ICommandLineOption> options, int descriptionShift = 4)
+        public void PrintOptions(IEnumerable<ICommandLineOption> options)
         {
             if (!options.Any()) return;
 
             stringBuilder.AppendLine().AppendLine("Options: ");
 
-            var longestOptionName = options.Max(x => (x.HasShortName ? x.ShortName.Length : 0) + (x.HasLongName ? x.LongName.Length : 0));
-            var compensateSeparator = options.Any(x => x.HasShortName && x.HasLongName);
-
             foreach (var opt in options)
-            {
-                var longNameLength = opt.HasLongName ? opt.LongName.Length : 0;
-                var shortNameLength = opt.HasShortName ? opt.ShortName.Length : 0;
-                descriptionShift = longestOptionName - longNameLength - shortNameLength + descriptionShift;
-
-                PrintOption(opt, descriptionShift, compensateSeparator);
+            { 
+                PrintOption(opt);
             }
         }
     }