Releases · nuxt/test-utils

compare changes

🚀 Enhancements

e2e: Add cucumber test runner (#711)
e2e: Support env option for startServer (#640)

🩹 Fixes

runtime-utils: Resolve to in RouterLink stub (#687)
Mark afterAll and setup hooks as async (#702)
module: Always append import when mocking (#701)

🏡 Chore

Add required dev deps to app-vitest example (#712)
Pin vue/nuxt versions (00674cd0)

✅ Tests

Update config key (25060645)
Add example test for nuxt-injected value (#663)
Update to actually use $t (#675)

🤖 CI

Fetch-depth: 0 (269df289)

❤️ Contributors

Bobbie Goede (@BobbieGoede)
Daniel Roe (@danielroe)
Julien Huang (@huang-julien)
Albert Brand (@AlbertBrand)
Steve Pewsey (@StevenPewsey)

👀 Highlights

v3.9.0 is a significant release of @nuxt/test-utils. Most notably:

We've split it out from the core nuxt/nuxt repository for a decoupled release cycle.
We've merged in nuxt-vitest and vitest-environment-nuxt into a single repository for both runtime unit testing and e2e/browser testing with Nuxt.
We've added documentation on https://nuxt.com/docs/getting-started/testing to get you started.

✅ Upgrading

... from `@nuxt/test-utils`

If you were upgrading from @nuxt/test-utils, the only significant change is to update your imports to @nuxt/test-utils/e2e (for clarity).

If you were using the jest runner, this should now be auto-detected and you can remove runner: 'jest' from your test configuration.

... from `nuxt-vitest`

If you previously used nuxt-vitest, we have now merged it into @nuxt/test-utils, as well as implementing a range of fixes.

👉 Here are the required steps.

Uninstall nuxt-vitest
```
npm remove nuxt-vitest
```

Update your vitest versions to v1, and update @nuxt/test-utils and vitest-environment-nuxt to the latest versions:

  "devDependencies": {
-   "@nuxt/test-utils": "^3.8.1",
+   "@nuxt/test-utils": "^3.9.0",
-   "@vitest/coverage-v8": "0.33.0",
+   "@vitest/coverage-v8": "^1.0.4",
    "@vue/test-utils": "^2.4.3",
-   "nuxt-vitest": "^0.11.5",
-   "vitest": "^0.33.0",
+   "vitest": "^1.0.4",
+   "vitest-environment-nuxt": "^1.0.0"
  },

Update your nuxt.config if you have added the nuxt-vitest module to it, and update the configuration from vitest to testUtils:

  export default defineNuxtConfig({
   modules: [
-    'nuxt-vitest'
+    '@nuxt/test-utils/module'
   ],
-  vitest: {}
+  testUtils: {}
  })

Update any imports from nuxt-vitest and vitest-environment-nuxt and @nuxt/test-utils:

-  import { mountSuspended } from 'nuxt-vitest/utils' // or 'vitest-environment-nuxt/utils'
+  import { mountSuspended } from '@nuxt/test-utils/runtime'

-  import { defineVitestConfig } from 'vitest-environment-nuxt/config' // or 'nuxt-vitest/config'
+  import { defineVitestConfig } from '@nuxt/test-utils/config'

-  import { setup, $fetch } from '@nuxt/test-utils'
+  import { setup, $fetch } from '@nuxt/test-utils/e2e'

Ensure vitest is running in a module context (either by checking you have type: 'module' set in your package.json, or by renaming your vitest.config file to vitest.config.mts or vitest.config.mjs.