mirror of
https://github.com/nsnail/spectre.console.git
synced 2025-04-16 00:42:51 +08:00

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.
111 lines
3.9 KiB
C#
111 lines
3.9 KiB
C#
namespace Spectre.Console.Cli;
|
|
|
|
internal sealed class Configurator<TSettings> : IUnsafeBranchConfigurator, IConfigurator<TSettings>
|
|
where TSettings : CommandSettings
|
|
{
|
|
private readonly ConfiguredCommand _command;
|
|
private readonly ITypeRegistrar? _registrar;
|
|
|
|
public Configurator(ConfiguredCommand command, ITypeRegistrar? registrar)
|
|
{
|
|
_command = command;
|
|
_registrar = registrar;
|
|
}
|
|
|
|
public void SetDescription(string description)
|
|
{
|
|
_command.Description = description;
|
|
}
|
|
|
|
public void AddExample(params string[] args)
|
|
{
|
|
_command.Examples.Add(args);
|
|
}
|
|
|
|
public void SetDefaultCommand<TDefaultCommand>()
|
|
where TDefaultCommand : class, ICommandLimiter<TSettings>
|
|
{
|
|
var defaultCommand = ConfiguredCommand.FromType<TDefaultCommand>(
|
|
CliConstants.DefaultCommandName, isDefaultCommand: true);
|
|
|
|
_command.Children.Add(defaultCommand);
|
|
}
|
|
|
|
public void HideBranch()
|
|
{
|
|
_command.IsHidden = true;
|
|
}
|
|
|
|
public ICommandConfigurator AddCommand<TCommand>(string name)
|
|
where TCommand : class, ICommandLimiter<TSettings>
|
|
{
|
|
var command = ConfiguredCommand.FromType<TCommand>(name, isDefaultCommand: false);
|
|
var configurator = new CommandConfigurator(command);
|
|
|
|
_command.Children.Add(command);
|
|
return configurator;
|
|
}
|
|
|
|
public ICommandConfigurator AddDelegate<TDerivedSettings>(string name, Func<CommandContext, TDerivedSettings, int> func)
|
|
where TDerivedSettings : TSettings
|
|
{
|
|
var command = ConfiguredCommand.FromDelegate<TDerivedSettings>(
|
|
name, (context, settings) => Task.FromResult(func(context, (TDerivedSettings)settings)));
|
|
|
|
_command.Children.Add(command);
|
|
return new CommandConfigurator(command);
|
|
}
|
|
|
|
public ICommandConfigurator AddAsyncDelegate<TDerivedSettings>(string name, Func<CommandContext, TDerivedSettings, Task<int>> func)
|
|
where TDerivedSettings : TSettings
|
|
{
|
|
var command = ConfiguredCommand.FromDelegate<TDerivedSettings>(
|
|
name, (context, settings) => func(context, (TDerivedSettings)settings));
|
|
|
|
_command.Children.Add(command);
|
|
return new CommandConfigurator(command);
|
|
}
|
|
|
|
public IBranchConfigurator AddBranch<TDerivedSettings>(string name, Action<IConfigurator<TDerivedSettings>> action)
|
|
where TDerivedSettings : TSettings
|
|
{
|
|
var command = ConfiguredCommand.FromBranch<TDerivedSettings>(name);
|
|
action(new Configurator<TDerivedSettings>(command, _registrar));
|
|
var added = _command.Children.AddAndReturn(command);
|
|
return new BranchConfigurator(added);
|
|
}
|
|
|
|
ICommandConfigurator IUnsafeConfigurator.AddCommand(string name, Type command)
|
|
{
|
|
var method = GetType().GetMethod("AddCommand");
|
|
if (method == null)
|
|
{
|
|
throw new CommandConfigurationException("Could not find AddCommand by reflection.");
|
|
}
|
|
|
|
method = method.MakeGenericMethod(command);
|
|
|
|
if (!(method.Invoke(this, new object[] { name }) is ICommandConfigurator result))
|
|
{
|
|
throw new CommandConfigurationException("Invoking AddCommand returned null.");
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
IBranchConfigurator IUnsafeConfigurator.AddBranch(string name, Type settings, Action<IUnsafeBranchConfigurator> action)
|
|
{
|
|
var command = ConfiguredCommand.FromBranch(settings, name);
|
|
|
|
// Create the configurator.
|
|
var configuratorType = typeof(Configurator<>).MakeGenericType(settings);
|
|
if (!(Activator.CreateInstance(configuratorType, new object?[] { command, _registrar }) is IUnsafeBranchConfigurator configurator))
|
|
{
|
|
throw new CommandConfigurationException("Could not create configurator by reflection.");
|
|
}
|
|
|
|
action(configurator);
|
|
var added = _command.Children.AddAndReturn(command);
|
|
return new BranchConfigurator(added);
|
|
}
|
|
} |