Skip to content

API overview

Packages are lockstep-versioned. Prefer scoped imports; the untestutils facade re-exports the same APIs for compatibility.

InstallImport
untestutils + @untestutils/vitestCore drivers + Vitest
@untestutils/playwrightPlaywright helpers
@untestutils/nuxt (etc.)Framework factories only when needed

Export map (facade subpaths ≈ scoped packages)

Facade / scopedPurpose
untestutils / @untestutils/coredefineRecipes, drivers
untestutils/vitest / @untestutils/vitestSpecs: test, useHarness, fixtures
untestutils/vitest/plugin / @untestutils/vitest/pluginVitest config plugin
untestutils/playwright / @untestutils/playwrightConfig helpers + test
untestutils/nuxt / @untestutils/nuxtnuxt({ run }), matrix (nitro-aware)
untestutils/utils / @untestutils/utilsCookies, SEO, poll, …
untestutils/perf / @untestutils/perfBuild/load suite (optional peer)
untestutils/ai / @untestutils/aiCodegen (optional peer)
untestutils/vite | next | astro | …Framework factories + matrix (@untestutils/<name>)
untestutils/config / @untestutils/nuxt/configNuxt unit Vitest helpers
untestutils/runtime / @untestutils/nuxt/runtimemountSuspended, mocks, …
untestutils/module / @untestutils/nuxt/moduleNuxt module for unit env
untestutils/vitest-environmentenvironment: 'untestutils'

Package migration (0.5)

WasNow
@untestutils/drivers@untestutils/core (also ./drivers)
@untestutils/runtime@untestutils/nuxt/runtime
@untestutils/config@untestutils/nuxt/config
@untestutils/module@untestutils/nuxt/module

Facade subpaths (untestutils/runtime, untestutils/config, untestutils/module, …) are unchanged. Framework adapters (@untestutils/vite, next, …) stay separate packages.

Companions (*/global-setup, */setup-file, pw-global-*) are injected by plugins — you rarely import them.

CLI: Commands (@untestutils/cli via untestutils bin).

Released under the MIT License.