Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

All options should indicate if they're mandatory/optional #108

Closed
scheyal opened this issue Aug 23, 2019 · 2 comments
Closed

All options should indicate if they're mandatory/optional #108

scheyal opened this issue Aug 23, 2019 · 2 comments
Assignees

Comments

@scheyal
Copy link
Contributor

scheyal commented Aug 23, 2019

When displaying help, all commands must specify whether they're mandatory or optional and any default values.

Example

bf SomeCommand
Perform some command....
USAGE
$ bf SomeCommand [SUB-COMMANDS] [OPTIONS]
SUB-COMMANDS
All sub-commands are separated by ':'
$ SubCmd1 Performs sub command
$ SubCmd2 Performs sub command 2
OPTIONS
-x, --xyz Modifies SomeCommand to do xyz [mandatory]
-y, --yzx Modifies SomeCommand to do yzx [optional]
-z, --zxy=number Modifies SomeCommand to do zxy [default=123]

@scheyal
Copy link
Contributor Author

scheyal commented Sep 11, 2019

part of oclif

@scheyal
Copy link
Contributor Author

scheyal commented Nov 22, 2019

But needs to be implemented :)
To summarize, flags should indicate whether they are:
a) Mandatory
b) Optional, and if default value exist, show it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants