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

feat(add): Add examples to --help output #1612

Merged
merged 1 commit into from Aug 28, 2018

Conversation

Janpot
Copy link
Contributor

@Janpot Janpot commented Aug 28, 2018

Description

Uses yargs .examples to add the examples of the readme into the CLI --help + also adds an example for the glob case

Motivation and Context

fixes #1608

How Has This Been Tested?

manually by npm link-ing and inspecting the output of lerna add --help

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

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.

Copy link
Member

@evocateur evocateur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Brilliant, thanks!

@evocateur evocateur changed the title Add yargs examples to add command feat(add): Add examples to --help output Aug 28, 2018
@evocateur evocateur merged commit 2ab62c1 into lerna:master Aug 28, 2018
@lock
Copy link

lock bot commented Dec 27, 2018

This thread has been automatically locked because there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@lock lock bot locked as resolved and limited conversation to collaborators Dec 27, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

support adding multiple packages in one command
2 participants