tucnak / climax Goto Github PK

If try tu run a small minimal app with climax, that doesn't have 't' flag defined, I get a panic:

 # ./stellar-stacy serve -t=3
panic: runtime error: invalid memory address or nil pointer dereference
[signal 0xb code=0x1 addr=0x40 pc=0x4814b6]

goroutine 1 [running]:
github.com/tucnak/climax.parseContext(0xc8200a0410, 0x1, 0x1, 0xc82007e260, 0x1, 0x1, 0x1, 0x0, 0x0)
    /home/foo/go/src/github.com/tucnak/climax/context.go:97 +0x496
github.com/tucnak/climax.Application.Run(0x78c890, 0x6, 0x7c1b80, 0x10, 0x821350, 0x13, 0xc8200ba180, 0x1, 0x1, 0x0, ...)
    /home/foo/go/src/github.com/tucnak/climax/application.go:117 +0xa19
main.main()
    /home/foo/go/src/myserver/myroot/stellar-stacy/main.go:21 +0x173

When launching it with a flag that exists, it works fine. The climax.Command structure I used is the one defined on the main github page.

It would be cool if climax could execute a default climax.Command if no parameter is specified on the CLI.

We need a super lightweight syntax of creating simple flag-less commands. Something like this would be great:

app := climax.New("appname")

app.Comm("command", "i am command", func (ctx climax.Context) {
    return 0;
});

I am using this library in my application at https://github.com/parallelcointeam/pod - because it seems to be the most friendly and accessible CLI flags library that exists for Go. However, my application needs some 40-50 separate parameters in most instances of the use of climax and I used a function wrapper to condense the declarations, but the ctx.Is and ctx.Get functions chew up a whole if block per parameter.

I am looking at it, and for the reason that the function that reads off the values from the command line to overlay the configuration struct for the subcommands, I looked closer at the source and noted that the variable and non-variable types have exported names and thus can be iterated.

Of course it is not (that) difficult to write this, but I'm just posting this issue to suggest that it could have an iterator built into it if one defined a map type that contains the pointers to the variables, in the case of variables, and for the nonvariable case, could produce an array containing the handlers associated with the nonvariable flags to enable order sensitivity to the triggers so in the case of a subcommand that terminates, that it can do this from one map literal declaration and the iterator command, and automatically executes it.

I am immediately in the process of refactoring my code's use of this by using an iterator on these maps, I would think that probably the function could be quickly modified to become generic, using a map[string]interface{}, enable the automatic determination of intended variable type, assignment and resolution of the interface to direct explicit type. I am using JSON as the configuration file format also, so I can constrain the types to match JSON in as much as objects go to maps and arrays to slices, then bool, int, float and string.

If there is interest in having a PR for adding this iterator, let me know, and I probably can create an additional source file to go with the library that implements this.

I thought that groups would be subcommands, but it seems they are only for grouping them on the help page. Does climax currently support subcommands? If so, how?

it would be nicer to write:
command -i param1, param2 or command -i param1 param2
rather than:
command -i param1 -i param2

PROTIP: See how it's done in hugo.

We might want to add some min/max arguments count guards as some sugar.

Global flags could be used to define flags that'll be used by all commands. And flags parsing for default handler would be useful too.

If i have only one command to execute, i dont need subcommands.