Separate Vitest-dependent utils into a different entrypoint #173
Conversation
🦋 Changeset detectedLatest commit: 5e9e18a The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
Yeah, that's a pretty subtle moment but makes perfect sense. Thanks!
I don't have any questions except one. Should we cover the fact that @steiger/toolkit/test requires Vitest to be installed (maybe a short note somewhere in README). Not a big deal, we can put this aside until we have full-fledged documentation for plugin creators.
| @@ -4,5 +4,3 @@ export { findAllRecursively } from './find-all-recursively.js' | |||
| export { enableAllRules, createConfigs } from './create-configs.js' | |||
There was a problem hiding this comment.
findAllRecursively still has some references to vitest (import.meta.vitest) and is still imported in @steiger/toolkit. But looks like it shouldn't cause any problems because import.meta.vitest will be "undefined"
There was a problem hiding this comment.
Yeah, I think it should be fine
|
The point about docs is good, but I agree, it can wait until we have some kind of docs :D |
@steiger/toolkithas some utilities to help plugin writers write tests easier. We don't want to force people to use Vitest, so it's marked as an optional peer dependency. However, the file you import when you import@steiger/toolkitcontains an import fromvitest, which fails when you don't have Vitest installed.This PR creates another entrypoint,
@steiger/toolkit/test. Now this entrypoint has all the test utils, and you can only import it if you have Vitest installed. If you don't need test utils, you can import everything else from@steiger/toolkit, no Vitest required.