Mirrors/CliFx
1
0
Fork 0
mirror of https://github.com/Tyrrrz/CliFx.git synced 2025-10-25 15:19:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add child command usage in help text (#77)

Browse Source
This commit is contained in:
Nikiforov Alexey
2020-10-22 16:02:58 +03:00
committed by GitHub
parent 6a38c04c11
commit c322b7029c
1 changed files with 34 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
CliFx/Domain/HelpTextWriter.cs
View File

@@ -105,31 +105,52 @@ namespace CliFx.Domain
WriteLine();
}
private void WriteCommandUsage(CommandSchema command, IReadOnlyList<CommandSchema> childCommands)
private void WriteCommandUsage(
CommandSchema command,
IReadOnlyList<CommandSchema> childCommands)
{
if (!IsEmpty)
WriteVerticalMargin();
WriteHeader("Usage");
// Exe name
WriteHorizontalMargin();
Write(_metadata.ExecutableName);
WriteCommandUsageLineItem(command, childCommands.Count > 0);
if (!IsEmpty)
WriteVerticalMargin();
foreach (var childCommand in childCommands)
{
WriteCommandUsageLineItem(childCommand, compactCommand: false, size: 4);
}
}
private void WriteCommandUsageLineItem(
CommandSchema command,
bool compactCommand = true,
int size = 2)
{
WriteHorizontalMargin(size);
if (compactCommand)
{
// Exe name
Write(_metadata.ExecutableName);
Write(' ');
}
// Command name
if (!string.IsNullOrWhiteSpace(command.Name))
{
Write(' ');
// this is fragile, because we rely that subcommand name consists
// of all required tokens
Write(ConsoleColor.Cyan, command.Name);
}
// Child command placeholder
if (childCommands.Any())
if (compactCommand)
{
Write(' ');
Write(ConsoleColor.Cyan, "[command]");
}
// Parameters
foreach (var parameter in command.Parameters)
{
@@ -334,7 +355,9 @@ namespace CliFx.Domain
CommandSchema command,
IReadOnlyDictionary<CommandArgumentSchema, object?> defaultValues)
{
var childCommands = root.GetChildCommands(command.Name);
var commandName = command.Name;
var childCommands = root.GetChildCommands(commandName);
var descendantCommands = root.GetDescendantCommands(commandName);
_console.ResetColor();
@@ -342,7 +365,7 @@ namespace CliFx.Domain
WriteApplicationInfo();
WriteCommandDescription(command);
WriteCommandUsage(command, childCommands);
WriteCommandUsage(command, descendantCommands);
WriteCommandParameters(command);
WriteCommandOptions(command, defaultValues);
WriteCommandChildren(command, childCommands);
@@ -385,4 +408,4 @@ namespace CliFx.Domain
}
}
}
}
}