tk/spectre.console
1
0
Fork 0
mirror of https://github.com/nsnail/spectre.console.git synced 2025-04-23 11:42:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

Added command description to command help message (#920)

Browse Source
This commit is contained in:
nkochnev 2022-08-17 19:59:08 +05:00 committed by GitHub
parent d94dc2fcb2
commit 78d841e3dc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/Spectre.Console.Cli/Internal/HelpWriter.cs
View File

@ -75,6 +75,7 @@ internal static class HelpWriter
var isDefaultCommand = command?.IsDefaultCommand ?? false; var isDefaultCommand = command?.IsDefaultCommand ?? false;
var result = new List<IRenderable>(); var result = new List<IRenderable>();
result.AddRange(GetDescription(command));
result.AddRange(GetUsage(model, command)); result.AddRange(GetUsage(model, command));
result.AddRange(GetExamples(model, command)); result.AddRange(GetExamples(model, command));
result.AddRange(GetArguments(command)); result.AddRange(GetArguments(command));
@ -84,6 +85,19 @@ internal static class HelpWriter
return result; return result;
} }
private static IEnumerable<IRenderable> GetDescription(CommandInfo? command)
{
if (command?.Description == null)
{
yield break;
}
var composer = new Composer();
composer.Style("yellow", "DESCRIPTION:").LineBreak();
composer.Text(command.Description).LineBreak();
yield return composer.LineBreak();
}
private static IEnumerable<IRenderable> GetUsage(CommandModel model, CommandInfo? command) private static IEnumerable<IRenderable> GetUsage(CommandModel model, CommandInfo? command)
{ {
var composer = new Composer(); var composer = new Composer();

3
test/Spectre.Console.Cli.Tests/Expectations/Help/Command.Output.verified.txt
View File

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

3
test/Spectre.Console.Cli.Tests/Expectations/Help/CommandExamples.Output.verified.txt
View File

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

3
test/Spectre.Console.Cli.Tests/Expectations/Help/Default.Output.verified.txt
View File

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

3
test/Spectre.Console.Cli.Tests/Expectations/Help/DefaultExamples.Output.verified.txt
View File

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

3
test/Spectre.Console.Cli.Tests/Expectations/Help/Leaf.Output.verified.txt
View File

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