-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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
docs: auto-generate npm usage for each command #4450
docs: auto-generate npm usage for each command #4450
Conversation
The base command file has this snippet for when there is no usage if (!this.constructor.usage) {
usage = `${usage}npm ${this.constructor.name}`
} else { |
This is great! I think if we fix the commands with no |
This PR is reminding me we need to clean those html comments out of the man output so here's that PR #4457 |
This is great. I think all we need now is one more special case for |
My previous requested changes have been resolved, but I'm removing this review since there is still one more change requested.
Good catch. Fixing this asap! |
Oops, looks like it changed the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't even notice it at first but you ALSO fixed the config descriptions to use defaultDescription
which they didn't appear to be doing before.
This is GREAT!!!
Thank y'all for your prompt responses 💖 |
Auto-generate npm usage for each command.
NOTE:
These files seem to lack usage description:
lib/commands/adduserlib/commands/binlib/commands/cilib/commands/completionlib/commands/dedupelib/commands/doctorlib/commands/find-dupeslib/commands/install-ci-testlib/commands/logoutlib/commands/pinglib/commands/rootlib/commands/shrinkwraplib/commands/whoamiEdit:
We now generate default usage information for commands with no usage descriptions.
References
Closes #4189