Conditionally trim trailing periods of argument and option descriptions (#1740)

src/Spectre.Console.Cli/ConfiguratorExtensions.cs

@@ -168,7 +168,7 @@ public static class ConfiguratorExtensions
     }
 
     /// <summary>
-    /// Tells the help writer whether or not to trim trailing period.
+    /// Tells the help provider whether or not to trim trailing period.
     /// </summary>
     /// <param name="configurator">The configurator.</param>
     /// <param name="trimTrailingPeriods">True to trim trailing period (default), false to not.</param>

src/Spectre.Console.Cli/Help/HelpProvider.cs

@@ -22,7 +22,7 @@ public class HelpProvider : IHelpProvider
     protected virtual bool ShowOptionDefaultValues { get; }
 
     /// <summary>
-    /// Gets a value indicating whether a trailing period of a command description is trimmed in the help text.
+    /// Gets a value indicating whether a trailing period of a description is trimmed in the help text.
     /// </summary>
     protected virtual bool TrimTrailingPeriod { get; }
 
@@ -171,7 +171,7 @@ public class HelpProvider : IHelpProvider
 
         var composer = NewComposer();
         composer.Style(helpStyles?.Description?.Header ?? Style.Plain, $"{resources.Description}:").LineBreak();
-        composer.Text(command.Description).LineBreak();
+        composer.Text(NormalizeDescription(command.Description)).LineBreak();
         yield return composer.LineBreak();
     }
 
@@ -364,14 +364,14 @@ public class HelpProvider : IHelpProvider
         {
             grid.AddRow(
                 NewComposer().Style(helpStyles?.Arguments?.RequiredArgument ?? Style.Plain, $"<{argument.Name}>"),
-                NewComposer().Text(argument.Description?.TrimEnd('.') ?? " "));
+                NewComposer().Text(NormalizeDescription(argument.Description)));
         }
 
         foreach (var argument in arguments.Where(x => !x.Required).OrderBy(x => x.Position))
         {
             grid.AddRow(
                 NewComposer().Style(helpStyles?.Arguments?.OptionalArgument ?? Style.Plain, $"[{argument.Name}]"),
-                NewComposer().Text(argument.Description?.TrimEnd('.') ?? " "));
+                NewComposer().Text(NormalizeDescription(argument.Description)));
         }
 
         result.Add(grid);
@@ -428,7 +428,7 @@ public class HelpProvider : IHelpProvider
                 columns.Add(GetDefaultValueForOption(option.DefaultValue));
             }
 
-            columns.Add(NewComposer().Text(option.Description?.TrimEnd('.') ?? " "));
+            columns.Add(NewComposer().Text(NormalizeDescription(option.Description)));
 
             grid.AddRow(columns.ToArray());
         }
@@ -478,18 +478,9 @@ public class HelpProvider : IHelpProvider
                 arguments.Space();
             }
 
-            if (TrimTrailingPeriod)
+            grid.AddRow(
-            {
+                NewComposer().Text(arguments.ToString().TrimEnd()),
-                grid.AddRow(
+                NewComposer().Text(NormalizeDescription(child.Description)));
-                    NewComposer().Text(arguments.ToString().TrimEnd()),
-                    NewComposer().Text(child.Description?.TrimEnd('.') ?? " "));
-            }
-            else
-            {
-                grid.AddRow(
-                    NewComposer().Text(arguments.ToString().TrimEnd()),
-                    NewComposer().Text(child.Description ?? " "));
-            }
         }
 
         result.Add(grid);
@@ -566,4 +557,16 @@ public class HelpProvider : IHelpProvider
             _ => NewComposer().Style(helpStyles?.Options?.DefaultValue ?? Style.Plain, defaultValue?.ToString() ?? string.Empty),
         };
     }
+
+    private string NormalizeDescription(string? description)
+    {
+        if (description == null)
+        {
+            return " ";
+        }
+
+        return TrimTrailingPeriod
+            ? description.TrimEnd('.')
+            : description;
+    }
 }

src/Spectre.Console.Cli/ICommandAppSettings.cs

@@ -37,7 +37,7 @@ public interface ICommandAppSettings
     bool ShowOptionDefaultValues { get; set; }
 
     /// <summary>
