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

Use Oclif's DocOps Functunality for Usage Strings #964

Open
em-c-rod opened this issue Dec 30, 2022 · 0 comments
Open

Use Oclif's DocOps Functunality for Usage Strings #964

em-c-rod opened this issue Dec 30, 2022 · 0 comments

Comments

@em-c-rod
Copy link
Contributor

em-c-rod commented Dec 30, 2022

These are the standards for writing the CLI inputs: http://docopt.org/
OCLIF has made it so there can be automated usage strings if we update the flags. Here is OCLIF's PR on that: https://github.com/oclif/core/pull/188/files

Update the flags to utilize this new oclif functionality by:

  • making sure the package.json has a version of oclif with updated usage string generation from docops
  • update all command flags long names to use dashes instead of camel case (ex: change logLevel to log-level and so on)
  • update flags to show "exlusive", etc, key words and autogenerate usage strings
  • update README with changes

Also reference #710

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

1 participant