Fix yargs global pollution #3863
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Yargs exports a global singleton by default. Using it directly will most likely break testing apps using yargs themselves.
|
|
boneskull
approved these changes
Apr 9, 2019
This was referenced Oct 26, 2019
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 of the Change
Yargs exports a global singleton by default. Using it directly will break testing apps using yargs themselves.
Alternate Designs
I followed the best-practice example in yargs' documentation. One test had to be adjusted slightly, using a separate yargs instance which has been reset: this is what yargs does internally and required, because
run.builder()calls.positional()which cannot be called on the outer yargs instance.Benefits
Makes mocha compatible with other projects depending on yargs.
Possible Drawbacks
If we need access to mocha's yargs instance, we'll have to expose it ourselves, instead of relying on the global one.
I think this should be a bug fix (patch release).