@nuxt/test-utils 3.9.0-alpha.3 → 3.10.0

package/dist/e2e.d.mts

@@ -8,7 +8,7 @@ declare function createBrowser(): Promise<void>;
 declare function getBrowser(): Promise<Browser>;
 declare function createPage(path?: string, options?: BrowserContextOptions): Promise<playwright_core.Page>;
 
-type TestRunner = 'vitest' | 'jest';
+type TestRunner = 'vitest' | 'jest' | 'cucumber';
 interface TestOptions {
     testDir: string;
     fixture: string;
@@ -46,8 +46,8 @@ interface TestContext {
 interface TestHooks {
     beforeEach: () => void;
     afterEach: () => void;
-    afterAll: () => void;
-    setup: () => void;
+    afterAll: () => Promise<void>;
+    setup: () => Promise<void>;
     ctx: TestContext;
 }
 
@@ -65,17 +65,23 @@ declare function mockLogger(): Record<string, Function>;
 declare function loadFixture(): Promise<void>;
 declare function buildFixture(): Promise<void>;
 
-declare function startServer(): Promise<void>;
+interface StartServerOptions {
+    env?: Record<string, unknown>;
+}
+declare function startServer(options?: StartServerOptions): Promise<void>;
 declare function stopServer(): Promise<void>;
 declare function fetch(path: string, options?: any): Promise<Response>;
 declare function $fetch(path: string, options?: FetchOptions): Promise<any>;
 declare function url(path: string): string;
 
+declare function setupCucumber(hooks: TestHooks): Promise<void>;
+
 declare function setupJest(hooks: TestHooks): Promise<void>;
 
 declare function setupVitest(hooks: TestHooks): Promise<void>;
 
 declare const setupMaps: {
+    cucumber: typeof setupCucumber;
     jest: typeof setupJest;
     vitest: typeof setupVitest;
 };
@@ -91,4 +97,4 @@ interface RunTestOptions {
 }
 declare function runTests(opts: RunTestOptions): Promise<void>;
 
-export { $fetch, type RunTestOptions, type TestContext, type TestHooks, type TestOptions, type TestRunner, buildFixture, createBrowser, createPage, createTest, createTestContext, exposeContextToEnv, fetch, getBrowser, isDev, loadFixture, mockFn, mockLogger, recoverContextFromEnv, runTests, setTestContext, setup, setupMaps, startServer, stopServer, url, useTestContext };
+export { $fetch, type RunTestOptions, type StartServerOptions, type TestContext, type TestHooks, type TestOptions, type TestRunner, buildFixture, createBrowser, createPage, createTest, createTestContext, exposeContextToEnv, fetch, getBrowser, isDev, loadFixture, mockFn, mockLogger, recoverContextFromEnv, runTests, setTestContext, setup, setupMaps, startServer, stopServer, url, useTestContext };

package/dist/e2e.d.ts

@@ -8,7 +8,7 @@ declare function createBrowser(): Promise<void>;
 declare function getBrowser(): Promise<Browser>;
 declare function createPage(path?: string, options?: BrowserContextOptions): Promise<playwright_core.Page>;
 
-type TestRunner = 'vitest' | 'jest';
+type TestRunner = 'vitest' | 'jest' | 'cucumber';
 interface TestOptions {
     testDir: string;
     fixture: string;
@@ -46,8 +46,8 @@ interface TestContext {
 interface TestHooks {
     beforeEach: () => void;
     afterEach: () => void;
-    afterAll: () => void;
-    setup: () => void;
+    afterAll: () => Promise<void>;
+    setup: () => Promise<void>;
     ctx: TestContext;
 }
 
@@ -65,17 +65,23 @@ declare function mockLogger(): Record<string, Function>;
 declare function loadFixture(): Promise<void>;
 declare function buildFixture(): Promise<void>;
 
-declare function startServer(): Promise<void>;
+interface StartServerOptions {
+    env?: Record<string, unknown>;
+}
+declare function startServer(options?: StartServerOptions): Promise<void>;
 declare function stopServer(): Promise<void>;
 declare function fetch(path: string, options?: any): Promise<Response>;
 declare function $fetch(path: string, options?: FetchOptions): Promise<any>;
 declare function url(path: string): string;
 
+declare function setupCucumber(hooks: TestHooks): Promise<void>;
+
 declare function setupJest(hooks: TestHooks): Promise<void>;
 
 declare function setupVitest(hooks: TestHooks): Promise<void>;
 
 declare const setupMaps: {
+    cucumber: typeof setupCucumber;
     jest: typeof setupJest;
     vitest: typeof setupVitest;
 };
@@ -91,4 +97,4 @@ interface RunTestOptions {
 }
 declare function runTests(opts: RunTestOptions): Promise<void>;
 
-export { $fetch, type RunTestOptions, type TestContext, type TestHooks, type TestOptions, type TestRunner, buildFixture, createBrowser, createPage, createTest, createTestContext, exposeContextToEnv, fetch, getBrowser, isDev, loadFixture, mockFn, mockLogger, recoverContextFromEnv, runTests, setTestContext, setup, setupMaps, startServer, stopServer, url, useTestContext };
+export { $fetch, type RunTestOptions, type StartServerOptions, type TestContext, type TestHooks, type TestOptions, type TestRunner, buildFixture, createBrowser, createPage, createTest, createTestContext, exposeContextToEnv, fetch, getBrowser, isDev, loadFixture, mockFn, mockLogger, recoverContextFromEnv, runTests, setTestContext, setup, setupMaps, startServer, stopServer, url, useTestContext };

package/dist/e2e.mjs

@@ -1,5 +1,5 @@
-import { u as useTestContext, a as url, c as createTestContext, s as setTestContext, b as stopServer, d as startServer } from './shared/test-utils.B1uaYm8K.mjs';
-export { $ as $fetch, e as exposeContextToEnv, f as fetch, i as isDev, r as recoverContextFromEnv } from './shared/test-utils.B1uaYm8K.mjs';
+import { u as useTestContext, a as url, c as createTestContext, s as setTestContext, b as stopServer, d as startServer } from './shared/test-utils.JYxxBhQl.mjs';
+export { $ as $fetch, e as exposeContextToEnv, f as fetch, i as isDev, r as recoverContextFromEnv } from './shared/test-utils.JYxxBhQl.mjs';
 import { consola } from 'consola';
 import { existsSync, promises } from 'node:fs';
 import { resolve } from 'node:path';
@@ -114,6 +114,14 @@ async function buildFixture() {
   kit.logger.level = prevLevel;
 }
 
+async function setupCucumber(hooks) {
+  const { After, AfterAll, Before, BeforeAll } = await import('@cucumber/cucumber');
+  BeforeAll({ timeout: hooks.ctx.options.setupTimeout }, hooks.setup);
+  Before(hooks.beforeEach);
+  After(hooks.afterEach);
+  AfterAll(hooks.afterAll);
+}
+
 async function setupJest(hooks) {
   const { jest, test, beforeEach, afterAll, afterEach } = await import('@jest/globals');
   hooks.ctx.mockFn = jest.fn;
@@ -133,6 +141,7 @@ async function setupVitest(hooks) {
 }
 
 const setupMaps = {
+  cucumber: setupCucumber,
   jest: setupJest,
   vitest: setupVitest
 };

package/dist/experimental.mjs

@@ -1,6 +1,6 @@
 import { resolve } from 'pathe';
 import { stringifyQuery } from 'ufo';
-import { $ as $fetch, u as useTestContext } from './shared/test-utils.B1uaYm8K.mjs';
+import { $ as $fetch, u as useTestContext } from './shared/test-utils.JYxxBhQl.mjs';
 import 'execa';
 import 'get-port-please';
 import 'ofetch';

package/dist/module.mjs

@@ -1,5 +1,5 @@
 import { pathToFileURL } from 'node:url';
-import { resolvePath, useNuxt, resolveIgnorePatterns, addVitePlugin, defineNuxtModule, createResolver, logger } from '@nuxt/kit';
+import { useNuxt, resolveIgnorePatterns, addVitePlugin, defineNuxtModule, createResolver, resolvePath, logger } from '@nuxt/kit';
 import { mergeConfig } from 'vite';
 import { getPort } from 'get-port-please';
 import { h } from 'vue';
@@ -9,7 +9,6 @@ import { defu } from 'defu';
 import { getVitestConfigFromNuxt } from './config.mjs';
 import { walk } from 'estree-walker';
 import MagicString from 'magic-string';
-import { normalize, resolve } from 'node:path';
 import { createUnplugin } from 'unplugin';
 import { readFileSync } from 'node:fs';
 import { extname, join, dirname } from 'pathe';
@@ -23,10 +22,7 @@ const HELPER_MOCK_COMPONENT = "mockComponent";
 const HELPER_MOCK_HOIST = "__NUXT_VITEST_MOCKS";
 const HELPERS_NAME = [HELPER_MOCK_IMPORT, HELPER_MOCK_COMPONENT];
 const createMockPlugin = (ctx) => createUnplugin(() => {
-  let resolvedFirstSetupFile = null;
   function transform(code, id) {
-    const isFirstSetupFile = normalize(id) === resolvedFirstSetupFile;
-    const shouldPrependMockHoist = resolvedFirstSetupFile ? isFirstSetupFile : true;
     if (!HELPERS_NAME.some((n) => code.includes(n)))
       return;
     if (id.includes("/node_modules/"))
@@ -205,12 +201,10 @@ const createMockPlugin = (ctx) => createUnplugin(() => {
       s.prepend(`import {vi} from "vitest";
 `);
     s.appendLeft(insertionPoint, mockLines.join("\n") + "\n");
-    if (shouldPrependMockHoist) {
-      importPathsList.forEach((p) => {
-        s.append(`
+    importPathsList.forEach((p) => {
+      s.append(`
  import ${JSON.stringify(p)};`);
-      });
-    }
+    });
     return {
       code: s.toString(),
       map: s.generateMap()
@@ -223,10 +217,6 @@ const createMockPlugin = (ctx) => createUnplugin(() => {
       transform,
       // Place Vitest's mock plugin after all Nuxt plugins
       async configResolved(config) {
-        const firstSetupFile = Array.isArray(config.test?.setupFiles) ? config.test.setupFiles.find((p) => !p.includes("runtime/entry")) : config.test?.setupFiles;
-        if (firstSetupFile) {
-          resolvedFirstSetupFile = await resolvePath(normalize(resolve(firstSetupFile)));
-        }
         const plugins = config.plugins || [];
         const vitestPlugins = plugins.filter((p) => (p.name === "vite:mocks" || p.name.startsWith("vitest:")) && (p.enforce || p.order) === "post");
         const lastNuxt = findLastIndex(
@@ -330,7 +320,7 @@ const vitePluginBlocklist = ["vite-plugin-vue-inspector", "vite-plugin-vue-inspe
 const module = defineNuxtModule({
   meta: {
     name: "@nuxt/test-utils",
-    configKey: "vitest"
+    configKey: "testUtils"
   },
   defaults: {
     startOnBoot: false,

package/dist/runtime/nuxt-root.d.ts

@@ -1,4 +1,4 @@
 declare const _default: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
     [key: string]: any;
-}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
 export default _default;

package/dist/runtime-utils/index.d.mts

@@ -19,7 +19,7 @@ type OptionalFunction<T> = T | (() => Awaitable<T>);
  *  test: "test-field"
  * })
  * ```
- * @see https://github.com/danielroe/nuxt-vitest#registerendpoint
+ * @see https://nuxt.com/docs/getting-started/testing#registerendpoint
  */
 declare function registerEndpoint(url: string, options: EventHandler | {
     handler: EventHandler;
@@ -39,7 +39,7 @@ declare function registerEndpoint(url: string, options: EventHandler | {
  *  }
  * })
  * ```
- * @see https://github.com/danielroe/nuxt-vitest#mocknuxtimport
+ * @see https://nuxt.com/docs/getting-started/testing#mocknuxtimport
  */
 declare function mockNuxtImport<T = any>(_name: string, _factory: () => T | Promise<T>): void;
 /**
@@ -72,7 +72,7 @@ declare function mockNuxtImport<T = any>(_name: string, _factory: () => T | Prom
  * // or you can use SFC for redirecting to a mock component
  * mockComponent('MyComponent', () => import('./MockComponent.vue'))
  * ```
- * @see https://github.com/danielroe/nuxt-vitest#mockcomponent
+ * @see https://nuxt.com/docs/getting-started/testing#mockcomponent
  */
 declare function mockComponent<Props, RawBindings = object>(path: string, setup: OptionalFunction<(props: Readonly<Props>, ctx: SetupContext) => RawBindings | RenderFunction>): void;
 declare function mockComponent<Props = {}, RawBindings = {}, D = {}, C extends ComputedOptions = {}, M extends MethodOptions = {}, Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, Extends extends ComponentOptionsMixin = ComponentOptionsMixin, E extends EmitsOptions = {}, EE extends string = string, I extends ComponentInjectOptions = {}, II extends string = string>(path: string, options: OptionalFunction<ComponentOptionsWithoutProps<Props, RawBindings, D, C, M, Mixin, Extends, E, EE, I, II>>): void;

package/dist/runtime-utils/index.d.ts

@@ -19,7 +19,7 @@ type OptionalFunction<T> = T | (() => Awaitable<T>);
  *  test: "test-field"
  * })
  * ```
- * @see https://github.com/danielroe/nuxt-vitest#registerendpoint
+ * @see https://nuxt.com/docs/getting-started/testing#registerendpoint
  */
 declare function registerEndpoint(url: string, options: EventHandler | {
     handler: EventHandler;
@@ -39,7 +39,7 @@ declare function registerEndpoint(url: string, options: EventHandler | {
  *  }
  * })
  * ```
- * @see https://github.com/danielroe/nuxt-vitest#mocknuxtimport
+ * @see https://nuxt.com/docs/getting-started/testing#mocknuxtimport
  */
 declare function mockNuxtImport<T = any>(_name: string, _factory: () => T | Promise<T>): void;
 /**
@@ -72,7 +72,7 @@ declare function mockNuxtImport<T = any>(_name: string, _factory: () => T | Prom
  * // or you can use SFC for redirecting to a mock component
  * mockComponent('MyComponent', () => import('./MockComponent.vue'))
  * ```
- * @see https://github.com/danielroe/nuxt-vitest#mockcomponent
+ * @see https://nuxt.com/docs/getting-started/testing#mockcomponent
  */
 declare function mockComponent<Props, RawBindings = object>(path: string, setup: OptionalFunction<(props: Readonly<Props>, ctx: SetupContext) => RawBindings | RenderFunction>): void;
 declare function mockComponent<Props = {}, RawBindings = {}, D = {}, C extends ComputedOptions = {}, M extends MethodOptions = {}, Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, Extends extends ComponentOptionsMixin = ComponentOptionsMixin, E extends EmitsOptions = {}, EE extends string = string, I extends ComponentInjectOptions = {}, II extends string = string>(path: string, options: OptionalFunction<ComponentOptionsWithoutProps<Props, RawBindings, D, C, M, Mixin, Extends, E, EE, I, II>>): void;

package/dist/runtime-utils/index.mjs

@@ -22,19 +22,22 @@ function registerEndpoint(url, options) {
 }
 function mockNuxtImport(_name, _factory) {
   throw new Error(
-    "mockNuxtImport() is a macro and it did not get transpiled, this may be an internal bug of nuxt-vitest."
+    "mockNuxtImport() is a macro and it did not get transpiled. This may be an internal bug of @nuxt/test-utils."
   );
 }
 function mockComponent(_path, _component) {
   throw new Error(
-    "mockComponent() is a macro and it did not get transpiled, this may be an internal bug of nuxt-vitest."
+    "mockComponent() is a macro and it did not get transpiled. This may be an internal bug of @nuxt/test-utils."
   );
 }
 
 const RouterLink = defineComponent({
   functional: true,
   props: {
-    to: [String, Object],
+    to: {
+      type: [String, Object],
+      required: true
+    },
     custom: Boolean,
     replace: Boolean,
     // Not implemented
@@ -46,11 +49,11 @@ const RouterLink = defineComponent({
     const navigate = () => {
     };
     return () => {
-      const route = props.to ? useRouter().resolve(props.to) : {};
-      return props.custom ? slots.default?.({ href: props.to, navigate, route }) : h(
+      const route = useRouter().resolve(props.to);
+      return props.custom ? slots.default?.({ href: route.href, navigate, route }) : h(
         "a",
         {
-          href: props.to,
+          href: route.href,
           onClick: (e) => {
             e.preventDefault();
             return navigate();

package/dist/shared/{test-utils.B1uaYm8K.mjs → test-utils.JYxxBhQl.mjs}

@@ -53,7 +53,7 @@ function exposeContextToEnv() {
 }
 
 const kit = _kit.default || _kit;
-async function startServer() {
+async function startServer(options = {}) {
   const ctx = useTestContext();
   await stopServer();
   const host = "127.0.0.1";
@@ -70,7 +70,8 @@ async function startServer() {
         // Used by internal _dev command
         PORT: String(port),
         HOST: host,
-        NODE_ENV: "development"
+        NODE_ENV: "development",
+        ...options.env
       }
     });
     await waitForPort(port, { retries: 32, host }).catch(() => {
@@ -98,7 +99,8 @@ async function startServer() {
         ...process.env,
         PORT: String(port),
         HOST: host,
-        NODE_ENV: "test"
+        NODE_ENV: "test",
+        ...options.env
       }
     });
     await waitForPort(port, { retries: 20, host });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxt/test-utils",
-  "version": "3.9.0-alpha.3",
+  "version": "3.10.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nuxt/test-utils.git"
@@ -28,67 +28,69 @@
     "vitest-environment.d.ts"
   ],
   "dependencies": {
-    "@nuxt/kit": "^3.8.2",
-    "@nuxt/schema": "^3.8.2",
-    "c12": "^1.5.1",
+    "@nuxt/kit": "^3.9.3",
+    "@nuxt/schema": "^3.9.3",
+    "c12": "^1.6.1",
     "consola": "^3.2.3",
-    "defu": "^6.1.3",
+    "defu": "^6.1.4",
     "destr": "^2.0.2",
     "estree-walker": "^3.0.3",
     "execa": "^8.0.1",
-    "fake-indexeddb": "^5.0.1",
-    "get-port-please": "^3.1.1",
+    "fake-indexeddb": "^5.0.2",
+    "get-port-please": "^3.1.2",
     "local-pkg": "^0.5.0",
     "magic-string": "^0.30.5",
-    "node-fetch-native": "^1.4.1",
+    "node-fetch-native": "^1.6.1",
     "ofetch": "^1.3.3",
-    "pathe": "^1.1.1",
+    "pathe": "^1.1.2",
     "perfect-debounce": "^1.0.0",
     "radix3": "^1.1.0",
-    "scule": "^1.1.1",
-    "std-env": "^3.6.0",
+    "scule": "^1.2.0",
+    "std-env": "^3.7.0",
     "ufo": "^1.3.2",
-    "unenv": "^1.8.0",
-    "unplugin": "^1.5.1",
-    "vitest-environment-nuxt": "1.0.0-alpha.1"
+    "unenv": "^1.9.0",
+    "unplugin": "^1.6.0",
+    "vitest-environment-nuxt": "^1.0.0"
   },
   "devDependencies": {
+    "@cucumber/cucumber": "10.3.1",
     "@jest/globals": "29.7.0",
-    "@nuxt/devtools": "1.0.6",
+    "@nuxt/devtools": "1.0.8",
     "@nuxt/eslint-config": "0.2.0",
-    "@nuxt/module-builder": "0.5.4",
+    "@nuxt/module-builder": "0.5.5",
     "@testing-library/vue": "8.0.1",
     "@types/estree": "1.0.5",
     "@types/jsdom": "21.1.6",
     "@types/semver": "7.5.6",
-    "@vitest/ui": "1.0.4",
+    "@vitest/ui": "1.1.1",
     "@vue/test-utils": "2.4.3",
     "changelogen": "0.5.5",
     "eslint": "8.56.0",
     "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-jsdoc": "46.9.1",
+    "eslint-plugin-jsdoc": "48.0.2",
     "eslint-plugin-no-only-tests": "3.1.0",
-    "eslint-plugin-unicorn": "49.0.0",
-    "h3": "1.9.0",
+    "eslint-plugin-unicorn": "50.0.1",
+    "h3": "1.10.0",
     "jiti": "1.21.0",
-    "nuxt": "3.8.2",
-    "playwright-core": "1.40.1",
-    "rollup": "4.9.1",
+    "nuxt": "3.9.3",
+    "playwright-core": "1.41.0",
+    "rollup": "4.9.5",
     "semver": "7.5.4",
     "unbuild": "latest",
-    "unimport": "3.6.1",
-    "vite": "5.0.10",
-    "vitest": "latest",
+    "unimport": "3.7.1",
+    "vite": "5.0.11",
+    "vitest": "1.1.1",
     "vue-router": "4.2.5",
-    "vue-tsc": "1.8.25"
+    "vue-tsc": "1.8.27"
   },
   "peerDependencies": {
+    "@cucumber/cucumber": "^10.3.1",
     "@jest/globals": "^29.5.0",
     "@testing-library/vue": "^7.0.0 || ^8.0.1",
     "@vitest/ui": "^0.34.6 || ^1.0.0",
     "@vue/test-utils": "^2.4.2",
     "h3": "*",
-    "happy-dom": "^9.10.9 || ^10.0.0 || ^11.0.0 || ^12.0.0",
+    "happy-dom": "^9.10.9 || ^10.0.0 || ^11.0.0 || ^12.0.0 || ^13.0.0",
     "jsdom": "^22.0.0 || ^23.0.0",
     "playwright-core": "^1.34.3",
     "vite": "*",
@@ -97,6 +99,9 @@
     "vue-router": "^4.0.0"
   },
   "peerDependenciesMeta": {
+    "@cucumber/cucumber": {
+      "optional": true
+    },
     "@testing-library/vue": {
       "optional": true
     },
@@ -123,18 +128,21 @@
     }
   },
   "resolutions": {
+    "@nuxt/schema": "^3.9.3",
+    "@nuxt/kit": "^3.9.3",
     "@nuxt/test-utils": "workspace:*",
-    "rollup": "4.9.1",
-    "vite": "5.0.10"
+    "rollup": "4.9.5",
+    "vite": "5.0.11",
+    "vue": "^3.4.14"
   },
   "engines": {
     "node": "^14.18.0 || >=16.10.0"
   },
-  "packageManager": "pnpm@8.12.1",
+  "packageManager": "pnpm@8.14.1",
   "scripts": {
     "lint": "eslint --ext .vue,.ts,.js,.mjs .",
     "lint:fix": "eslint --ext .vue,.ts,.js,.mjs . --fix",
-    "test:examples": "pnpm -r test",
+    "test:examples": "pnpm -r test --filter !nuxt-app-cucumber && pnpm -r test --filter nuxt-app-cucumber",
     "test:types": "vue-tsc --noEmit",
     "test:unit": "vitest test/unit --run",
     "dev:prepare": "nuxi prepare && unbuild --stub && pnpm -r dev:prepare",