From 11a320c7c9936e33cc50cc4905dd83e717dc0e62 Mon Sep 17 00:00:00 2001 From: Tonttu <15074459+TheTonttu@users.noreply.github.com> Date: Tue, 11 Feb 2025 23:13:30 +0200 Subject: [PATCH] Conditionally trim trailing periods of argument and option descriptions (#1740) --- .../ConfiguratorExtensions.cs | 2 +- src/Spectre.Console.Cli/Help/HelpProvider.cs | 37 ++++++++++--------- .../ICommandAppSettings.cs | 2 +- .../Resources/HelpProvider.Designer.cs | 6 +-- .../Resources/HelpProvider.de.resx | 4 +- .../Resources/HelpProvider.es.resx | 4 +- .../Resources/HelpProvider.fr.resx | 4 +- .../Resources/HelpProvider.it.resx | 4 +- .../Resources/HelpProvider.pt.resx | 4 +- .../Resources/HelpProvider.resx | 4 +- .../Resources/HelpProvider.ru.resx | 4 +- .../Resources/HelpProvider.sv.resx | 4 +- .../Help/Branch.Output.verified.txt | 2 +- ...ch_Called_Without_Help.Output.verified.txt | 2 +- .../Help/Branch_Examples.Output.verified.txt | 2 +- .../Command_Hide_Default.Output.verified.txt | 2 +- .../Help/Default.Output.verified.txt | 2 +- .../Help/Default_Examples.Output.verified.txt | 2 +- .../Default_Without_Args.Output.verified.txt | 2 +- ...out_Args_Additional.Output_DE.verified.txt | 2 +- ...out_Args_Additional.Output_EN.verified.txt | 2 +- ...out_Args_Additional.Output_FR.verified.txt | 2 +- ...out_Args_Additional.Output_IT.verified.txt | 2 +- ...out_Args_Additional.Output_JA.verified.txt | 2 +- ...out_Args_Additional.Output_KO.verified.txt | 2 +- ...out_Args_Additional.Output_PT.verified.txt | 2 +- ...out_Args_Additional.Output_RU.verified.txt | 2 +- ...out_Args_Additional.Output_SV.verified.txt | 2 +- ...rgs_Additional.Output_ZH-HANS.verified.txt | 2 +- ...nal_Style_BoldHeadings.Output.verified.txt | 2 +- ...ditional_Style_Default.Output.verified.txt | 2 +- ..._Additional_Style_None.Output.verified.txt | 2 +- ...ion_No_Trailing_Period.Output.verified.txt | 20 ++++++---- .../Help/Leaf.Output.verified.txt | 2 +- .../Help/Root_Command.Output.verified.txt | 2 +- .../Root_Command.QuestionMark.verified.txt | 2 +- .../Unit/CommandAppTests.Help.cs | 2 +- 37 files changed, 78 insertions(+), 69 deletions(-) diff --git a/src/Spectre.Console.Cli/ConfiguratorExtensions.cs b/src/Spectre.Console.Cli/ConfiguratorExtensions.cs index 80895e3..6a03617 100644 --- a/src/Spectre.Console.Cli/ConfiguratorExtensions.cs +++ b/src/Spectre.Console.Cli/ConfiguratorExtensions.cs @@ -168,7 +168,7 @@ public static class ConfiguratorExtensions } /// - /// Tells the help writer whether or not to trim trailing period. + /// Tells the help provider whether or not to trim trailing period. /// /// The configurator. /// True to trim trailing period (default), false to not. diff --git a/src/Spectre.Console.Cli/Help/HelpProvider.cs b/src/Spectre.Console.Cli/Help/HelpProvider.cs index ca18f0f..eb27ee2 100644 --- a/src/Spectre.Console.Cli/Help/HelpProvider.cs +++ b/src/Spectre.Console.Cli/Help/HelpProvider.cs @@ -22,7 +22,7 @@ public class HelpProvider : IHelpProvider protected virtual bool ShowOptionDefaultValues { get; } /// - /// 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. /// 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()), - NewComposer().Text(child.Description?.TrimEnd('.') ?? " ")); - } - else - { - grid.AddRow( - NewComposer().Text(arguments.ToString().TrimEnd()), - NewComposer().Text(child.Description ?? " ")); - } + grid.AddRow( + NewComposer().Text(arguments.ToString().TrimEnd()), + NewComposer().Text(NormalizeDescription(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; + } } \ No newline at end of file diff --git a/src/Spectre.Console.Cli/ICommandAppSettings.cs b/src/Spectre.Console.Cli/ICommandAppSettings.cs index 88ed386..0c865e2 100644 --- a/src/Spectre.Console.Cli/ICommandAppSettings.cs +++ b/src/Spectre.Console.Cli/ICommandAppSettings.cs @@ -37,7 +37,7 @@ public interface ICommandAppSettings bool ShowOptionDefaultValues { get; set; } /// - /// 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. /// bool TrimTrailingPeriod { get; set; } diff --git a/src/Spectre.Console.Cli/Resources/HelpProvider.Designer.cs b/src/Spectre.Console.Cli/Resources/HelpProvider.Designer.cs index b9fe53a..f00dd56 100644 --- a/src/Spectre.Console.Cli/Resources/HelpProvider.Designer.cs +++ b/src/Spectre.Console.Cli/Resources/HelpProvider.Designer.cs @@ -1,4 +1,4 @@ -//------------------------------------------------------------------------------ +//------------------------------------------------------------------------------ // // This code was generated by a tool. // Runtime Version:4.0.30319.42000 @@ -124,7 +124,7 @@ namespace Spectre.Console.Cli.Resources { } /// - /// Looks up a localized string similar to Prints help information. + /// Looks up a localized string similar to Prints help information.. /// internal static string PrintHelpDescription { get { @@ -133,7 +133,7 @@ namespace Spectre.Console.Cli.Resources { } /// - /// Looks up a localized string similar to Prints version information. + /// Looks up a localized string similar to Prints version information.. /// internal static string PrintVersionDescription { get { diff --git a/src/Spectre.Console.Cli/Resources/HelpProvider.de.resx b/src/Spectre.Console.Cli/Resources/HelpProvider.de.resx index 86e8104..8653138 100644 --- a/src/Spectre.Console.Cli/Resources/HelpProvider.de.resx +++ b/src/Spectre.Console.Cli/Resources/HelpProvider.de.resx @@ -139,10 +139,10 @@ OPTIONEN - Zeigt Hilfe an + Zeigt Hilfe an. - Zeigt Versionsinformationen an + Zeigt Versionsinformationen an. VERWENDUNG diff --git a/src/Spectre.Console.Cli/Resources/HelpProvider.es.resx b/src/Spectre.Console.Cli/Resources/HelpProvider.es.resx index 0f710f5..11515ec 100644 --- a/src/Spectre.Console.Cli/Resources/HelpProvider.es.resx +++ b/src/Spectre.Console.Cli/Resources/HelpProvider.es.resx @@ -139,10 +139,10 @@ OPCIONES - Imprime información de ayuda + Imprime información de ayuda. - Imprime información de versión + Imprime información de versión. USO diff --git a/src/Spectre.Console.Cli/Resources/HelpProvider.fr.resx b/src/Spectre.Console.Cli/Resources/HelpProvider.fr.resx index 1387b11..2c16589 100644 --- a/src/Spectre.Console.Cli/Resources/HelpProvider.fr.resx +++ b/src/Spectre.Console.Cli/Resources/HelpProvider.fr.resx @@ -139,10 +139,10 @@ OPTIONS - Affiche l'aide + Affiche l'aide. - Affiche la version + Affiche la version. UTILISATION diff --git a/src/Spectre.Console.Cli/Resources/HelpProvider.it.resx b/src/Spectre.Console.Cli/Resources/HelpProvider.it.resx index 144b8b7..bfe8275 100644 --- a/src/Spectre.Console.Cli/Resources/HelpProvider.it.resx +++ b/src/Spectre.Console.Cli/Resources/HelpProvider.it.resx @@ -139,10 +139,10 @@ OPZIONI - Visualizza le informazioni di aiuto + Visualizza le informazioni di aiuto. - Visualizza le informazioni sulla versione + Visualizza le informazioni sulla versione. USO diff --git a/src/Spectre.Console.Cli/Resources/HelpProvider.pt.resx b/src/Spectre.Console.Cli/Resources/HelpProvider.pt.resx index 87420ec..67d4a0a 100644 --- a/src/Spectre.Console.Cli/Resources/HelpProvider.pt.resx +++ b/src/Spectre.Console.Cli/Resources/HelpProvider.pt.resx @@ -139,10 +139,10 @@ OPÇÕES - Exibe informações de ajuda + Exibe informações de ajuda. - Exibe informações de versão + Exibe informações de versão. USO diff --git a/src/Spectre.Console.Cli/Resources/HelpProvider.resx b/src/Spectre.Console.Cli/Resources/HelpProvider.resx index 3e76d0b..5fdb898 100644 --- a/src/Spectre.Console.Cli/Resources/HelpProvider.resx +++ b/src/Spectre.Console.Cli/Resources/HelpProvider.resx @@ -139,10 +139,10 @@ OPTIONS - Prints help information + Prints help information. - Prints version information + Prints version information. USAGE diff --git a/src/Spectre.Console.Cli/Resources/HelpProvider.ru.resx b/src/Spectre.Console.Cli/Resources/HelpProvider.ru.resx index aebe37c..3c1f142 100644 --- a/src/Spectre.Console.Cli/Resources/HelpProvider.ru.resx +++ b/src/Spectre.Console.Cli/Resources/HelpProvider.ru.resx @@ -139,10 +139,10 @@ ОПЦИИ - Выводит информацию о помощи + Выводит информацию о помощи. - Выводит информацию о версии + Выводит информацию о версии. ИСПОЛЬЗОВАНИЕ diff --git a/src/Spectre.Console.Cli/Resources/HelpProvider.sv.resx b/src/Spectre.Console.Cli/Resources/HelpProvider.sv.resx index 8e9db89..4717d68 100644 --- a/src/Spectre.Console.Cli/Resources/HelpProvider.sv.resx +++ b/src/Spectre.Console.Cli/Resources/HelpProvider.sv.resx @@ -139,10 +139,10 @@ VAL - Skriver ut hjälpinformation + Skriver ut hjälpinformation. - Skriver ut versionsnummer + Skriver ut versionsnummer. ANVÄNDING diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Branch.Output.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Branch.Output.verified.txt index 189faef..2efdb4c 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Branch.Output.verified.txt +++ b/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] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Branch_Called_Without_Help.Output.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Branch_Called_Without_Help.Output.verified.txt index 5fba99c..8218123 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Branch_Called_Without_Help.Output.verified.txt +++ b/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] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Branch_Examples.Output.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Branch_Examples.Output.verified.txt index 12898a8..97851a3 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Branch_Examples.Output.verified.txt +++ b/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] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Command_Hide_Default.Output.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Command_Hide_Default.Output.verified.txt index 0cf3f19..102ef3a 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Command_Hide_Default.Output.verified.txt +++ b/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] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default.Output.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default.Output.verified.txt index b53a06e..5f9add4 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default.Output.verified.txt +++ b/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 [LEGS] [OPTIONS] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Examples.Output.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Examples.Output.verified.txt index 58c2ec5..b9082ea 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Examples.Output.verified.txt +++ b/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 [LEGS] [OPTIONS] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args.Output.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args.Output.verified.txt index b53a06e..5f9add4 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args.Output.verified.txt +++ b/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 [LEGS] [OPTIONS] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_DE.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_DE.verified.txt index 860bdf4..ccceba6 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_DE.verified.txt +++ b/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 [LEGS] [OPTIONEN] [KOMMANDO] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_EN.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_EN.verified.txt index e10f430..020ef95 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_EN.verified.txt +++ b/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 [LEGS] [OPTIONS] [COMMAND] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_FR.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_FR.verified.txt index be65b45..07654b8 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_FR.verified.txt +++ b/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 [LEGS] [OPTIONS] [COMMANDE] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_IT.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_IT.verified.txt index c5591b1..919af8c 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_IT.verified.txt +++ b/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 [LEGS] [OPZIONI] [COMANDO] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_JA.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_JA.verified.txt index a04c006..0dcf7ca 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_JA.verified.txt +++ b/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 [LEGS] [オプション] [コマンド] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_KO.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_KO.verified.txt index 51fc153..c998efe 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_KO.verified.txt +++ b/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 [LEGS] [옵션] [명령] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_PT.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_PT.verified.txt index 5169a5d..682a7a3 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_PT.verified.txt +++ b/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 [LEGS] [OPÇÕES] [COMANDO] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_RU.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_RU.verified.txt index f3cfeff..140c5c6 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_RU.verified.txt +++ b/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 [LEGS] [ОПЦИИ] [КОМАНДА] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_SV.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_SV.verified.txt index 64fd286..baa423c 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_SV.verified.txt +++ b/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 [LEGS] [VAL] [KOMMANDO] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_ZH-HANS.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_ZH-HANS.verified.txt index 9a46d7a..bd380b1 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional.Output_ZH-HANS.verified.txt +++ b/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 [LEGS] [选项] [命令] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional_Style_BoldHeadings.Output.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional_Style_BoldHeadings.Output.verified.txt index 5b0f426..2008091 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional_Style_BoldHeadings.Output.verified.txt +++ b/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 [][/] [][[LEGS]][/] [][[OPTIONS]][/] [][[COMMAND]][/] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional_Style_Default.Output.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional_Style_Default.Output.verified.txt index 82570d3..8633827 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional_Style_Default.Output.verified.txt +++ b/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][/] [silver][[LEGS]][/] [grey][[OPTIONS]][/] [aqua][[COMMAND]][/] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional_Style_None.Output.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional_Style_None.Output.verified.txt index 2b92a19..512508a 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Default_Without_Args_Additional_Style_None.Output.verified.txt +++ b/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 [][/] [][[LEGS]][/] [][[OPTIONS]][/] [][[COMMAND]][/] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Description_No_Trailing_Period.Output.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Description_No_Trailing_Period.Output.verified.txt index 9662e05..b38fc5a 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Description_No_Trailing_Period.Output.verified.txt +++ b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Description_No_Trailing_Period.Output.verified.txt @@ -1,9 +1,15 @@ -USAGE: - myapp [OPTIONS] +DESCRIPTION: +The dog command. + +USAGE: + myapp dog [LEGS] [OPTIONS] + +ARGUMENTS: + + [LEGS] The number of legs. OPTIONS: - -h, --help Prints help information - -COMMANDS: - dog The dog command. - horse The horse command. \ No newline at end of file + -h, --help Prints help information. + -a, --alive Indicates whether or not the animal is alive. + -n, --name + -g, --good-boy \ No newline at end of file diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Leaf.Output.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Leaf.Output.verified.txt index 3134e99..7f7ad2d 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Leaf.Output.verified.txt +++ b/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 [OPTIONS] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Root_Command.Output.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Root_Command.Output.verified.txt index 2c6e498..a4d8d51 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Root_Command.Output.verified.txt +++ b/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] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Root_Command.QuestionMark.verified.txt b/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Root_Command.QuestionMark.verified.txt index 03c6875..2fd2923 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Expectations/Help/Root_Command.QuestionMark.verified.txt +++ b/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] diff --git a/src/Tests/Spectre.Console.Cli.Tests/Unit/CommandAppTests.Help.cs b/src/Tests/Spectre.Console.Cli.Tests/Unit/CommandAppTests.Help.cs index 5422e51..076f07b 100644 --- a/src/Tests/Spectre.Console.Cli.Tests/Unit/CommandAppTests.Help.cs +++ b/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);