iamarcel/dotnet-core-neat-console-starter

Starter kit for neatly structured neat .NET Core Console / Command Line Apps

.NET Core Neat Console Starter

This is a starting point for creating neatly structured .NET Core console apps in C#, using the Microsoft.Extensions.CommandLineUtils package to parse the commands.

I created this working as a student with 4DVision, who create custom software for complex processes of companies and organizations.

Adding a command

GreetCommand is an example of a command, see Commands/GreetCommand.cs.

1. Create a new class for your command, eg. Commands.ListCommand
2. Register the command in the RootCommand like this:

app.Command("list", c => ListCommand.Configure(c, options));

3. Profit!

Adding a global option

IsEnthousiastic is an example of a global option.

1. Add the property to CommandLineOptions
2. Add a call to app.Option or app.Argument in CommandLineOptions.Parse and store the result
3. Store the property in options at the bottom of CommandLineOptions.Parse

Learn more

• Article: Creating Neat .NET Core Console Apps
• Article: Structuring Neat .NET Core Console Apps Neatly

dotnet-core-neat-console-starter's Issues

Global option: not recognized (with repro)

I'm trying to use a slightly modified version of your wonderful template, but when I setup a global option I always get a parsing error when I do app.Execute() (CommandParsingException), telling me that this is an unrecognized option. Yet, by inspecting the app Options property I can confirm it's defined there.

I created a full repro solution here:

https://1drv.ms/u/s!AsHCfliT740PkL4XO4_5wmWGV9NBRA

This has been changed a bit to include configuration and DI, and apart from the global options it works fine. Just launch with the arguments sample -c -g (where -g is the global option) to get the exception. This is the code throwing the error:

public static AppOptions Parse(string[] args)
{
    if (args == null) throw new ArgumentNullException(nameof(args));

    AppOptions options = new AppOptions();
    CommandLineApplication app = new CommandLineApplication
    {
        Name = "Test",
        FullName = "Test"
    };
    app.HelpOption("-?|-h|--help");

    // app-level options
    CommandOption globalOption = app.Option("--global|-g",
        "Some global option",
        CommandOptionType.NoValue);

    RootCommand.Configure(app, options);

    if (globalOption.HasValue()) options.HasGlobalOption = true;

    int result = app.Execute(args);
    if (result != 0) return null;

    return options;
}

Any suggestion?