Class ConventionBuilderExtensions

Namespace

McMaster.Extensions.CommandLineUtils

Assembly

McMaster.Extensions.CommandLineUtils.dll

Methods for adding commonly used conventions

public static class ConventionBuilderExtensions

Inheritance

object

ConventionBuilderExtensions

Methods

SetAppNameFromEntryAssembly(IConventionBuilder)

Sets Name to match the name of GetEntryAssembly()

public static IConventionBuilder SetAppNameFromEntryAssembly(this IConventionBuilder builder)

Parameters

builder IConventionBuilder

The builder.

Returns

IConventionBuilder

The builder.

SetParentPropertyOnModel(IConventionBuilder)

Sets a property named "Parent" on the model type to the value of the model of the parent command.

public static IConventionBuilder SetParentPropertyOnModel(this IConventionBuilder builder)

Parameters

builder IConventionBuilder

The builder.

Returns

IConventionBuilder

The builder.

SetRemainingArgsPropertyOnModel(IConventionBuilder)

Sets a property named "RemainingArgs" or "RemainingArguments" on the model type to the value of RemainingArguments.

public static IConventionBuilder SetRemainingArgsPropertyOnModel(this IConventionBuilder builder)

Parameters

builder IConventionBuilder

The builder.

Returns

IConventionBuilder

The builder.

SetSubcommandPropertyOnModel(IConventionBuilder)

Sets a property named "Subcommand" on the model type to the value of the model of the selected subcommand.

public static IConventionBuilder SetSubcommandPropertyOnModel(this IConventionBuilder builder)

Parameters

builder IConventionBuilder

The builder.

Returns

IConventionBuilder

The builder.

UseArgumentAttributes(IConventionBuilder)

Applies settings from ArgumentAttribute on the model type.

public static IConventionBuilder UseArgumentAttributes(this IConventionBuilder builder)

Parameters

builder IConventionBuilder

The builder.

Returns

IConventionBuilder

The builder.

UseAttributes(IConventionBuilder)

Applies a collection of default conventions, such as applying options in attributes on the model type,

public static IConventionBuilder UseAttributes(this IConventionBuilder builder)

Parameters

builder IConventionBuilder

Returns

IConventionBuilder

The builder.

UseCommandAttribute(IConventionBuilder)

Applies settings from CommandAttribute on the model type.

public static IConventionBuilder UseCommandAttribute(this IConventionBuilder builder)

Parameters

builder IConventionBuilder

The builder.

Returns

IConventionBuilder

The builder.

UseCommandNameFromModelType(IConventionBuilder)

Sets the subcommand name using the model type, if available and not otherwise set using CommandAttribute.

public static IConventionBuilder UseCommandNameFromModelType(this IConventionBuilder builder)

Parameters

builder IConventionBuilder

Returns

IConventionBuilder

UseConstructorInjection(IConventionBuilder)

Enables using constructor injection to initialize the model type.

public static IConventionBuilder UseConstructorInjection(this IConventionBuilder builder)

Parameters

builder IConventionBuilder

Returns

IConventionBuilder

UseConstructorInjection(IConventionBuilder, IServiceProvider)

Enables using constructor injection to initialize the model type.

public static IConventionBuilder UseConstructorInjection(this IConventionBuilder builder, IServiceProvider additionalServices)

Parameters

builder IConventionBuilder

additionalServices IServiceProvider

Additional services that should be passed to the service provider.

Returns

IConventionBuilder

UseDefaultConventions(IConventionBuilder)

Applies a collection of default conventions, such as applying options in attributes on the model type,

public static IConventionBuilder UseDefaultConventions(this IConventionBuilder builder)

Parameters

builder IConventionBuilder

Returns

IConventionBuilder

The builder.

UseDefaultHelpOption(IConventionBuilder, string)

Adds --help option, if there isn't already a help flag set.

public static IConventionBuilder UseDefaultHelpOption(this IConventionBuilder builder, string template = "-?|-h|--help")

Parameters

builder IConventionBuilder

The builder.

template string

The help template. Defaults to -?|-h|--help.

Returns

IConventionBuilder

The builder.

UseHelpOptionAttribute(IConventionBuilder)

Applies settings from HelpOptionAttribute on the model type.

public static IConventionBuilder UseHelpOptionAttribute(this IConventionBuilder builder)

Parameters

builder IConventionBuilder

The builder.

Returns

IConventionBuilder

The builder.

UseOnExecuteMethodFromModel(IConventionBuilder)

Sets a method named "OnExecute" or "OnExecuteAsync" on the model type to handle OnExecute(Func<int>)

public static IConventionBuilder UseOnExecuteMethodFromModel(this IConventionBuilder builder)

Parameters

builder IConventionBuilder

The builder.

Returns

IConventionBuilder

The builder.

UseOnValidateMethodFromModel(IConventionBuilder)

Invokes a method named "OnValidate" on the model type after parsing.

public static IConventionBuilder UseOnValidateMethodFromModel(this IConventionBuilder builder)

Parameters

builder IConventionBuilder

The builder.

Returns

IConventionBuilder

The builder.

UseOnValidationErrorMethodFromModel(IConventionBuilder)

Invokes a method named "OnValidationError" on the model type when validation fails.

public static IConventionBuilder UseOnValidationErrorMethodFromModel(this IConventionBuilder builder)

Parameters

builder IConventionBuilder

The builder.

Returns

IConventionBuilder

The builder.

UseOptionAttributes(IConventionBuilder)

Applies settings from OptionAttribute on the model type.

public static IConventionBuilder UseOptionAttributes(this IConventionBuilder builder)

Parameters

builder IConventionBuilder

The builder.

Returns

IConventionBuilder

The builder.

UseSubcommandAttributes(IConventionBuilder)

Adds subcommands for each SubcommandAttribute on the model type.

public static IConventionBuilder UseSubcommandAttributes(this IConventionBuilder builder)

Parameters

builder IConventionBuilder

The builder.

Returns

IConventionBuilder

The builder.

UseVersionOptionAttribute(IConventionBuilder)

Applies settings from VersionOptionAttribute on the model type.

public static IConventionBuilder UseVersionOptionAttribute(this IConventionBuilder builder)

Parameters

builder IConventionBuilder

The builder.

Returns

IConventionBuilder

The builder.

UseVersionOptionFromMemberAttribute(IConventionBuilder)

Applies settings from VersionOptionFromMemberAttribute on the model type.

public static IConventionBuilder UseVersionOptionFromMemberAttribute(this IConventionBuilder builder)

Parameters

builder IConventionBuilder

The builder.

Returns

IConventionBuilder

The builder.