fix: Directly export class, document API. #39
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
BREAKING CHANGE: `test-exclude` now exports a class so it is necessary to use `new TestExclude()` when creating an instance. Fixes istanbuljs#33
JaKXz
approved these changes
Dec 6, 2019
|
This makes sense to me 👍 |
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.
BREAKING CHANGE:
test-excludenow exports a class so it is necessaryto use
new TestExclude()when creating an instance.Fixes #33
@bcoe @SimenB Sorry for the late change but I'm planning to do this mainly because I find it easier to document the API. I'm not opposed to suggestions for how to clearly document the existing API.
The plan is that I will publish updated betas of nyc and babel-plugin-istanbul which pin to
test-exclude@=6.0.0-beta.1before releasing this. Then I will release beta.2 of test-exclude, then update nyc and babel-plugin-istanbul to deal with the new API. According to some data I have@istanbuljs/schemaswhich is used by new betas only has been downloaded 6004 times in the past 30 days, from what I can tell about 1500 of those downloads are not from nyc 15. I think my plan will ensure those users do not see any breakage. I just double-checked, the jest repo will not require any code changes to deal with this change.Thoughts / objections?