bilal-fazlani / commanddotnet

A modern framework for building modern CLI apps

Bilal Fazlani

commanddotnet's Issues

value tests

Dependency Injection example?

Hi there,

Great library, I was wondering how you could use dependency injection when calling

AppRunner<Calculator> appRunner = new AppRunner<Calculator>();?

I would like to inject a class in my Calculator class how would I go about doing that?

    class Program
    {
        static int Main(string[] args)
        {          
            //  setup our DI
            var services = new ServiceCollection();            
            services.AddTransient<IHelloService, HelloService>();      
            var serviceProvider = services.BuildServiceProvider();
           
            // ---------------------------------------------------
           // Not sure how to use this ??? 
            var app = serviceProvider.GetService<Calculator>();
            //app.Run(args);
            ///------------------------------------------------

            AppRunner<Calculator> appRunner = new AppRunner<Calculator>();
            return appRunner.Run(args);
        }
    }

Example of what I'm trying to implement:
https://github.com/NLog/NLog.Extensions.Logging/wiki/Getting-started-with-.NET-Core-2---Console-application

Default method can't have parameters

Support different names for commands

Support constructor

Constructor should get executed when application is called without any parameters

Value name is not present in help screen

Generic Host in 2.1

Hi there,

Just wondering if you had thoughts on trying to use the generic host introduced in 2.1 as a way to push through dependencies / logging etc
https://docs.microsoft.com/en-us/aspnet/core/fundamentals/host/generic-host?view=aspnetcore-2.1

Support for nameless arguments / subjects

example : docker run dotnet

dotnet in this case, is the subject or a parameter for which, user did not have to pass any argument name.

Show tabular help information

Call commands from other commands

Great effort with this library, I like the new features you have been implementing

I was wondering how you would go about handling or structuring the following requirement

Say I have 3 commands
Command1, Command2 and All

For my All Command I would like to call Command1 and Command2
Currently I'm able to do this by doing the following:

[DefaultMethod]
public void AllCommand() {
   var command1 = new Command1();
   command1.DoSomethng();
}

While this works, the issue is if Command1 has dependencies IFooService this wouldn't be injected because I'm newing up commmands.

I'm just wondering how you would about structuring such a requirement?

Thanks for your time and effort

Change usage for root app

Hi,

We are running .Net core, and global tools, so we would like to have the option to specify the "Usage:" help text.
Today it's hard coded in AppCreator.cs as: $"dotnet {Assembly.GetEntryAssembly().GetName().Name}.dll";
Would appreciate an option to override this, as the usage is not correct in regards to using global tools.

Best regards

Blocking creating a commanddotnet.ioc.simpleinjector

The ms & autofac ioc extensions reference the internal field AppRunner.DependencyResolver which in turn requires an "[assembly: InternalsVisibleTo("CommandDotNet.IoC.MicrosoftDependencyInjection")]" line. This prevents us from implementation a new ioc tech w/o first getting a PR merged into your master. If enough people adopt this, that class will be littered. Can DependencyResolver be converted to a property with an external setter and a private or internal getter?

PreExecute methods

Hi, I want to say thank you for your library. It deserves many more stars and is just awesome. Almost as good as cobra (go-package)

What I am missing are prehooks and posthooks. My use case:

I have a CLI that connects to a service and all sub commands need to establish a communication with a GRPC service. Would be easier with prehooks: https://github.com/spf13/cobra#prerun-and-postrun-hooks

Usage for commands with subcommands should show example with and without the subcommand

Enhance argument and option details

Issues with 1.1.28 & 2.0.0

Issue 1
dotnet run is showing class name

Issue 2
dotnet run stxxxx showing command garbage and showing current command name at the top

Support for sub-commands

Model support

String parameters show no type

Fill values for parameters

support the following values

• string
• int
• double
• bool
• long
• collections

Type 'Decimal' is not supported'

Just leave this issue here. It was unexpectedly for me that library doesn't support decimal(as type of property in the model). So I hope someone who faced the similar issue can find this issue

Support for flag type parameters

Boolean parameters that don't need any value. If they are present, the value is true implicitly.

Support for enum lists

Autocomplete feature

Let's try n use this library to provide autocomplete for commands & subcommands first. Then if possible, we can incorporate autocomplete for option names too.

