istanbuljs / test-exclude

test for inclusion or exclusion of paths using globs
ISC License
8 stars 12 forks source link

fix: Directly export class, document API. #39

Closed coreyfarrell closed 4 years ago

coreyfarrell commented 4 years ago

BREAKING CHANGE: test-exclude now exports a class so it is necessary to 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.1 before 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/schemas which 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?

SimenB commented 4 years ago

This makes sense to me 👍