mirror of
https://github.com/nsnail/spectre.console.git
synced 2025-04-16 00:42:51 +08:00
131b37fff8
Allow custom help providers * Version option will show in help even with a default command * Reserve `-v` and `--version` as special Spectre.Console command line arguments (nb. breaking change for Spectre.Console users who have a default command with a settings class that uses either of these switches). * Help writer correctly determines if trailing commands exist and whether to display them as optional or mandatory in the usage statement. * Ability to control the number of indirect commands to display in the help text when the command itself doesn't have any examples of its own. Defaults to 5 (for backward compatibility) but can be set to any integer or zero to disable completely. * Significant increase in unit test coverage for the help writer. * Minor grammatical improvements to website documentation.
42 lines
1.1 KiB
C#
42 lines
1.1 KiB
C#
namespace Spectre.Console.Cli.Help;
|
|
|
|
/// <summary>
|
|
/// Represents an executable command.
|
|
/// </summary>
|
|
public interface ICommandInfo : ICommandContainer
|
|
{
|
|
/// <summary>
|
|
/// Gets the name of the command.
|
|
/// </summary>
|
|
string Name { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the description of the command.
|
|
/// </summary>
|
|
string? Description { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether the command is a branch.
|
|
/// </summary>
|
|
bool IsBranch { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether the command is the default command within its container.
|
|
/// </summary>
|
|
bool IsDefaultCommand { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether the command is hidden.
|
|
/// </summary>
|
|
bool IsHidden { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the parameters associated with the command.
|
|
/// </summary>
|
|
IReadOnlyList<ICommandParameter> Parameters { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the parent command, if any.
|
|
/// </summary>
|
|
ICommandInfo? Parent { get; }
|
|
} |