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

Customized help output for command flags #37

Closed
childish-sambino opened this issue Apr 22, 2019 · 4 comments · Fixed by #40
Closed

Customized help output for command flags #37

childish-sambino opened this issue Apr 22, 2019 · 4 comments · Fixed by #40

Comments

@childish-sambino
Copy link
Contributor

All of our commands inherit from a common base command that introduce two standard flags. It is possible for plugins to duplicate these flags (particularly, dynamically generated commands based on an Open API spec). Since they are global flags (and advanced usage patterns), we'd like to limit them to utilize single-character short form only and either hide the long form from help output or disallow it entirely. The other option is to use a more verbose name, but we don't like the UX of that either.

PR and some comments here: oclif/parser#47

Feedback provided that this is not a good UX pattern on its own and a more powerful alternative is to support help overrides/templates that would allow for customizing flag help output.

This would support our needs.

@childish-sambino
Copy link
Contributor Author

Considering adding a helpName (or helpLabel) flag option that takes the place of everything to the left of the =, similar to how helpValue works for the right side of the =. This would allow for effectively hiding either the short or longer flag option from the help, but still support both.

@childish-sambino
Copy link
Contributor Author

@jdxcode Is this something you're willing to support in oclif? It would help to unblock us.

@jdx
Copy link
Contributor

jdx commented Apr 25, 2019

@childish-sambino I'm stepping down from Heroku/oclif but @RasPhilCo should be able to assist

@RasPhilCo
Copy link
Contributor

@childish-sambino I've merge above && created an issue for broader help templating

#39

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

Successfully merging a pull request may close this issue.

3 participants