-    /// Gets or sets a value indicating whether a trailing period of a command description is trimmed in the help text.
+    /// Gets or sets a value indicating whether a trailing period of a description is trimmed in the help text.
     /// </summary>
     bool TrimTrailingPeriod { get; set; }
 

src/Spectre.Console.Cli/Resources/HelpProvider.Designer.cs

@@ -1,4 +1,4 @@
-//------------------------------------------------------------------------------
+//------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was generated by a tool.
 //     Runtime Version:4.0.30319.42000
@@ -124,7 +124,7 @@ namespace Spectre.Console.Cli.Resources {
         }
         
         /// <summary>
-        ///   Looks up a localized string similar to Prints help information.
+        ///   Looks up a localized string similar to Prints help information..
         /// </summary>
         internal static string PrintHelpDescription {
             get {
@@ -133,7 +133,7 @@ namespace Spectre.Console.Cli.Resources {
         }
         
         /// <summary>
-        ///   Looks up a localized string similar to Prints version information.
+        ///   Looks up a localized string similar to Prints version information..
         /// </summary>
         internal static string PrintVersionDescription {
             get {

src/Spectre.Console.Cli/Resources/HelpProvider.de.resx

@@ -139,10 +139,10 @@
     <value>OPTIONEN</value>
   </data>
   <data name="PrintHelpDescription" xml:space="preserve">
-    <value>Zeigt Hilfe an</value>
+    <value>Zeigt Hilfe an.</value>
   </data>
   <data name="PrintVersionDescription" xml:space="preserve">
-    <value>Zeigt Versionsinformationen an</value>
+    <value>Zeigt Versionsinformationen an.</value>
   </data>
   <data name="Usage" xml:space="preserve">
     <value>VERWENDUNG</value>

src/Spectre.Console.Cli/Resources/HelpProvider.es.resx

@@ -139,10 +139,10 @@
     <value>OPCIONES</value>
   </data>
   <data name="PrintHelpDescription" xml:space="preserve">
-    <value>Imprime información de ayuda</value>
+    <value>Imprime información de ayuda.</value>
   </data>
   <data name="PrintVersionDescription" xml:space="preserve">
-    <value>Imprime información de versión</value>
+    <value>Imprime información de versión.</value>
   </data>
   <data name="Usage" xml:space="preserve">
     <value>USO</value>

src/Spectre.Console.Cli/Resources/HelpProvider.fr.resx

@@ -139,10 +139,10 @@
     <value>OPTIONS</value>
   </data>
   <data name="PrintHelpDescription" xml:space="preserve">
-    <value>Affiche l'aide</value>
+    <value>Affiche l'aide.</value>
   </data>
   <data name="PrintVersionDescription" xml:space="preserve">
-    <value>Affiche la version</value>
+    <value>Affiche la version.</value>
   </data>
   <data name="Usage" xml:space="preserve">
     <value>UTILISATION</value>

src/Spectre.Console.Cli/Resources/HelpProvider.it.resx

@@ -139,10 +139,10 @@
     <value>OPZIONI</value>
   </data>
   <data name="PrintHelpDescription" xml:space="preserve">
-    <value>Visualizza le informazioni di aiuto</value>
+    <value>Visualizza le informazioni di aiuto.</value>
   </data>
   <data name="PrintVersionDescription" xml:space="preserve">
-    <value>Visualizza le informazioni sulla versione</value>
+    <value>Visualizza le informazioni sulla versione.</value>
   </data>
   <data name="Usage" xml:space="preserve">
     <value>USO</value>

src/Spectre.Console.Cli/Resources/HelpProvider.pt.resx

@@ -139,10 +139,10 @@
     <value>OPÇÕES</value>
   </data>
   <data name="PrintHelpDescription" xml:space="preserve">
-    <value>Exibe informações de ajuda</value>
+    <value>Exibe informações de ajuda.</value>
   </data>
   <data name="PrintVersionDescription" xml:space="preserve">
-    <value>Exibe informações de versão</value>
+    <value>Exibe informações de versão.</value>
   </data>
   <data name="Usage" xml:space="preserve">
     <value>USO</value>

src/Spectre.Console.Cli/Resources/HelpProvider.resx

@@ -139,10 +139,10 @@
     <value>OPTIONS</value>
   </data>
   <data name="PrintHelpDescription" xml:space="preserve">
-    <value>Prints help information</value>
+    <value>Prints help information.</value>
   </data>
   <data name="PrintVersionDescription" xml:space="preserve">
-    <value>Prints version information</value>
+    <value>Prints version information.</value>
   </data>
   <data name="Usage" xml:space="preserve">
     <value>USAGE</value>

src/Spectre.Console.Cli/Resources/HelpProvider.ru.resx

@@ -139,10 +139,10 @@
     <value>ОПЦИИ</value>
   </data>
   <data name="PrintHelpDescription" xml:space="preserve">
-    <value>Выводит информацию о помощи</value>
+    <value>Выводит информацию о помощи.</value>
   </data>
   <data name="PrintVersionDescription" xml:space="preserve">
-    <value>Выводит информацию о версии</value>
+    <value>Выводит информацию о версии.</value>
   </data>
   <data name="Usage" xml:space="preserve">
     <value>ИСПОЛЬЗОВАНИЕ</value>

src/Spectre.Console.Cli/Resources/HelpProvider.sv.resx

@@ -139,10 +139,10 @@
     <value>VAL</value>
   </data>
   <data name="PrintHelpDescription" xml:space="preserve">
-    <value>Skriver ut hjälpinformation</value>
+    <value>Skriver ut hjälpinformation.</value>
   </data>
   <data name="PrintVersionDescription" xml:space="preserve">
-    <value>Skriver ut versionsnummer</value>
+    <value>Skriver ut versionsnummer.</value>
   </data>
   <data name="Usage" xml:space="preserve">
     <value>ANVÄNDING</value>

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Branch.Output.verified.txt

@@ -1,5 +1,5 @@
 DESCRIPTION:
-Contains settings for a cat.
+Contains settings for a cat
 
 USAGE:
     myapp cat [LEGS] [OPTIONS] <COMMAND>

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Branch_Called_Without_Help.Output.verified.txt

@@ -1,5 +1,5 @@
 DESCRIPTION:
-Contains settings for a cat.
+Contains settings for a cat
 
 USAGE:
     myapp cat [LEGS] [OPTIONS] <COMMAND>

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Branch_Examples.Output.verified.txt

@@ -1,5 +1,5 @@
 DESCRIPTION:
-The animal command.
+The animal command
 
 USAGE:
     myapp animal [LEGS] [OPTIONS] <COMMAND>

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Command_Hide_Default.Output.verified.txt

@@ -1,5 +1,5 @@
 DESCRIPTION:
-Contains settings for a cat.
+Contains settings for a cat
 
 USAGE:
     myapp cat [LEGS] [OPTIONS] <COMMAND>

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default.Output.verified.txt

@@ -1,5 +1,5 @@
 DESCRIPTION:
-The lion command.
+The lion command
 
 USAGE:
     myapp <TEETH> [LEGS] [OPTIONS]

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Examples.Output.verified.txt

@@ -1,5 +1,5 @@
 DESCRIPTION:
-The dog command.
+The dog command
 
 USAGE:
     myapp <AGE> [LEGS] [OPTIONS]

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args.Output.verified.txt

@@ -1,5 +1,5 @@
 DESCRIPTION:
-The lion command.
+The lion command
 
 USAGE:
     myapp <TEETH> [LEGS] [OPTIONS]

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_DE.verified.txt

@@ -1,5 +1,5 @@
 BESCHREIBUNG:
-The lion command.
+The lion command
 
 VERWENDUNG:
     myapp <TEETH> [LEGS] [OPTIONEN] [KOMMANDO]

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_EN.verified.txt

@@ -1,5 +1,5 @@
 DESCRIPTION:
-The lion command.
+The lion command
 
 USAGE:
     myapp <TEETH> [LEGS] [OPTIONS] [COMMAND]

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_FR.verified.txt

@@ -1,5 +1,5 @@
 DESCRIPTION:
-The lion command.
+The lion command
 
 UTILISATION:
     myapp <TEETH> [LEGS] [OPTIONS] [COMMANDE]

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_IT.verified.txt

@@ -1,5 +1,5 @@
 DESCRIZIONE:
-The lion command.
+The lion command
 
 USO:
     myapp <TEETH> [LEGS] [OPZIONI] [COMANDO]

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_JA.verified.txt

@@ -1,5 +1,5 @@
 説明:
-The lion command.
+The lion command
 
 使用法:
     myapp <TEETH> [LEGS] [オプション] [コマンド]

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_KO.verified.txt

@@ -1,5 +1,5 @@
 설명:
-The lion command.
+The lion command
 
 사용법:
     myapp <TEETH> [LEGS] [옵션] [명령]

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_PT.verified.txt

@@ -1,5 +1,5 @@
 DESCRIÇÃO:
-The lion command.
+The lion command
 
 USO:
     myapp <TEETH> [LEGS] [OPÇÕES] [COMANDO]

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_RU.verified.txt

@@ -1,5 +1,5 @@
 ОПИСАНИЕ:
-The lion command.
+The lion command
 
 ИСПОЛЬЗОВАНИЕ:
     myapp <TEETH> [LEGS] [ОПЦИИ] [КОМАНДА]

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_SV.verified.txt

@@ -1,5 +1,5 @@
 BESKRIVNING:
-The lion command.
+The lion command
 
 ANVÄNDING:
     myapp <TEETH> [LEGS] [VAL] [KOMMANDO]

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_ZH-HANS.verified.txt

@@ -1,5 +1,5 @@
 描述:
-The lion command.
+The lion command
 
 用法:
     myapp <TEETH> [LEGS] [选项] [命令]

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional_Style_BoldHeadings.Output.verified.txt

@@ -1,5 +1,5 @@
 [bold]DESCRIPTION:[/]
-The lion command.
+The lion command
 
 [bold]USAGE:[/]
     myapp []<TEETH>[/] [][[LEGS]][/] [][[OPTIONS]][/] [][[COMMAND]][/]

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional_Style_Default.Output.verified.txt

@@ -1,5 +1,5 @@
 [yellow]DESCRIPTION:[/]
-The lion command.
+The lion command
 
 [yellow]USAGE:[/]
     myapp [aqua]<TEETH>[/] [silver][[LEGS]][/] [grey][[OPTIONS]][/] [aqua][[COMMAND]][/]

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional_Style_None.Output.verified.txt

@@ -1,5 +1,5 @@
 []DESCRIPTION:[/]
-The lion command.
+The lion command
 
 []USAGE:[/]
     myapp []<TEETH>[/] [][[LEGS]][/] [][[OPTIONS]][/] [][[COMMAND]][/]

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Description_No_Trailing_Period.Output.verified.txt

@@ -1,9 +1,15 @@
-USAGE:
+DESCRIPTION:
-    myapp [OPTIONS] <COMMAND>
+The dog command.
+
+USAGE:
+    myapp dog <AGE> [LEGS] [OPTIONS]
+
+ARGUMENTS:
+    <AGE>
+    [LEGS]    The number of legs.
 
 OPTIONS:
-    -h, --help    Prints help information
+    -h, --help            Prints help information.
-
+    -a, --alive           Indicates whether or not the animal is alive.
-COMMANDS:
+    -n, --name <VALUE>
-    dog <AGE>    The dog command.
+    -g, --good-boy
-    horse        The horse command.

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Leaf.Output.verified.txt

@@ -1,5 +1,5 @@
 DESCRIPTION:
-The lion command.
+The lion command
 
 USAGE:
     myapp cat [LEGS] lion <TEETH> [OPTIONS]

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Root_Command.Output.verified.txt

@@ -1,5 +1,5 @@
 DESCRIPTION:
-The horse command.
+The horse command
 
 USAGE:
     myapp horse [LEGS] [OPTIONS]

src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Root_Command.QuestionMark.verified.txt

@@ -1,5 +1,5 @@
 DESCRIPTION:
-The horse command.
+The horse command
 
 USAGE:
     myapp horse [LEGS] [OPTIONS]

src/Tests/Spectre.Console.Cli.Tests/Unit/CommandAppTests.Help.cs

@@ -132,7 +132,7 @@ public sealed partial class CommandAppTests
             });
 
             // When
-            var result = fixture.Run("--help");
+            var result = fixture.Run("dog", "--help");
 
             // Then
             return Verifier.Verify(result.Output);