Default value of list shows up incorrectly

Support for char

• Support

• Test cases

Providing common behavior to wrap execution of a command

Hi @bilal-fazlani ,

We are adding a framework around your framework to encapsulate common use cases for our infrastructure. We'd like a hook that let's us perform some logic before the command method executes.

We were thinking a delegate on CommandRunner with a signature something like....

object OnRun(RunContext)

public class RunContext { Action RunDelegate {get; set;} AppSettings AppSettings {get; set;} CommandInfo CommandInfo {get; set;} List<ArgumentInfo> ParameterValues {get; set;}

This allows us to wrap the execution of the command in our own logic and also gives us enough metadata about the execution to understand the command.

If you approve of this approach, we can submit a PR for it.

Feature request: Place parameters in the middle.

Hi,
I am not sure if it makes sense, but very often I have commands like

cli gateway get-configuration 1A827Ah66
cli gateway add-x 1A827Ah66

The 1A827Ah66 is an id or longer name and when I have to use multiple commands it is annoying to reenter it all the time. Therefore it would be more convenient to have the following syntax:

cli gateway 1A827Ah66 get-configuration 
cli gateway 1A827Ah66 add-x 

So that I only have to replace the last part. Is it somehow possible?

Support parameter aliases

Support application properties

-? doesn't work

Promp for arguments

Support comma separated multiple values

Convert method and property names to camel case

• Method names
• Property names

Support for validations

Add support for

• type validations
• required valiations
• error messages on validation failures
• appropriate return codes

Nesting Altertnative separate classes? (CA1034 Warning)

Hi there,

I'm currently using nesting commands and was wondering if there was an alternative technique to separating classes.

I did notice that there is warning when using roslyn analysers:
https://msdn.microsoft.com/en-us/library/ms182162.aspx

Severity Code Description Project File Line Suppression State
Warning CA1034 Do not nest type Foo. Alternatively, change its accessibility so that it is not externally visible.

some entities are case in-sensitive

Support for enums

• Support

• Test cases

• Documentation

Show enum values in the help output

It would be nice that enum possible values are shown in the Options help.

Support for descriptions

Add support for

• command descriptions
• parameter descriptions

Version Option

Issues with 1.1.14

Hi there,

Thanks for getting 1.1.14 up, I've done a bit of testing with it and noticed the following issues:

Issue 1 - Commands not lower cased when using [ApplicationMetadata(Name =]
I noticed a minor issue with casing

I have defined my application such as:

AppRunner<FooApplication> appRunner = 
new AppRunner<FooApplication>(new CommandDotNet.Models.AppSettings { Case = Case.LowerCase})
.UseMicrosoftDependencyInjection(serviceProvider);

I have defined my command as follows:
[ApplicationMetadata(Name = "Info",

The command still shows up as Info instead of info

Issue 2 - Version number being printed"
I noticed the version number is being printed when run my application dotnet run. Perhaps it was left for debugging purposes?

Issue 3 - Help commands not showing correctly

    [ApplicationMetadata(Name = "Foo", Description = "Foo Service")]
    public class FooCommand
    {
        [ApplicationMetadata(Name = "Hello", Description = "Hello Service")]
        public async Task<bool> Download([Option]string provider = "abc")
        {

Type mismatch returns exit code 1 instead of 2

Alias & text matching for commands

• Support alias for commands
• Support for string matching for commands

text matching similar to:

    git: 'puhs' is not a git command. See 'git --help'
    
    Did you mean this?
          push

Support for custom return codes

Use C#8's nullable reference type feature to determine if string is required or not

Model support - composing objects to reuse common arguments

In cases where you want ubiquitous arguments (--dryrun, --verbose, --fail-fast, --customer) it would be great to define those only once so we don't have to redefine them for each command. I didn't see a way to do this.

If there isn't a way to do it, I was thinking that with the Model support you've added, if a property of the IArgumentModel class was also of type IArgumentModel, then the framework could create an instance and map those arguments as well.

What do you think?

Support async commands

Add a new attribute - DefaultCommand

When this attribute is present on a method, that method is executed when no command is specified

Show annotated description

• Description for commands
• Description for command arguments
• Description for application