HelpProvider Class

The help provider for Spectre.Console. 
public class HelpProvider : IHelpProvider

Remarks

Other IHelpProvider implementations can be injected into the CommandApp, if desired.

Constructors

HelpProvider(ICommandAppSettings)
Initializes a new instance of the HelpProvider class.

Properties

protected virtual int MaximumIndirectExamples
Gets a value indicating how many examples from direct children to show in the help text.
protected virtual bool RenderMarkupInline
Gets a value indicating whether to emit the markup styles, inline, when rendering the help text.
protected virtual bool ShowOptionDefaultValues
Gets a value indicating whether any default values for command options are shown in the help text.
protected virtual bool TrimTrailingPeriod
Gets a value indicating whether a trailing period of a description is trimmed in the help text.

Methods

virtual IEnumerable<IRenderable> GetArguments(ICommandModel, ICommandInfo)
Gets the arguments section of the help information.
virtual IEnumerable<IRenderable> GetCommands(ICommandModel, ICommandInfo)
Gets the commands section of the help information.
virtual IEnumerable<IRenderable> GetDescription(ICommandModel, ICommandInfo)
Gets the description section of the help information.
virtual IEnumerable<IRenderable> GetExamples(ICommandModel, ICommandInfo)
Gets the examples section of the help information.
virtual IEnumerable<IRenderable> GetFooter(ICommandModel, ICommandInfo)
Gets the footer for the help information.
virtual IEnumerable<IRenderable> GetHeader(ICommandModel, ICommandInfo)
Gets the header for the help information.
virtual IEnumerable<IRenderable> GetOptions(ICommandModel, ICommandInfo)
Gets the options section of the help information.
virtual IEnumerable<IRenderable> GetUsage(ICommandModel, ICommandInfo)
Gets the usage section of the help information.
virtual IEnumerable<IRenderable> Write(ICommandModel, ICommandInfo)
Writes help information for the application.

Extension Methods

T And<HelpProvider>(Action<HelpProvider>)
Performs the specified action on the given object and then returns the object. Useful for fluent testing patterns where additional assertions or operations are chained together in a readable manner.