@nuxt/docs-nightly 4.2.0-29344661.0b65203b → 4.2.0-29344710.84b82c47

package/1.getting-started/18.upgrade.md

@@ -34,146 +34,6 @@ bun x nuxt upgrade
 
 To use the latest Nuxt build and test features before their release, read about the [nightly release channel](/docs/4.x/guide/going-further/nightly-release-channel) guide.
 
-## Testing Nuxt 5
-
-Nuxt 5 is **currently in development**. Until the release, it is possible to test many of Nuxt 5's breaking changes from Nuxt version 4.2+.
-
-### Opting in to Nuxt 5
-
-First, upgrade Nuxt to the [latest release](https://github.com/nuxt/nuxt/releases).
-
-Then you can set your `future.compatibilityVersion` to match Nuxt 5 behavior:
-
-```ts twoslash [nuxt.config.ts]
-export default defineNuxtConfig({
-  future: {
-    compatibilityVersion: 5,
-  },
-})
-```
-
-When you set your `future.compatibilityVersion` to `5`, defaults throughout your Nuxt configuration will change to opt in to Nuxt v5 behavior, including:
-
-- **Vite Environment API**: Automatically enables the new [Vite Environment API](#migration-to-vite-environment-api) for improved build configuration
-- Other Nuxt 5 improvements and changes as they become available
-
-::note
-This section is subject to change until the final release, so please check back here regularly if you are testing Nuxt 5 using `future.compatibilityVersion: 5`.
-::
-
-Breaking or significant changes will be noted below along with migration steps for backward/forward compatibility.
-
-### Migration to Vite Environment API
-
-🚦 **Impact Level**: Medium
-
-#### What Changed
-
-Nuxt 5 migrates to Vite 6's new [Environment API](https://vite.dev/guide/api-environment), which formalizes the concept of environments and provides better control over configuration per environment.
-
-Previously, Nuxt used separate client and server Vite configurations. Now, Nuxt uses a shared Vite configuration with environment-specific plugins that use the `applyToEnvironment()` method to target specific environments.
-
-::tip
-You can test this feature early by setting `future.compatibilityVersion: 5` (see [Testing Nuxt 5](#testing-nuxt-5)) or by enabling it explicitly with `experimental.viteEnvironmentApi: true`.
-::
-
-**Key changes:**
-
-1. **Deprecated environment-specific `extendViteConfig()`**: The `server` and `client` options in `extendViteConfig()` are deprecated and will show warnings when used.
-
-2. **Changed plugin registration**: Vite plugins registered with `addVitePlugin()` and only targeting one environment (by passing `server: false` or `client: false`) will not have their `config` or `configResolved` hooks called.
-
-3. **Shared configuration**: The `vite:extendConfig` and `vite:configResolved` hooks now work with a shared configuration rather than separate client/server configs.
-
-#### Reasons for Change
-
-The Vite Environment API provides:
-- Better consistency between development and production builds
-- More granular control over environment-specific configuration
-- Improved performance and plugin architecture
-- Support for custom environments beyond just client and server
-
-#### Migration Steps
-
-##### 1. Migrate to use Vite plugins
-
-We would recommend you use a Vite plugin instead of `extendViteConfig`, `vite:configResolved` and `vite:extendConfig`.
-
-```ts
-// Before
-extendViteConfig((config) => {
-  config.optimizeDeps.include.push('my-package')
-}, { server: false })
-
-nuxt.hook('vite:extendConfig' /* or vite:configResolved */, (config, { isClient }) => {
-  if (isClient) {
-    config.optimizeDeps.include.push('my-package')
-  }
-})
-
-// After
-addVitePlugin(() => ({
-  name: 'my-plugin',
-  config (config) {
-    // you can set global vite configuration here
-  },
-  configResolved (config) {
-    // you can access the fully resolved vite configuration here
-  },
-  configEnvironment (name, config) {
-    // you can set environment-specific vite configuration here
-    if (name === 'client') {
-      config.optimizeDeps ||= {}
-      config.optimizeDeps.include ||= []
-      config.optimizeDeps.include.push('my-package')
-    }
-  },
-  applyToEnvironment (environment) {
-    return environment.name === 'client'
-  },
-}))
-```
-
-##### 2. Migrate Vite plugins to use environments
-
-Instead of using `addVitePlugin` with `server: false` or `client: false`, you can instead use the new `applyToEnvironment` hook within your plugin.
-
-```ts
-// Before
-addVitePlugin(() => ({
-  name: 'my-plugin',
-  config (config) {
-    config.optimizeDeps.include.push('my-package')
-  },
-}), { client: false })
-
-// After
-addVitePlugin(() => ({
-  name: 'my-plugin',
-  config (config) {
-    // you can set global vite configuration here
-  },
-  configResolved (config) {
-    // you can access the fully resolved vite configuration here
-  },
-  configEnvironment (name, config) {
-    // you can set environment-specific vite configuration here
-    if (name === 'client') {
-      config.optimizeDeps ||= {}
-      config.optimizeDeps.include ||= []
-      config.optimizeDeps.include.push('my-package')
-    }
-  },
-  applyToEnvironment (environment) {
-    return environment.name === 'client'
-  },
-}))
-```
-
-::read-more{to="https://vite.dev/guide/api-environment" target="_blank"}
-Learn more about Vite's Environment API
-::
-
 ## Migrating to Nuxt 4
 
 Nuxt 4 includes significant improvements and changes. This guide will help you migrate your existing Nuxt 3 application to Nuxt 4.
@@ -250,11 +110,11 @@ Nuxt now defaults to a new directory structure, with backwards compatibility (so
 
 #### What Changed
 
-- the new Nuxt default `srcDir` is `app/` by default, and most things are resolved from there.
-- `serverDir` now defaults to `<rootDir>/server` rather than `<srcDir>/server`
-- `layers/`, `modules/` and `public/` are resolved relative to `<rootDir>` by default
-- if using [Nuxt Content v2.13+](https://github.com/nuxt/content/pull/2649), `content/` is resolved relative to `<rootDir>`
-- a new `dir.app` is added, which is the directory we look for `router.options.ts` and `spa-loading-template.html` - this defaults to `<srcDir>/`
+* the new Nuxt default `srcDir` is `app/` by default, and most things are resolved from there.
+* `serverDir` now defaults to `<rootDir>/server` rather than `<srcDir>/server`
+* `layers/`, `modules/` and `public/` are resolved relative to `<rootDir>` by default
+* if using [Nuxt Content v2.13+](https://github.com/nuxt/content/pull/2649), `content/` is resolved relative to `<rootDir>`
+* a new `dir.app` is added, which is the directory we look for `router.options.ts` and `spa-loading-template.html` - this defaults to `<srcDir>/`
 
 <details>
 
@@ -419,15 +279,15 @@ Now modules are loaded in the correct order:
 2. **Project modules last** (highest priority)
 
 This affects both:
-- Modules defined in the `modules` array in `nuxt.config.ts`
-- Auto-discovered modules from the `modules/` directory
+* Modules defined in the `modules` array in `nuxt.config.ts`
+* Auto-discovered modules from the `modules/` directory
 
 #### Reasons for Change
 
 This change ensures that:
-- Extended layers have lower priority than the consuming project
-- Module execution order matches the intuitive layer inheritance pattern
-- Module configuration and hooks work as expected in multi-layer setups
+* Extended layers have lower priority than the consuming project
+* Module execution order matches the intuitive layer inheritance pattern
+* Module configuration and hooks work as expected in multi-layer setups
 
 #### Migration Steps
 
@@ -534,9 +394,9 @@ export default defineNuxtConfig({
 [Unhead](https://unhead.unjs.io/), used to generate `<head>` tags, has been updated to version 2. While mostly compatible it includes several breaking changes
 for lower-level APIs.
 
-- Removed props: `vmid`, `hid`, `children`, `body`.
-- Promise input no longer supported.
-- Tags are now sorted using Capo.js by default.
+* Removed props: `vmid`, `hid`, `children`, `body`.
+* Promise input no longer supported.
+* Tags are now sorted using Capo.js by default.
 
 #### Migration Steps
 
@@ -544,7 +404,7 @@ The above changes should have minimal impact on your app.
 
 If you have issues you should verify:
 
-- You're not using any of the removed props.
+* You're not using any of the removed props.
 
 ```diff
 useHead({
@@ -557,7 +417,7 @@ useHead({
 })
 ```
 
-- If you're using [Template Params](https://unhead.unjs.io/docs/head/guides/plugins/template-params) or [Alias Tag Sorting](https://unhead.unjs.io/docs/head/guides/plugins/alias-sorting), you will need to explicitly opt in to these features now.
+* If you're using [Template Params](https://unhead.unjs.io/docs/head/guides/plugins/template-params) or [Alias Tag Sorting](https://unhead.unjs.io/docs/head/guides/plugins/alias-sorting), you will need to explicitly opt in to these features now.
 
 ```ts
 import { AliasSortingPlugin, TemplateParamsPlugin } from '@unhead/vue/plugins'
@@ -1055,9 +915,9 @@ Finally, providing code serialization functions directly within Nuxt is not idea
 
 We have raised PRs to update modules using EJS syntax, but if you need to do this yourself, you have three backwards/forwards-compatible alternatives:
 
-- Moving your string interpolation logic directly into `getContents()`.
-- Using a custom function to handle the replacement, such as in https://github.com/nuxt-modules/color-mode/pull/240.
-- Use `es-toolkit/compat` (a drop-in replacement for lodash template), as a dependency of _your_ project rather than Nuxt:
+* Moving your string interpolation logic directly into `getContents()`.
+* Using a custom function to handle the replacement, such as in https://github.com/nuxt-modules/color-mode/pull/240.
+* Use `es-toolkit/compat` (a drop-in replacement for lodash template), as a dependency of _your_ project rather than Nuxt:
 
 ```diff
 + import { readFileSync } from 'node:fs'
@@ -1140,11 +1000,11 @@ There are two approaches:
 Nuxt now generates separate TypeScript configurations for different contexts to provide better type-checking experiences:
 
 1. **New TypeScript configuration files**: Nuxt now generates additional TypeScript configurations:
-   - `.nuxt/tsconfig.app.json` - For your app code (Vue components, composables, etc.)
-   - `.nuxt/tsconfig.server.json` - For your server-side code (Nitro/server directory)  
-   - `.nuxt/tsconfig.node.json` - For your build-time code (modules, `nuxt.config.ts`, etc.)
-   - `.nuxt/tsconfig.shared.json` - For code shared between app and server contexts (like types and non-environment specific utilities)
-   - `.nuxt/tsconfig.json` - Legacy configuration for backward compatibility
+   * `.nuxt/tsconfig.app.json` - For your app code (Vue components, composables, etc.)
+   * `.nuxt/tsconfig.server.json` - For your server-side code (Nitro/server directory)  
+   * `.nuxt/tsconfig.node.json` - For your build-time code (modules, `nuxt.config.ts`, etc.)
+   * `.nuxt/tsconfig.shared.json` - For code shared between app and server contexts (like types and non-environment specific utilities)
+   * `.nuxt/tsconfig.json` - Legacy configuration for backward compatibility
 
 2. **Backward compatibility**: Existing projects that extend `.nuxt/tsconfig.json` will continue to work as before.
 
@@ -1195,9 +1055,9 @@ However, to take advantage of improved type checking, you can opt in to the new
    ```
 
 4. **Move all type augmentations into their appropriate context**:
-   - If you are augmenting types for the app context, move the files to the `app/` directory.
-   - If you are augmenting types for the server context, move the files to the `server/` directory.
-   - If you are augmenting types that are **shared between the app and server**, move the files to the `shared/` directory.
+   * If you are augmenting types for the app context, move the files to the `app/` directory.
+   * If you are augmenting types for the server context, move the files to the `server/` directory.
+   * If you are augmenting types that are **shared between the app and server**, move the files to the `shared/` directory.
 
     ::warning
     Augmenting types from outside the `app/`, `server/`, or `shared/` directories will not work with the new project references setup.
@@ -1237,11 +1097,11 @@ The new configuration provides better type safety and IntelliSense for projects
 
 Four experimental features are no longer configurable in Nuxt 4:
 
-- `experimental.treeshakeClientOnly` will be `true` (default since v3.0)
-- `experimental.configSchema` will be `true` (default since v3.3)
-- `experimental.polyfillVueUseHead` will be `false` (default since v3.4)
-- `experimental.respectNoSSRHeader` will be `false` (default since v3.4)
-- `vite.devBundler` is no longer configurable - it will use `vite-node` by default
+* `experimental.treeshakeClientOnly` will be `true` (default since v3.0)
+* `experimental.configSchema` will be `true` (default since v3.3)
+* `experimental.polyfillVueUseHead` will be `false` (default since v3.4)
+* `experimental.respectNoSSRHeader` will be `false` (default since v3.4)
+* `vite.devBundler` is no longer configurable - it will use `vite-node` by default
 
 #### Reasons for Change
 
@@ -1249,9 +1109,9 @@ These options have been set to their current values for some time and we do not
 
 #### Migration Steps
 
-- `polyfillVueUseHead` is implementable in user-land with [this plugin](https://github.com/nuxt/nuxt/blob/f209158352b09d1986aa320e29ff36353b91c358/packages/nuxt/src/head/runtime/plugins/vueuse-head-polyfill.ts#L10-L11)
+* `polyfillVueUseHead` is implementable in user-land with [this plugin](https://github.com/nuxt/nuxt/blob/f209158352b09d1986aa320e29ff36353b91c358/packages/nuxt/src/head/runtime/plugins/vueuse-head-polyfill.ts#L10-L11)
 
-- `respectNoSSRHeader`is implementable in user-land with [server middleware](https://github.com/nuxt/nuxt/blob/c660b39447f0d5b8790c0826092638d321cd6821/packages/nuxt/src/core/runtime/nitro/no-ssr.ts#L8-L9)
+* `respectNoSSRHeader`is implementable in user-land with [server middleware](https://github.com/nuxt/nuxt/blob/c660b39447f0d5b8790c0826092638d321cd6821/packages/nuxt/src/core/runtime/nitro/no-ssr.ts#L8-L9)
 
 ### Removal of Top-Level `generate` Configuration
 
@@ -1261,8 +1121,8 @@ These options have been set to their current values for some time and we do not
 
 The top-level `generate` configuration option is no longer available in Nuxt 4. This includes all of its properties:
 
-- `generate.exclude` - for excluding routes from prerendering
-- `generate.routes` - for specifying routes to prerender
+* `generate.exclude` - for excluding routes from prerendering
+* `generate.routes` - for specifying routes to prerender
 
 #### Reasons for Change
 

package/2.guide/3.going-further/1.experimental-features.md

@@ -895,27 +895,3 @@ To use this feature, you need to:
 ::read-more{icon="i-simple-icons-github" to="https://github.com/KazariEX/dxup" target="_blank"}
 Learn more about **@dxup/nuxt**.
 ::
-
-## viteEnvironmentApi
-
-Enable Vite 6's new [Environment API](https://vite.dev/guide/api-environment) for improved build configuration and plugin architecture.
-
-When you set `future.compatibilityVersion` to `5`, this feature is enabled by default. You can also enable it explicitly for testing:
-
-```ts twoslash [nuxt.config.ts]
-export default defineNuxtConfig({
-  experimental: {
-    viteEnvironmentApi: true,
-  },
-})
-```
-
-The Vite Environment API provides better consistency between development and production builds, more granular control over environment-specific configuration, and improved performance.
-
-::important
-Enabling this feature changes how Vite plugins are registered and configured. See the [Vite Environment API migration guide](/docs/4.x/getting-started/upgrade#migration-to-vite-environment-api) for details on updating your plugins.
-::
-
-::read-more{to="https://vite.dev/guide/api-environment" target="_blank"}
-Learn more about Vite's Environment API.
-::

package/2.guide/3.going-further/1.features.md

@@ -63,7 +63,7 @@ There is also a `future` namespace for early opting-in to new features that will
 
 This enables early access to Nuxt features or flags.
 
-Setting `compatibilityVersion` to `5` changes defaults throughout your Nuxt configuration to opt in to Nuxt v5 behaviour, including enabling the [Vite Environment API](/docs/4.x/guide/going-further/experimental-features#viteenvironmentapi).
+Setting `compatibilityVersion` to `5` changes defaults throughout your Nuxt configuration to opt-in to Nuxt v5 behaviour.
 
 ```ts
 export default defineNuxtConfig({
@@ -73,10 +73,6 @@ export default defineNuxtConfig({
 })
 ```
 
-::read-more{to="/docs/4.x/getting-started/upgrade#testing-nuxt-5"}
-Learn more about testing Nuxt 5.
-::
-
 ### multiApp
 
 This enables early access to the experimental multi-app support. You can follow the [tracker issue #21635](https://github.com/nuxt/nuxt/issues/21635) to see the progress of multi-app support in Nuxt.

package/2.guide/4.recipes/2.vite-plugin.md

@@ -79,24 +79,6 @@ export default defineNuxtModule({
 })
 ```
 
-For environment-specific plugins in Nuxt 5+, use the `applyToEnvironment()` method:
-
-```ts [modules/my-module.ts]
-import { addVitePlugin, defineNuxtModule } from '@nuxt/kit'
-
-export default defineNuxtModule({
-  setup () {
-    addVitePlugin(() => ({
-      name: 'my-client-plugin',
-      applyToEnvironment (environment) {
-        return environment.name === 'client'
-      },
-      // Plugin configuration
-    }))
-  },
-})
-```
-
 ::important
 If you're writing code that needs to access resolved Vite configuration, you should use the `config` and `configResolved` hooks _within_ your Vite plugin, rather than using Nuxt's `vite:extend`, `vite:extendConfig` and `vite:configResolved`.
 ::

package/3.api/5.kit/14.builder.md

@@ -15,7 +15,7 @@ Nuxt have builders based on [Vite](https://github.com/nuxt/nuxt/tree/main/packag
 Extends the Vite configuration. Callback function can be called multiple times, when applying to both client and server builds.
 
 ::warning
-This hook is now deprecated, and we recommend using a Vite plugin instead with a `config` hook, or — for environment-specific configuration — the `applyToEnvironment` hook.
+This hook is now deprecated, and we recommend using a Vite plugin instead with a `config` hook.
 ::
 
 ### Usage
@@ -34,45 +34,6 @@ export default defineNuxtModule({
 })
 ```
 
-For environment-specific configuration in Nuxt 5+, use `addVitePlugin()` instead:
-
-```ts twoslash
-import { addVitePlugin, defineNuxtModule } from '@nuxt/kit'
-
-export default defineNuxtModule({
-  setup () {
-    // For global configuration (affects all environments)
-    addVitePlugin(() => ({
-      name: 'my-global-plugin',
-      config (config) {
-        // This runs before environment setup
-        config.optimizeDeps ||= {}
-        config.optimizeDeps.include ||= []
-        config.optimizeDeps.include.push('cross-fetch')
-      },
-    }))
-
-    // For environment-specific configuration
-    addVitePlugin(() => ({
-      name: 'my-client-plugin',
-      applyToEnvironment (environment) {
-        return environment.name === 'client'
-      },
-      configEnvironment (name, config) {
-        // This only affects the client environment
-        config.optimizeDeps ||= {}
-        config.optimizeDeps.include ||= []
-        config.optimizeDeps.include.push('client-only-package')
-      },
-    }))
-  },
-})
-```
-
-::warning
-**Important:** The `config` hook runs before `applyToEnvironment` and modifies the global configuration. Use `configEnvironment` for environment-specific configuration changes.
-::
-
 ### Type
 
 ```ts twoslash
@@ -97,8 +58,8 @@ Checkout Vite website for more information about its configuration.
 | --------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------ |
 | `dev`     | `boolean` | `false`  | If set to `true`, the callback function will be called when building in development mode.                    |
 | `build`   | `boolean` | `false`  | If set to `true`, the callback function will be called when building in production mode.                     |
-| `server`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the server bundle. **Deprecated in Nuxt 5+.** Use `addVitePlugin()` with `applyToEnvironment()` instead. |
-| `client`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the client bundle. **Deprecated in Nuxt 5+.** Use `addVitePlugin()` with `applyToEnvironment()` instead. |
+| `server`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the server bundle.                      |
+| `client`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the client bundle.                      |
 | `prepend` | `boolean` | `false`  | If set to `true`, the callback function will be prepended to the array with `unshift()` instead of `push()`. |
 
 ## `extendWebpackConfig`
@@ -154,10 +115,6 @@ Checkout webpack website for more information about its configuration.
 
 Append Vite plugin to the config.
 
-::warning
-In Nuxt 5+, plugins registered with `server: false` or `client: false` options will not have their `config` or `configResolved` hooks called. Instead, use the `applyToEnvironment()` method instead for environment-specific plugins.
-::
-
 ### Usage
 
 ```ts twoslash
@@ -178,15 +135,6 @@ export default defineNuxtModule({
   },
   setup (options) {
     addVitePlugin(svg4VuePlugin(options.svg4vue))
-
-    // or, to add a vite plugin to only one environment
-    addVitePlugin(() => ({
-      name: 'my-client-plugin',
-      applyToEnvironment (environment) {
-        return environment.name === 'client'
-      },
-      // ... rest of your client-only plugin
-    }))
   },
 })
 ```
@@ -215,8 +163,8 @@ See [Vite website](https://vite.dev/guide/api-plugin.html) for more information
 | --------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------ |
 | `dev`     | `boolean` | `false`  | If set to `true`, the callback function will be called when building in development mode.                    |
 | `build`   | `boolean` | `false`  | If set to `true`, the callback function will be called when building in production mode.                     |
-| `server`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the server bundle. **Deprecated in Nuxt 5+.** Use `applyToEnvironment()` instead. |
-| `client`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the client bundle. **Deprecated in Nuxt 5+.** Use `applyToEnvironment()` instead. |
+| `server`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the server bundle.                      |
+| `client`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the client bundle.                      |
 | `prepend` | `boolean` | `false`  | If set to `true`, the callback function will be prepended to the array with `unshift()` instead of `push()`. |
 
 ## `addWebpackPlugin`

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

@@ -75,8 +75,8 @@ Hook                     | Arguments                  | Description
 `schema:beforeWrite`     | `schema`                   | Called before writing the given schema.
 `schema:written`         | -                          | Called after the schema is written.
 `vite:extend`            | `viteBuildContext`         | Allows extending Vite default context.
-`vite:extendConfig`      | `viteInlineConfig, env`    | Allows extending Vite default config. **Deprecated in Nuxt 5+.** In Nuxt 5, this operates on a shared configuration rather than separate client/server configs.
-`vite:configResolved`    | `viteInlineConfig, env`    | Allows reading the resolved Vite config. **Deprecated in Nuxt 5+.** In Nuxt 5, this operates on a shared configuration rather than separate client/server configs.
+`vite:extendConfig`      | `viteInlineConfig, env`    | Allows extending Vite default config. **Deprecated.** We recommend adding a Vite plugin with a `config` hook.
+`vite:configResolved`    | `viteInlineConfig, env`    | Allows reading the resolved Vite config. **Deprecated.** We recommend adding a Vite plugin with a `configResolved` hook.
 `vite:serverCreated`     | `viteServer, env`          | Called when the Vite server is created.
 `vite:compiled`          | -                          | Called after Vite server is compiled.
 `webpack:config`         | `webpackConfigs`           | Called before configuring the webpack compiler.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxt/docs-nightly",
-  "version": "4.2.0-29344661.0b65203b",
+  "version": "4.2.0-29344710.84b82c47",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nuxt/nuxt.git",