Comand usage, aliases, flags and rules

[navidshaikh]

Lets separate the constant, usage-text, aliases, flags and their respective operations and re-organize them to be usable in command implementations.

Presently, the command implementations defines them all together in the same file.

We should have these items organized properly and imported as needed. This should help in testing as well.

• Command usage text

• Command example text

• Help section structure

• Aliases

• flags

• Common operations

[maximilien]

Do you have an example @navidshaikh?

I asked because if I understood this request correctly, you would have the text moved to a different file or location from the command definition and have a constant in it's place in the definition.

While an interesting suggestion it would result in less readable code --- need to read text file or constant file and code for command.

I kind of like having the command into one place. I can see moving the runE(...) function out into it's own function or even file but the command definition should include all that is needed IMO.

[navidshaikh]

I asked because if I understood this request correctly, you would have the text moved to a different file or location from the command definition and have a constant in it's place in the definition.

That's correct, but in an organized manner, not like a text-file as such.

This came after suggestion from @cppforlife during a PR review.

IMO, keeping the constants part separate from definitions helps being consistent in the help/example language/grammar used across commands.

I do not have an example right now, but I plan to work on this once we have the v0.1 issues sorted.

[maximilien]

IMO, keeping the constants part separate from definitions helps being consistent in the help/example language/grammar used across commands.

I think we should avoid separating text to the code. Separating is premature optimization IMO.

[cppforlife]

This came after suggestion from @cppforlife during a PR review.

curious which suggestion?

[navidshaikh]

curious which suggestion?

@cppforlife It's for aliases, here.

[sixolet]

Let's keep text describing flags with the flags, and command usage with the command for now. It's more readable that way.