@nuxt/docs 3.17.4 → 3.17.6

package/3.api/3.utils/define-nuxt-plugin.md

@@ -0,0 +1,102 @@
+---
+title: "defineNuxtPlugin"
+description: defineNuxtPlugin() is a helper function for creating Nuxt plugins.
+links:
+  - label: Source
+    icon: i-simple-icons-github
+    to: https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/nuxt.ts
+    size: xs
+---
+
+`defineNuxtPlugin` is a helper function for creating Nuxt plugins with enhanced functionality and type safety. This utility normalizes different plugin formats into a consistent structure that works seamlessly within Nuxt's plugin system.
+
+```ts twoslash [plugins/hello.ts]
+export default defineNuxtPlugin((nuxtApp) => {
+  // Doing something with nuxtApp
+})
+```
+
+:read-more{to="/docs/guide/directory-structure/plugins#creating-plugins"}
+
+## Type
+
+```ts
+defineNuxtPlugin<T extends Record<string, unknown>>(plugin: Plugin<T> | ObjectPlugin<T>): Plugin<T> & ObjectPlugin<T>
+
+type Plugin<T> = (nuxt: [NuxtApp](/docs/guide/going-further/internals#the-nuxtapp-interface)) => Promise<void> | Promise<{ provide?: T }> | void | { provide?: T }
+
+interface ObjectPlugin<T> {
+  name?: string
+  enforce?: 'pre' | 'default' | 'post'
+  dependsOn?: string[]
+  order?: number
+  parallel?: boolean
+  setup?: Plugin<T>
+  hooks?: Partial<[RuntimeNuxtHooks](/docs/api/advanced/hooks#app-hooks-runtime)>
+  env?: {
+    islands?: boolean
+  }
+}
+```
+
+## Parameters
+
+**plugin**: A plugin can be defined in two ways:
+1. **Function Plugin**: A function that receives the [`NuxtApp`](/docs/guide/going-further/internals#the-nuxtapp-interface) instance and can return a promise with an potential object with a [`provide`](/docs/guide/directory-structure/plugins#providing-helpers) property if you want to provide a helper on [`NuxtApp`](/docs/guide/going-further/internals#the-nuxtapp-interface) instance.
+2. **Object Plugin**: An object that can include various properties to configure the plugin's behavior, such as `name`, `enforce`, `dependsOn`, `order`, `parallel`, `setup`, `hooks`, and `env`.
+
+| Property           | Type                                                                 | Required | Description                                                                                                     |
+| ------------------ | -------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
+| `name` | `string` | `false` | Optional name for the plugin, useful for debugging and dependency management. |
+| `enforce` | `'pre'` \| `'default'` \| `'post'` | `false` | Controls when the plugin runs relative to other plugins. |
+| `dependsOn` | `string[]` | `false` | Array of plugin names this plugin depends on. Ensures proper execution order. |
+| `order` | `number` | `false` | This allows more granular control over plugin order and should only be used by advanced users. **It overrides the value of `enforce` and is used to sort plugins.** |
+| `parallel` | `boolean` | `false` | Whether to execute the plugin in parallel with other parallel plugins. |
+| `setup` | `Plugin<T>`{lang="ts"}  | `false` | The main plugin function, equivalent to a function plugin. |
+| `hooks` | `Partial<RuntimeNuxtHooks>`{lang="ts"}  | `false` | Nuxt app runtime hooks to register directly. |
+| `env` | `{ islands?: boolean }`{lang="ts"}  | `false` | Set this value to `false` if you don't want the plugin to run when rendering server-only or island components. |
+
+:video-accordion{title="Watch a video from Alexander Lichter about the Object Syntax for Nuxt plugins" videoId="2aXZyXB1QGQ"}
+
+## Examples
+
+### Basic Usage
+
+The example below demonstrates a simple plugin that adds global functionality:
+
+```ts twoslash [plugins/hello.ts]
+export default defineNuxtPlugin((nuxtApp) => {
+  // Add a global method
+  return {
+    provide: {
+      hello: (name: string) => `Hello ${name}!`
+    }
+  }
+})
+```
+
+### Object Syntax Plugin
+
+The example below shows the object syntax with advanced configuration:
+
+```ts twoslash [plugins/advanced.ts]
+export default defineNuxtPlugin({
+  name: 'my-plugin',
+  enforce: 'pre',
+  async setup (nuxtApp) {
+    // Plugin setup logic
+    const data = await $fetch('/api/config')
+    
+    return {
+      provide: {
+        config: data
+      }
+    }
+  },
+  hooks: {
+    'app:created'() {
+      console.log('App created!')
+    }
+  },
+})
+```

package/3.api/4.commands/add.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi add"
+title: "nuxt add"
 description: "Scaffold an entity into your Nuxt application."
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--add-cmd-->
 ```bash [Terminal]
-npx nuxi add <TEMPLATE> <NAME> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--force]
+npx nuxt add <TEMPLATE> <NAME> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--force]
 ```
 <!--/add-cmd-->
 
@@ -39,74 +39,74 @@ Some templates support additional modifier flags to add a suffix (like `.client`
 
 ```bash [Terminal]
 # Generates `/plugins/sockets.client.ts`
-npx nuxi add plugin sockets --client
+npx nuxt add plugin sockets --client
 ```
 
-## `nuxi add component`
+## `nuxt add component`
 
 * Modifier flags: `--mode client|server` or `--client` or `--server`
 
 ```bash [Terminal]
 # Generates `components/TheHeader.vue`
-npx nuxi add component TheHeader
+npx nuxt add component TheHeader
 ```
 
-## `nuxi add composable`
+## `nuxt add composable`
 
 ```bash [Terminal]
 # Generates `composables/foo.ts`
-npx nuxi add composable foo
+npx nuxt add composable foo
 ```
 
-## `nuxi add layout`
+## `nuxt add layout`
 
 ```bash [Terminal]
 # Generates `layouts/custom.vue`
-npx nuxi add layout custom
+npx nuxt add layout custom
 ```
 
-## `nuxi add plugin`
+## `nuxt add plugin`
 
 * Modifier flags: `--mode client|server` or `--client`or `--server`
 
 ```bash [Terminal]
 # Generates `plugins/analytics.ts`
-npx nuxi add plugin analytics
+npx nuxt add plugin analytics
 ```
 
-## `nuxi add page`
+## `nuxt add page`
 
 ```bash [Terminal]
 # Generates `pages/about.vue`
-npx nuxi add page about
+npx nuxt add page about
 ```
 
 ```bash [Terminal]
 # Generates `pages/category/[id].vue`
-npx nuxi add page "category/[id]"
+npx nuxt add page "category/[id]"
 ```
 
-## `nuxi add middleware`
+## `nuxt add middleware`
 
 * Modifier flags: `--global`
 
 ```bash [Terminal]
 # Generates `middleware/auth.ts`
-npx nuxi add middleware auth
+npx nuxt add middleware auth
 ```
 
-## `nuxi add api`
+## `nuxt add api`
 
 * Modifier flags: `--method` (can accept `connect`, `delete`, `get`, `head`, `options`, `patch`, `post`, `put` or `trace`) or alternatively you can directly use `--get`, `--post`, etc.
 
 ```bash [Terminal]
 # Generates `server/api/hello.ts`
-npx nuxi add api hello
+npx nuxt add api hello
 ```
 
-## `nuxi add layer`
+## `nuxt add layer`
 
 ```bash [Terminal]
 # Generates `layers/subscribe/nuxt.config.ts`
-npx nuxi add layer subscribe
+npx nuxt add layer subscribe
 ```

package/3.api/4.commands/analyze.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi analyze"
+title: "nuxt analyze"
 description: "Analyze the production bundle or your Nuxt application."
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--analyze-cmd-->
 ```bash [Terminal]
-npx nuxi analyze [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [--name=<name>] [--no-serve]
+npx nuxt analyze [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [--name=<name>] [--no-serve]
 ```
 <!--/analyze-cmd-->
 

package/3.api/4.commands/build-module.md

@@ -1,5 +1,5 @@
 ---
-title: 'nuxi build-module'
+title: 'nuxt build-module'
 description: 'Nuxt command to build your Nuxt module before publishing.'
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--build-module-cmd-->
 ```bash [Terminal]
-npx nuxi build-module [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--build] [--stub] [--sourcemap] [--prepare]
+npx nuxt build-module [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--build] [--stub] [--sourcemap] [--prepare]
 ```
 <!--/build-module-cmd-->
 

package/3.api/4.commands/build.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi build"
+title: "nuxt build"
 description: "Build your Nuxt application."
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--build-cmd-->
 ```bash [Terminal]
-npx nuxi build [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--prerender] [--preset] [--dotenv] [--envName]
+npx nuxt build [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--prerender] [--preset] [--dotenv] [--envName]
 ```
 <!--/build-cmd-->
 

package/3.api/4.commands/cleanup.md

@@ -1,5 +1,5 @@
 ---
-title: 'nuxi cleanup'
+title: 'nuxt cleanup'
 description: 'Remove common generated Nuxt files and caches.'
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--cleanup-cmd-->
 ```bash [Terminal]
-npx nuxi cleanup [ROOTDIR] [--cwd=<directory>]
+npx nuxt cleanup [ROOTDIR] [--cwd=<directory>]
 ```
 <!--/cleanup-cmd-->
 

package/3.api/4.commands/dev.md

@@ -1,5 +1,5 @@
 ---
-title: 'nuxi dev'
+title: 'nuxt dev'
 description: The dev command starts a development server with hot module replacement at http://localhost:3000
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--dev-cmd-->
 ```bash [Terminal]
-npx nuxi dev [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [--envName] [--no-clear] [--no-fork] [-p, --port] [-h, --host] [--clipboard] [-o, --open] [--https] [--publicURL] [--qr] [--public] [--tunnel] [--sslCert] [--sslKey]
+npx nuxt dev [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [--envName] [--no-clear] [--no-fork] [-p, --port] [-h, --host] [--clipboard] [-o, --open] [--https] [--publicURL] [--qr] [--public] [--tunnel] [--sslCert] [--sslKey]
 ```
 <!--/dev-cmd-->
 
@@ -50,7 +50,7 @@ Option | Default | Description
 
 The port and host can also be set via NUXT_PORT, PORT, NUXT_HOST or HOST environment variables.
 
-Additionally to the above options, `nuxi` can pass options through to `listhen`, e.g. `--no-qr` to turn off the dev server QR code. You can find the list of `listhen` options in the [unjs/listhen](https://github.com/unjs/listhen) docs.
+Additionally to the above options, `@nuxt/cli` can pass options through to `listhen`, e.g. `--no-qr` to turn off the dev server QR code. You can find the list of `listhen` options in the [unjs/listhen](https://github.com/unjs/listhen) docs.
 
 This command sets `process.env.NODE_ENV` to `development`.
 

package/3.api/4.commands/devtools.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi devtools"
+title: "nuxt devtools"
 description: The devtools command allows you to enable or disable Nuxt DevTools on a per-project basis.
 links:
   - label: Source
@@ -10,11 +10,11 @@ links:
 
 <!--devtools-cmd-->
 ```bash [Terminal]
-npx nuxi devtools <COMMAND> [ROOTDIR] [--cwd=<directory>]
+npx nuxt devtools <COMMAND> [ROOTDIR] [--cwd=<directory>]
 ```
 <!--/devtools-cmd-->
 
-Running `nuxi devtools enable` will install the Nuxt DevTools globally, and also enable it within the particular project you are using. It is saved as a preference in your user-level `.nuxtrc`. If you want to remove devtools support for a particular project, you can run `nuxi devtools disable`.
+Running `nuxt devtools enable` will install the Nuxt DevTools globally, and also enable it within the particular project you are using. It is saved as a preference in your user-level `.nuxtrc`. If you want to remove devtools support for a particular project, you can run `nuxt devtools disable`.
 
 ## Arguments
 

package/3.api/4.commands/generate.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi generate"
+title: "nuxt generate"
 description: Pre-renders every route of the application and stores the result in plain HTML files.
 links:
   - label: Source
@@ -10,11 +10,11 @@ links:
 
 <!--generate-cmd-->
 ```bash [Terminal]
-npx nuxi generate [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--preset] [--dotenv] [--envName]
+npx nuxt generate [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--preset] [--dotenv] [--envName]
 ```
 <!--/generate-cmd-->
 
-The `generate` command pre-renders every route of your application and stores the result in plain HTML files that you can deploy on any static hosting services. The command triggers the `nuxi build` command with the `prerender` argument set to `true`
+The `generate` command pre-renders every route of your application and stores the result in plain HTML files that you can deploy on any static hosting services. The command triggers the `nuxt build` command with the `prerender` argument set to `true`
 
 ## Arguments
 

package/3.api/4.commands/info.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi info"
+title: "nuxt info"
 description: The info command logs information about the current or specified Nuxt project.
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--info-cmd-->
 ```bash [Terminal]
-npx nuxi info [ROOTDIR] [--cwd=<directory>]
+npx nuxt info [ROOTDIR] [--cwd=<directory>]
 ```
 <!--/info-cmd-->
 

package/3.api/4.commands/init.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi init"
+title: "create nuxt"
 description: The init command initializes a fresh Nuxt project.
 links:
   - label: Source
@@ -10,11 +10,11 @@ links:
 
 <!--init-cmd-->
 ```bash [Terminal]
-npx nuxi init [DIR] [--cwd=<directory>] [-t, --template] [-f, --force] [--offline] [--preferOffline] [--no-install] [--gitInit] [--shell] [--packageManager]
+npm create nuxt@latest [DIR] [--cwd=<directory>] [-t, --template] [-f, --force] [--offline] [--preferOffline] [--no-install] [--gitInit] [--shell] [--packageManager]
 ```
 <!--/init-cmd-->
 
-The `init` command initializes a fresh Nuxt project using [unjs/giget](https://github.com/unjs/giget).
+The `create-nuxt` command initializes a fresh Nuxt project using [unjs/giget](https://github.com/unjs/giget).
 
 ## Arguments
 

package/3.api/4.commands/module.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi module"
+title: "nuxt module"
 description: "Search and add modules to your Nuxt application with the command line."
 links:
   - label: Source
@@ -8,13 +8,13 @@ links:
     size: xs
 ---
 
-Nuxi provides a few utilities to work with [Nuxt modules](/modules) seamlessly.
+Nuxt provides a few utilities to work with [Nuxt modules](/modules) seamlessly.
 
-## nuxi module add
+## nuxt module add
 
 <!--module-add-cmd-->
 ```bash [Terminal]
-npx nuxi module add <MODULENAME> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--skipInstall] [--skipConfig] [--dev]
+npx nuxt module add <MODULENAME> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--skipInstall] [--skipConfig] [--dev]
 ```
 <!--/module-add-cmd-->
 
@@ -47,14 +47,14 @@ When running the command, it will:
 Installing the [`Pinia`](/modules/pinia) module
 
 ```bash [Terminal]
-npx nuxi module add pinia
+npx nuxt module add pinia
 ```
 
-## nuxi module search
+## nuxt module search
 
 <!--module-search-cmd-->
 ```bash [Terminal]
-npx nuxi module search <QUERY> [--cwd=<directory>] [--nuxtVersion=<2|3>]
+npx nuxt module search <QUERY> [--cwd=<directory>] [--nuxtVersion=<2|3>]
 ```
 <!--/module-search-cmd-->
 
@@ -80,5 +80,5 @@ The command searches for Nuxt modules matching your query that are compatible wi
 **Example:**
 
 ```bash [Terminal]
-npx nuxi module search pinia
+npx nuxt module search pinia
 ```

package/3.api/4.commands/prepare.md

@@ -1,5 +1,5 @@
 ---
-title: 'nuxi prepare'
+title: 'nuxt prepare'
 description: The prepare command creates a .nuxt directory in your application and generates types.
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--prepare-cmd-->
 ```bash [Terminal]
-npx nuxi prepare [ROOTDIR] [--dotenv] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName]
+npx nuxt prepare [ROOTDIR] [--dotenv] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName]
 ```
 <!--/prepare-cmd-->
 

package/3.api/4.commands/preview.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi preview"
+title: "nuxt preview"
 description: The preview command starts a server to preview your application after the build command.
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--preview-cmd-->
 ```bash [Terminal]
-npx nuxi preview [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName] [--dotenv] [-p, --port]
+npx nuxt preview [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName] [--dotenv] [-p, --port]
 ```
 <!--/preview-cmd-->
 
@@ -39,5 +39,5 @@ Option | Default | Description
 This command sets `process.env.NODE_ENV` to `production`. To override, define `NODE_ENV` in a `.env` file or as command-line argument.
 
 ::note
-For convenience, in preview mode, your [`.env`](/docs/guide/directory-structure/env) file will be loaded into `process.env`. (However, in production you will need to ensure your environment variables are set yourself.)
+For convenience, in preview mode, your [`.env`](/docs/guide/directory-structure/env) file will be loaded into `process.env`. (However, in production you will need to ensure your environment variables are set yourself. For example, with Node.js 20+ you could do this by running `node --env-file .env .output/server/index.mjs` to start your server.)
 ::

package/3.api/4.commands/typecheck.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi typecheck"
+title: "nuxt typecheck"
 description: The typecheck command runs vue-tsc to check types throughout your app.
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--typecheck-cmd-->
 ```bash [Terminal]
-npx nuxi typecheck [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>]
+npx nuxt typecheck [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>]
 ```
 <!--/typecheck-cmd-->
 

package/3.api/4.commands/upgrade.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi upgrade"
+title: "nuxt upgrade"
 description: The upgrade command upgrades Nuxt to the latest version.
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--upgrade-cmd-->
 ```bash [Terminal]
-npx nuxi upgrade [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dedupe] [-f, --force] [-ch, --channel=<stable|nightly>]
+npx nuxt upgrade [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dedupe] [-f, --force] [-ch, --channel=<stable|nightly>]
 ```
 <!--/upgrade-cmd-->
 

package/3.api/5.kit/13.logging.md

@@ -36,7 +36,7 @@ function useLogger (tag?: string, options?: Partial<ConsolaOptions>): ConsolaIns
 
 ### Parameters
 
-**`tag`**: A tag to suffix all log messages with.
+**`tag`**: A tag to suffix all log messages with, displayed on the right near the timestamp.
 
 **`options`**: Consola configuration options.
 

package/3.api/5.kit/7.pages.md

@@ -149,7 +149,7 @@ export default defineNuxtModule({
 
     addRouteMiddleware({
       name: 'auth',
-      path: resolve('runtime/auth.ts'),
+      path: resolve('runtime/auth'),
       global: true,
     }, { prepend: true })
   },

package/3.api/6.advanced/1.hooks.md

@@ -68,7 +68,7 @@ Hook                     | Arguments                  | Description
 `nitro:build:public-assets`     | `nitro`                    | Called after copying public assets. Allows modifying public assets before Nitro server is built.
 `prerender:routes`       | `ctx`                      | Allows extending the routes to be pre-rendered.
 `build:error`            | `error`                    | Called when an error occurs at build time.
-`prepare:types`          | `options`                  | Called before Nuxi writes `.nuxt/tsconfig.json` and `.nuxt/nuxt.d.ts`, allowing addition of custom references and declarations in `nuxt.d.ts`, or directly modifying the options in `tsconfig.json`
+`prepare:types`          | `options`                  | Called before `@nuxt/cli` writes `.nuxt/tsconfig.json` and `.nuxt/nuxt.d.ts`, allowing addition of custom references and declarations in `nuxt.d.ts`, or directly modifying the options in `tsconfig.json`
 `listen`                 | `listenerServer, listener` | Called when the dev server is loading.
 `schema:extend`          | `schemas`                  | Allows extending default schemas.
 `schema:resolved`        | `schema`                   | Allows extending resolved schema.
@@ -95,11 +95,11 @@ See [Nitro](https://nitro.build/guide/plugins#available-hooks) for all available
 Hook                   | Arguments             | Description                          | Types
 -----------------------|-----------------------|--------------------------------------|------------------
 `dev:ssr-logs`         | `{ path, logs }`      | Server                               | Called at the end of a request cycle with an array of server-side logs.
-`render:response`      | `response, { event }` | Called before sending the response.  | [response](https://github.com/nuxt/nuxt/blob/71ef8bd3ff207fd51c2ca18d5a8c7140476780c7/packages/nuxt/src/core/runtime/nitro/renderer.ts#L24), [event](https://github.com/unjs/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
-`render:html`          | `html, { event }`     | Called before constructing the HTML. | [html](https://github.com/nuxt/nuxt/blob/71ef8bd3ff207fd51c2ca18d5a8c7140476780c7/packages/nuxt/src/core/runtime/nitro/renderer.ts#L15), [event](https://github.com/unjs/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
-`render:island`        | `islandResponse, { event, islandContext }` | Called before constructing the island HTML. | [islandResponse](https://github.com/nuxt/nuxt/blob/e50cabfed1984c341af0d0c056a325a8aec26980/packages/nuxt/src/core/runtime/nitro/renderer.ts#L28), [event](https://github.com/unjs/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38), [islandContext](https://github.com/nuxt/nuxt/blob/e50cabfed1984c341af0d0c056a325a8aec26980/packages/nuxt/src/core/runtime/nitro/renderer.ts#L38)
+`render:response`      | `response, { event }` | Called before sending the response.  | [response](https://github.com/nuxt/nuxt/blob/71ef8bd3ff207fd51c2ca18d5a8c7140476780c7/packages/nuxt/src/core/runtime/nitro/renderer.ts#L24), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
+`render:html`          | `html, { event }`     | Called before constructing the HTML. | [html](https://github.com/nuxt/nuxt/blob/71ef8bd3ff207fd51c2ca18d5a8c7140476780c7/packages/nuxt/src/core/runtime/nitro/renderer.ts#L15), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
+`render:island`        | `islandResponse, { event, islandContext }` | Called before constructing the island HTML. | [islandResponse](https://github.com/nuxt/nuxt/blob/e50cabfed1984c341af0d0c056a325a8aec26980/packages/nuxt/src/core/runtime/nitro/renderer.ts#L28), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38), [islandContext](https://github.com/nuxt/nuxt/blob/e50cabfed1984c341af0d0c056a325a8aec26980/packages/nuxt/src/core/runtime/nitro/renderer.ts#L38)
 `close`               | -                | Called when Nitro is closed. | -
-`error`               | `error, { event? }`          | Called when an error occurs. | [error](https://github.com/nitrojs/nitro/blob/d20ffcbd16fc4003b774445e1a01e698c2bb078a/src/types/runtime/nitro.ts#L48), [event](https://github.com/unjs/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
-`request`             | `event`        | Called when a request is received. | [event](https://github.com/unjs/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
-`beforeResponse`      | `event, { body }`        | Called before sending the response. | [event](https://github.com/unjs/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38), unknown
-`afterResponse`       | `event, { body }`        | Called after sending the response. | [event](https://github.com/unjs/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38), unknown
+`error`               | `error, { event? }`          | Called when an error occurs. | [error](https://github.com/nitrojs/nitro/blob/d20ffcbd16fc4003b774445e1a01e698c2bb078a/src/types/runtime/nitro.ts#L48), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
+`request`             | `event`        | Called when a request is received. | [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
+`beforeResponse`      | `event, { body }`        | Called before sending the response. | [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38), unknown
+`afterResponse`       | `event, { body }`        | Called after sending the response. | [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38), unknown

package/5.community/4.contribution.md

@@ -52,7 +52,7 @@ Note that `fix:` and `feat:` are for **actual code changes** (that might affect
 
 * ~~`fix: typo`~~ -> `docs: fix typo`
 
-If you are working in a project with a monorepo, like `nuxt/nuxt`, ensure that you specify the main scope of your commit in brackets. For example: `feat(nuxi): add 'do-magic' command`.
+If you are working in a project with a monorepo, like `nuxt/nuxt`, ensure that you specify the main scope of your commit in brackets. For example: `feat(kit): add 'addMagicStuff' utility`.
 
 #### Making the Pull Request
 

package/5.community/6.roadmap.md

@@ -30,8 +30,8 @@ Check [Discussions](https://github.com/nuxt/nuxt/discussions) and [RFCs](https:/
 
 Milestone    | Expected date | Notes                                                                  | Description
 -------------|---------------|------------------------------------------------------------------------|-----------------------
-SEO & PWA    | 2024          | [nuxt/nuxt#18395](https://github.com/nuxt/nuxt/discussions/18395)      | Migrating from [nuxt-community/pwa-module](https://github.com/nuxt-community/pwa-module) for built-in SEO utils and service worker support
-Assets       | 2024          | [nuxt/nuxt#22012](https://github.com/nuxt/nuxt/discussions/22012)      | Allow developers and modules to handle loading third-party assets.
+SEO & PWA    | 2025          | [nuxt/nuxt#18395](https://github.com/nuxt/nuxt/discussions/18395)      | Migrating from [nuxt-community/pwa-module](https://github.com/nuxt-community/pwa-module) for built-in SEO utils and service worker support
+Assets       | 2025          | [nuxt/nuxt#22012](https://github.com/nuxt/nuxt/discussions/22012)      | Allow developers and modules to handle loading third-party assets.
 Translations | -             | [nuxt/translations#4](https://github.com/nuxt/translations/discussions/4) ([request access](https://github.com/nuxt/nuxt/discussions/16054)) | A collaborative project for a stable translation process for Nuxt docs. Currently pending for ideas and documentation tooling support (content v2 with remote sources).
 
 ## Core Modules Roadmap
@@ -40,33 +40,38 @@ In addition to the Nuxt framework, there are modules that are vital for the ecos
 
 Module                              | Status              | Nuxt Support | Repository | Description
 ------------------------------------|---------------------|--------------|------------|-------------------
-[Scripts](https://scripts.nuxt.com) | Public Beta         | 3.x          | [nuxt/scripts](https://github.com/nuxt/scripts) | Easy 3rd party script management.
-Auth Utils                          | Planned             | 3.x          | `nuxt/auth-utils` to be announced | The temporary repository [atinux/nuxt-auth-utils](https://github.com/atinux/nuxt-auth-utils) is available while awaiting its official integration into Nuxt via RFC.
-A11y                                | Planned             | 3.x          | `nuxt/a11y` to be announced | Accessibility hinting and utilities [nuxt/nuxt#23255](https://github.com/nuxt/nuxt/issues/23255)
-Hints                               | Planned             | 3.x          | `nuxt/hints` to be announced | Guidance and suggestions for enhancing development practices.
+[Scripts](https://scripts.nuxt.com) | Public Beta         | 3.x, 4.x     | [nuxt/scripts](https://github.com/nuxt/scripts) | Easy 3rd party script management.
+Auth Utils                          | Planned             | 4.x, 5.x     | `nuxt/auth-utils` to be announced | The temporary repository [atinux/nuxt-auth-utils](https://github.com/atinux/nuxt-auth-utils) is available while awaiting its official integration into Nuxt via RFC.
+A11y                                | Planned             | 4.x, 5.x     | `nuxt/a11y` to be announced | Accessibility hinting and utilities [nuxt/nuxt#23255](https://github.com/nuxt/nuxt/issues/23255)
+Hints                               | Planned             | 4.x, 5.x     | `nuxt/hints` to be announced | Guidance and suggestions for enhancing development practices.
 
 ## Release Cycle
 
 Since January 2023, we've adopted a consistent release cycle for Nuxt, following [semver](https://semver.org). We aim for major framework releases every year, with an expectation of patch releases every week or so and minor releases every month or so. They should never contain breaking changes except within options clearly marked as `experimental`.
 
+We are planning a slight variation from this plan for Nuxt 4 and Nuxt 5. Nuxt 4 will be a stability-focused release containing all `compatibilityVersion: 4` features, and will be followed shortly by Nuxt 5 which will include an upgrade to Nitro v3 and additional changes.
+
+This approach separates breaking changes into manageable phases, allowing for better ecosystem testing and smoother migrations.
+
 ### Ongoing Support for Nuxt
 
-Going forward from v3, we commit to support each major version of Nuxt for a minimum of a year after the last release, and to providing an upgrade path for current users at that point.
+We commit to support each major version of Nuxt for a minimum of six months after the release of the next major version, and to providing an upgrade path for current users at that point.
 
 ### Current Packages
 
 The current active version of [Nuxt](https://nuxt.com) is **v3** which is available as `nuxt` on npm with the `latest` tag.
 
-Nuxt 2 is in maintenance mode and is available on npm with the `2x` tag. It will reach End of Life (EOL) on June 30, 2024.
+Nuxt 2 is in maintenance mode and is available on npm with the `2x` tag. It reached End of Life (EOL) on June 30, 2024.
 
 Each active version has its own nightly releases which are generated automatically. For more about enabling the Nuxt nightly release channel, see [the nightly release channel docs](/docs/guide/going-further/nightly-release-channel).
 
 Release                                 |                                                                                                  | Initial release | End Of Life  | Docs
 ----------------------------------------|---------------------------------------------------------------------------------------------------|-----------------|--------------|-------
-**4.x** (scheduled)                     |                                                                                           | approximately 1 month after release of nitro v3             |              |  
-**3.x** (stable)           | <a href="https://npmjs.com/package/nuxt"><img alt="Nuxt latest 3.x version" src="https://flat.badgen.net/npm/v/nuxt?label=" class="not-prose"></a>            | 2022-11-16      | TBA          | [nuxt.com](/docs)
-**2.x** (unsupported)      | <a href="https://www.npmjs.com/package/nuxt?activeTab=versions"><img alt="Nuxt 2.x version" src="https://flat.badgen.net/npm/v/nuxt/2x?label=" class="not-prose"></a>         | 2018-09-21      | 2024-06-30   | [v2.nuxt.com](https://v2.nuxt.com/docs)
-**1.x** (unsupported)      | <a href="https://www.npmjs.com/package/nuxt?activeTab=versions"><img alt="Nuxt 1.x version" src="https://flat.badgen.net/npm/v/nuxt/1x?label=" class="not-prose"></a>         | 2018-01-08      | 2019-09-21 | &nbsp;
+**5.x** (scheduled)        |                                                                                                                                                                               | Q4 2025 (estimated)   | TBA                          | &nbsp;
+**4.x** (scheduled)        |                                                                                                                                                                               | 2025-06-30 (planned)  | 6 months after 5.x release   | &nbsp;
+**3.x** (stable)           | <a href="https://npmjs.com/package/nuxt"><img alt="Nuxt latest 3.x version" src="https://flat.badgen.net/npm/v/nuxt?label=" class="not-prose"></a>                            | 2022-11-16            | 2025-12-31 (TBC)             | [nuxt.com](/docs)
+**2.x** (unsupported)      | <a href="https://www.npmjs.com/package/nuxt?activeTab=versions"><img alt="Nuxt 2.x version" src="https://flat.badgen.net/npm/v/nuxt/2x?label=" class="not-prose"></a>         | 2018-09-21            | 2024-06-30                   | [v2.nuxt.com](https://v2.nuxt.com/docs)
+**1.x** (unsupported)      | <a href="https://www.npmjs.com/package/nuxt?activeTab=versions"><img alt="Nuxt 1.x version" src="https://flat.badgen.net/npm/v/nuxt/1x?label=" class="not-prose"></a>         | 2018-01-08            | 2019-09-21                   | &nbsp;
 
 ### Support Status