microsoft / bedrock-cli

The CLI for Bedrock
https://microsoft.github.io/bedrock-cli/commands/
MIT License
28 stars 12 forks source link

Re-evaluate short flags and multi-word option names on CLI #46

Open sarath-p opened 5 years ago

sarath-p commented 5 years ago

Look at short flags in https://microsoft.github.io/bedrock-cli/commands and

For example, some commands have a short flag -p for --project and others have no short flag.

An effort was started in the past but is out of date here.. Use https://microsoft.github.io/bedrock-cli/commands as the source of truth

A command option should have same the same short flag and multi-word name across all CLI commands to be consistent.

Does this require updates to documentation?: YES!

andrebriggs commented 4 years ago

@mtarng @sarath-p do we have further thoughts on this? Thanks for coming up with the inventory of the current commands. Did we have a proposal on how we want SPK command to look?

sarath-p commented 4 years ago

@andrebriggs - I don't think so but we can come up with a design proposal in the next sprint.

andrebriggs commented 4 years ago

@sarath-p sounds good. Looking forward to it

andrebriggs commented 4 years ago

An effort was started here. Let's iterate on this effort

cc @mtarng @sarath-p