@nuxt/test-utils 3.6.5 → 3.7.1

package/README.md

@@ -1,113 +1,52 @@
+[![Nuxt banner](./.github/assets/banner.svg)](https://nuxt.com)
 
-[![Nuxt banner](./.github/assets/banner.png)](https://nuxt.com)
+# Nuxt
 
-# 👋 Welcome to Nuxt
+<p>
+  <a href="https://www.npmjs.com/package/nuxt"><img src="https://img.shields.io/npm/v/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="Version"></a>
+  <a href="https://www.npmjs.com/package/nuxt"><img src="https://img.shields.io/npm/dm/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="Downloads"></a>
+  <a href="./LICENSE"><img src="https://img.shields.io/github/license/nuxt/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="License"></a>
+  <a href="https://nuxt.com"><img src="https://img.shields.io/badge/Nuxt%20Docs-18181B?logo=nuxt.js" alt="Website"></a>
+  <a href="https://chat.nuxt.dev"><img src="https://img.shields.io/badge/Nuxt%20Discord-18181B?logo=discord" alt="Discord"></a>
+</p>
 
+Nuxt is a free and open-source framework with an intuitive and extendable way to create type-safe, performant and production-grade full-stack web applications and websites with Vue.js.
 
-Nuxt's goal is to make web development intuitive and performant, with a great developer experience.<br>Learn more in the ['What is Nuxt?'](https://nuxt.com/docs/getting-started/introduction) section of our documentation.
+It provides a number of features that make it easy to build fast, SEO-friendly, and scalable web applications, including:
+- Server-side rendering, Static Site Generation or Hybrid Rendering
+- Automatic routing with code-splitting
+- State management
+- SEO Optimization
+- Extandable with [100+ modules](https://nuxt.com/modules)
+- Deployment to a variety of hosting platforms
+- ...[and much more](https://nuxt.com) 🚀
 
+## Getting Started
 
- <p>
-  <a href="https://www.npmjs.com/package/nuxt"><img src="https://img.shields.io/npm/v/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="Version"></a>
-  <a href="https://www.npmjs.com/package/nuxt"><img src="https://img.shields.io/npm/dm/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="Downloads"></a>
-  <a href="./LICENSE"><img src="https://img.shields.io/github/license/nuxt/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="License"></a>
-  <a href="https://nuxt.com"><img src="https://img.shields.io/badge/Open%20Documentation-18181B?logo=nuxt.js" alt="Website"></a>
-  <a href="https://volta.net/nuxt/nuxt?utm_source=nuxt_readme"><img src="https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg" alt="Volta board"></a>
- </p>
-
-<table>
-<thead>
-<tr>
-<th width="2000" colspan="2">
-</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-  <td width="80" align="center" valign="top">
-    <br>
-    <a href="https://nuxt.com/docs"><img src="./.github/assets/documentation.png"></a>
-  </td>
-  <td valign="top">
-    <h3>Documentation</h3>
-    <p>
-      We highly recommend you take a look at <a href="https://nuxt.com">the Nuxt documentation</a> to level up.
-    </p>
-  </td>
-</tr>
-<tr>
-  <td width="80" align="center" valign="top">
-    <br>
-    <a href="https://nuxt.com/modules"><img src="./.github/assets/modules.png"></a>
-  </td>
-  <td valign="top">
-    <h3>Modules</h3>
-    <p>
-      Discover our <a href="https://nuxt.com/modules">list of modules</a> to supercharge your Nuxt project. Created by the Nuxt team and community.
-    </p>
-  </td>
-</tr>
-<tr>
-  <td width="80" align="center" valign="top">
-    <br>
-    <a href="https://nuxt.com/docs/examples/hello-world"><img src="./.github/assets/examples.png"></a>
-  </td>
-  <td>
-    <h3>Examples</h3>
-    <p>
-      Explore different ways of using Nuxt features and get inspired with <a href="https://nuxt.com/docs/examples/hello-world">our list of examples</a>.
-    </p>
-  </td>
-</tr>
-</tbody>
-</table>
-
-<table>
-<thead>
-<tr>
-<th width="2000" colspan="2">
-</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-  <td width="80" align="center" valign="top">
-    <br>
-    <a href="https://nuxt.com/docs/community/reporting-bugs"><img src="./.github/assets/reporting-bugs.png"></a>
-  </td>
-  <td valign="top">
-    <h3>Reporting bugs</h3>
-    <p>
-      Check out the <a href="https://nuxt.com/docs/community/reporting-bugs">Reporting Bugs</a> page.</p>
-    </p>
-  </td>
-</tr>
-<tr>
-  <td width="80" align="center" valign="top">
-    <br>
-    <a href="https://nuxt.com/docs/community/contribution"><img src="./.github/assets/suggestions.png"></a>
-  </td>
-  <td valign="top">
-    <h3>Suggestions</h3>
-    <p>
-      Check out the <a href="https://nuxt.com/docs/community/contribution">Contribution</a> page.
-    </p>
-  </td>
-</tr>
-<tr>
-  <td width="80" align="center" valign="top">
-    <br>
-    <a href="https://nuxt.com/docs/community/getting-help"><img src="./.github/assets/questions.png"></a>
-  </td>
-  <td valign="top">
-    <h3>Questions</h3>
-    <p>
-      Check out the <a href="https://nuxt.com/docs/community/getting-help">Getting Help</a> page.
-    </p>
-  </td>
-</tr>
-</tbody>
-</table>
+Use the following command to create a new starter project. This will create a starter project with all the necessary files and dependencies:
+
+```bash
+npx nuxi@latest nuxi init <my-project>
+```
+
+Discover also [nuxt.new](https://nuxt.new): Open a Nuxt starter on CodeSandbox, StackBlitz or locally to get up and running in a few seconds.
+
+## Documentation
+
+We highly recommend you take a look at the [Nuxt documentation](https://nuxt.com/docs) to level up. It’s a great resource for learning more about the framework. It covers everything from getting started to advanced topics.
+
+## Modules
+
+Discover our [list of modules](https://nuxt.com/modules) to supercharge your Nuxt project, created by the Nuxt team and community.
+
+## Contribute
+
+We invite you to contribute and help improve Nuxt 💚
+
+Here are a few ways you can get involved:
+- **Reporting Bugs:** If you come across any bugs or issues, please check out the [reporting bugs guide](https://nuxt.com/docs/community/reporting-bugs) to learn how to submit a bug report.
+- **Suggestions:** Have ideas to enhance Nuxt? We'd love to hear them! Check out the [contribution guide](https://nuxt.com/docs/community/contribution#creating-an-issue) to share your suggestions.
+- **Questions:** If you have questions or need assistance, the [getting help guide](https://nuxt.com/docs/community/getting-help) provides resources to help you out.
 
 ## Local Development
 

package/dist/experimental.d.mts

@@ -0,0 +1,7 @@
+/**
+ * This is a function to render a component directly with the Nuxt server.
+ */
+declare function $fetchComponent(filepath: string, props?: Record<string, any>): Promise<any>;
+declare function componentTestUrl(filepath: string, props?: Record<string, any>): string;
+
+export { $fetchComponent, componentTestUrl };

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.92e8ff32.mjs';
+import { $ as $fetch, u as useTestContext } from './shared/test-utils.721a126c.mjs';
 import 'execa';
 import 'get-port-please';
 import 'ofetch';

package/dist/index.d.mts

@@ -0,0 +1,89 @@
+import * as playwright_core from 'playwright-core';
+import { Browser, BrowserContextOptions, LaunchOptions } from 'playwright-core';
+import { NuxtConfig, Nuxt } from '@nuxt/schema';
+import { ExecaChildProcess } from 'execa';
+import { FetchOptions } from 'ofetch';
+
+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';
+interface TestOptions {
+    testDir: string;
+    fixture: string;
+    configFile: string;
+    rootDir: string;
+    buildDir: string;
+    nuxtConfig: NuxtConfig;
+    build: boolean;
+    dev: boolean;
+    setupTimeout: number;
+    waitFor: number;
+    browser: boolean;
+    runner: TestRunner;
+    logLevel: number;
+    browserOptions: {
+        type: 'chromium' | 'firefox' | 'webkit';
+        launch?: LaunchOptions;
+    };
+    server: boolean;
+    port?: number;
+}
+interface TestContext {
+    options: TestOptions;
+    nuxt?: Nuxt;
+    browser?: Browser;
+    url?: string;
+    serverProcess?: ExecaChildProcess;
+    mockFn?: Function;
+}
+interface TestHooks {
+    beforeEach: () => void;
+    afterEach: () => void;
+    afterAll: () => void;
+    setup: () => void;
+    ctx: TestContext;
+}
+
+declare function createTestContext(options: Partial<TestOptions>): TestContext;
+declare function useTestContext(): TestContext;
+declare function setTestContext(context: TestContext): TestContext;
+declare function setTestContext(context?: TestContext): TestContext | undefined;
+declare function isDev(): boolean;
+declare function recoverContextFromEnv(): void;
+declare function exposeContextToEnv(): void;
+
+declare function mockFn(): Function | undefined;
+declare function mockLogger(): Record<string, Function>;
+
+declare function loadFixture(): Promise<void>;
+declare function buildFixture(): Promise<void>;
+
+declare function startServer(): 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 setupJest(hooks: TestHooks): Promise<void>;
+
+declare function setupVitest(hooks: TestHooks): Promise<void>;
+
+declare const setupMaps: {
+    jest: typeof setupJest;
+    vitest: typeof setupVitest;
+};
+declare function createTest(options: Partial<TestOptions>): TestHooks;
+declare function setup(options?: Partial<TestOptions>): Promise<void>;
+
+interface RunTestOptions {
+    rootDir: string;
+    dev?: boolean;
+    watch?: boolean;
+    runner?: 'vitest';
+    globalSetup?: boolean;
+}
+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 };

package/dist/index.d.ts

@@ -86,4 +86,4 @@ interface RunTestOptions {
 }
 declare function runTests(opts: RunTestOptions): Promise<void>;
 
-export { $fetch, RunTestOptions, TestContext, TestHooks, TestOptions, 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 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/index.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.92e8ff32.mjs';
-export { $ as $fetch, e as exposeContextToEnv, f as fetch, i as isDev, r as recoverContextFromEnv } from './shared/test-utils.92e8ff32.mjs';
+import { u as useTestContext, a as url, c as createTestContext, s as setTestContext, b as stopServer, d as startServer } from './shared/test-utils.721a126c.mjs';
+export { $ as $fetch, e as exposeContextToEnv, f as fetch, i as isDev, r as recoverContextFromEnv } from './shared/test-utils.721a126c.mjs';
 import { consola } from 'consola';
 import { promises, existsSync } from 'node:fs';
 import { resolve } from 'node:path';

package/dist/shared/{test-utils.92e8ff32.mjs → test-utils.721a126c.mjs}

@@ -61,11 +61,12 @@ async function startServer() {
   ctx.url = "http://127.0.0.1:" + port;
   if (ctx.options.dev) {
     const nuxiCLI = await kit.resolvePath("nuxi/cli");
-    ctx.serverProcess = execa(nuxiCLI, ["dev"], {
+    ctx.serverProcess = execa(nuxiCLI, ["_dev"], {
       cwd: ctx.nuxt.options.rootDir,
       stdio: "inherit",
       env: {
         ...process.env,
+        _PORT: String(port),
         PORT: String(port),
         NITRO_PORT: String(port),
         NODE_ENV: "development"
@@ -73,7 +74,7 @@ async function startServer() {
     });
     await waitForPort(port, { retries: 32 });
     let lastError;
-    for (let i = 0; i < 50; i++) {
+    for (let i = 0; i < 150; i++) {
       await new Promise((resolve2) => setTimeout(resolve2, 100));
       try {
         const res = await $fetch(ctx.nuxt.options.app.baseURL);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxt/test-utils",
-  "version": "3.6.5",
+  "version": "3.7.1",
   "repository": "nuxt/nuxt",
   "license": "MIT",
   "type": "module",
@@ -21,17 +21,17 @@
   "dependencies": {
     "consola": "^3.2.3",
     "defu": "^6.1.2",
-    "execa": "^7.1.1",
-    "get-port-please": "^3.0.1",
-    "ofetch": "^1.1.1",
+    "execa": "^7.2.0",
+    "get-port-please": "^3.0.2",
+    "ofetch": "^1.3.3",
     "pathe": "^1.1.1",
-    "ufo": "^1.1.2",
-    "@nuxt/kit": "3.6.5",
-    "@nuxt/schema": "3.6.5"
+    "ufo": "^1.3.0",
+    "@nuxt/kit": "3.7.1",
+    "@nuxt/schema": "3.7.1"
   },
   "devDependencies": {
-    "@jest/globals": "29.6.0",
-    "playwright-core": "1.35.1",
+    "@jest/globals": "29.6.4",
+    "playwright-core": "1.37.1",
     "unbuild": "latest",
     "vitest": "0.33.0"
   },