feat(add): Add examples to --help
output
#1612
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Uses
yargs
.examples
to add the examples of the readme into the CLI--help
+ also adds an example for the glob caseMotivation and Context
fixes #1608
How Has This Been Tested?
manually by
npm link
-ing and inspecting the output oflerna add --help
Types of changes
Checklist:
If accepted, this method of using
.examples
could be used in the other commands as well.It also could be beneficial to generate the README's as to have a single source of truth.