@nuxt/docs 4.1.2 → 4.1.3

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

@@ -21,7 +21,7 @@ npx nuxt module add <MODULENAME> [--cwd=<directory>] [--logLevel=<silent|info|ve
 <!--module-add-args-->
 Argument | Description
 --- | ---
-`MODULENAME` | Module name
+`MODULENAME` | Specify one or more modules to install by name, separated by spaces
 <!--/module-add-args-->
 
 <!--module-add-opts-->
@@ -31,7 +31,7 @@ Option | Default | Description
 `--logLevel=<silent\|info\|verbose>` |  | Specify build-time log level
 `--skipInstall` |  | Skip npm install
 `--skipConfig` |  | Skip nuxt.config.ts update
-`--dev` |  | Install module as dev dependency
+`--dev` |  | Install modules as dev dependencies
 <!--/module-add-opts-->
 
 The command lets you install [Nuxt modules](/modules) in your application with no manual work.
@@ -39,8 +39,8 @@ The command lets you install [Nuxt modules](/modules) in your application with n
 When running the command, it will:
 
 - install the module as a dependency using your package manager
-- add it to your [package.json](/docs/guide/directory-structure/package) file
-- update your [`nuxt.config`](/docs/guide/directory-structure/nuxt-config) file
+- add it to your [package.json](/docs/4.x/guide/directory-structure/package) file
+- update your [`nuxt.config`](/docs/4.x/guide/directory-structure/nuxt-config) file
 
 **Example:**
 

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

@@ -10,11 +10,11 @@ links:
 
 <!--prepare-cmd-->
 ```bash [Terminal]
-npx nuxt prepare [ROOTDIR] [--dotenv] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName]
+npx nuxt prepare [ROOTDIR] [--dotenv] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName] [-e, --extends=<layer-name>]
 ```
 <!--/prepare-cmd-->
 
-The `prepare` command creates a [`.nuxt`](/docs/guide/directory-structure/nuxt) directory in your application and generates types. This can be useful in a CI environment or as a `postinstall` command in your [`package.json`](/docs/guide/directory-structure/package).
+The `prepare` command creates a [`.nuxt`](/docs/4.x/guide/directory-structure/nuxt) directory in your application and generates types. This can be useful in a CI environment or as a `postinstall` command in your [`package.json`](/docs/4.x/guide/directory-structure/package).
 
 ## Arguments
 
@@ -33,4 +33,9 @@ Option | Default | Description
 `--cwd=<directory>` |  | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
 `--logLevel=<silent\|info\|verbose>` |  | Specify build-time log level
 `--envName` |  | The environment to use when resolving configuration overrides (default is `production` when building, and `development` when running the dev server)
+`-e, --extends=<layer-name>` |  | Extend from a Nuxt layer
 <!--/prepare-opts-->
+
+::note
+This command sets `process.env.NODE_ENV` to `production`.
+::

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

@@ -10,11 +10,11 @@ links:
 
 <!--preview-cmd-->
 ```bash [Terminal]
-npx nuxt preview [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName] [--dotenv] [-p, --port]
+npx nuxt preview [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName] [-e, --extends=<layer-name>] [-p, --port] [--dotenv]
 ```
 <!--/preview-cmd-->
 
-The `preview` command starts a server to preview your Nuxt application after running the `build` command. The `start` command is an alias for `preview`. When running your application in production refer to the [Deployment section](/docs/getting-started/deployment).
+The `preview` command starts a server to preview your Nuxt application after running the `build` command. The `start` command is an alias for `preview`. When running your application in production refer to the [Deployment section](/docs/4.x/getting-started/deployment).
 
 ## Arguments
 
@@ -32,12 +32,13 @@ Option | Default | Description
 `--cwd=<directory>` |  | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
 `--logLevel=<silent\|info\|verbose>` |  | Specify build-time log level
 `--envName` |  | The environment to use when resolving configuration overrides (default is `production` when building, and `development` when running the dev server)
+`-e, --extends=<layer-name>` |  | Extend from a Nuxt layer
+`-p, --port` |  | Port to listen on (use `PORT` environment variable to override)
 `--dotenv` |  | Path to `.env` file to load, relative to the root directory
-`-p, --port` |  | Port to listen on (default: `NUXT_PORT \|\| NITRO_PORT \|\| PORT`)
 <!--/preview-opts-->
 
 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 example, with Node.js 20+ you could do this by running `node --env-file .env .output/server/index.mjs` to start your server.)
+For convenience, in preview mode, your [`.env`](/docs/4.x/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/test.md

@@ -0,0 +1,40 @@
+---
+title: "nuxt test"
+description: The test command runs tests using @nuxt/test-utils.
+links:
+  - label: Source
+    icon: i-simple-icons-github
+    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/test.ts
+    size: xs
+---
+
+<!--test-cmd-->
+```bash [Terminal]
+npx nuxt test [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dev] [--watch]
+```
+<!--/test-cmd-->
+
+The `test` command runs tests using [`@nuxt/test-utils`](/docs/getting-started/testing). This command sets `process.env.NODE_ENV` to `test` if not already set.
+
+## Arguments
+
+<!--test-args-->
+Argument | Description
+--- | ---
+`ROOTDIR="."` | Specifies the working directory (default: `.`)
+<!--/test-args-->
+
+## Options
+
+<!--test-opts-->
+Option | Default | Description
+--- | --- | ---
+`--cwd=<directory>` |  | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
+`--logLevel=<silent\|info\|verbose>` |  | Specify build-time log level
+`--dev` |  | Run in dev mode
+`--watch` |  | Watch mode
+<!--/test-opts-->
+
+::note
+This command sets `process.env.NODE_ENV` to `test`.
+::

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

@@ -10,7 +10,7 @@ links:
 
 <!--typecheck-cmd-->
 ```bash [Terminal]
-npx nuxt typecheck [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>]
+npx nuxt typecheck [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [-e, --extends=<layer-name>]
 ```
 <!--/typecheck-cmd-->
 
@@ -31,12 +31,14 @@ Option | Default | Description
 --- | --- | ---
 `--cwd=<directory>` |  | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
 `--logLevel=<silent\|info\|verbose>` |  | Specify build-time log level
+`--dotenv` |  | Path to `.env` file to load, relative to the root directory
+`-e, --extends=<layer-name>` |  | Extend from a Nuxt layer
 <!--/typecheck-opts-->
 
 ::note
-This command sets `process.env.NODE_ENV` to `production`. To override, define `NODE_ENV` in a [`.env`](/docs/guide/directory-structure/env) file or as a command-line argument.
+This command sets `process.env.NODE_ENV` to `production`. To override, define `NODE_ENV` in a [`.env`](/docs/4.x/guide/directory-structure/env) file or as a command-line argument.
 ::
 
-::read-more{to="/docs/guide/concepts/typescript#type-checking"}
+::read-more{to="/docs/4.x/guide/concepts/typescript#type-checking"}
 Read more on how to enable type-checking at build or development time.
 ::

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

@@ -10,7 +10,7 @@ links:
 
 <!--upgrade-cmd-->
 ```bash [Terminal]
-npx nuxt 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|v3|v4|v4-nightly|v3-nightly>]
 ```
 <!--/upgrade-cmd-->
 
@@ -31,7 +31,7 @@ Option | Default | Description
 --- | --- | ---
 `--cwd=<directory>` |  | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
 `--logLevel=<silent\|info\|verbose>` |  | Specify build-time log level
-`--dedupe` |  | Will deduplicate dependencies but not recreate the lockfile
+`--dedupe` |  | Dedupe dependencies after upgrading
 `-f, --force` |  | Force upgrade to recreate lockfile and node_modules
-`-ch, --channel=<stable\|nightly>` | `stable` | Specify a channel to install from (default: stable)
+`-ch, --channel=<stable\|nightly\|v3\|v4\|v4-nightly\|v3-nightly>` | `stable` | Specify a channel to install from (default: stable)
 <!--/upgrade-opts-->

package/3.api/5.kit/1.modules.md

@@ -22,16 +22,16 @@ import { defineNuxtModule } from '@nuxt/kit'
 export default defineNuxtModule({
   meta: {
     name: 'my-module',
-    configKey: 'myModule'
+    configKey: 'myModule',
   },
   defaults: {
-    enabled: true
+    enabled: true,
   },
   setup (options) {
     if (options.enabled) {
       console.log('My Nuxt module is enabled!')
     }
-  }
+  },
 })
 ```
 
@@ -78,17 +78,17 @@ import { defineNuxtModule } from '@nuxt/kit'
 export default defineNuxtModule({
   meta: {
     name: 'my-module',
-    configKey: 'myModule'
+    configKey: 'myModule',
   },
   defaults: {
     // Module options
-    enabled: true
+    enabled: true,
   },
   setup (options) {
     if (options.enabled) {
       console.log('My Nuxt module is enabled!')
     }
-  }
+  },
 })
 ```
 
@@ -97,8 +97,8 @@ Users can provide options for this module under the corresponding key in `nuxt.c
 ```ts
 export default defineNuxtConfig({
   myModule: {
-    enabled: false
-  }
+    enabled: false,
+  },
 })
 ```
 
@@ -116,7 +116,7 @@ export default defineNuxtModule({
       nuxt: '>=3.0.0', // or use '^3.0.0'
     },
   },
-  async setup() {
+  setup () {
     const resolver = createResolver(import.meta.url)
     // Implement
   },
@@ -148,26 +148,26 @@ interface ModuleOptions {
 export default defineNuxtModule<ModuleOptions>().with({
   meta: {
     name: '@nuxtjs/my-api',
-    configKey: 'myApi'
+    configKey: 'myApi',
   },
   defaults: {
     baseURL: 'https://api.example.com',
     timeout: 5000,
-    retries: 3
+    retries: 3,
   },
-  setup(resolvedOptions, nuxt) {
+  setup (resolvedOptions, nuxt) {
     // resolvedOptions is properly typed as:
     // {
     //   apiKey: string          // Required, no default provided
     //   baseURL: string         // Required, has default value
     //   timeout: number         // Optional, has default value
-    //   retries: number         // Optional, has default value  
+    //   retries: number         // Optional, has default value
     // }
-    
+
     console.log(resolvedOptions.baseURL) // ✅ TypeScript knows this is always defined
     console.log(resolvedOptions.timeout) // ✅ TypeScript knows this is always defined
     console.log(resolvedOptions.retries) // ✅ TypeScript knows this is always defined
-  }
+  },
 })
 ```
 
@@ -197,45 +197,45 @@ export default defineNuxtModule({
   meta: {
     name: 'my-awesome-module',
     version: '1.2.0', // Required for lifecycle hooks
-    configKey: 'myAwesomeModule'
+    configKey: 'myAwesomeModule',
   },
   defaults: {
     apiKey: '',
-    enabled: true
+    enabled: true,
   },
-  
-  onInstall(nuxt) {
+
+  onInstall (nuxt) {
     // This runs only when the module is first installed
     console.log('Setting up my-awesome-module for the first time!')
-    
+
     // You might want to:
     // - Create initial configuration files
     // - Set up database schemas
     // - Display welcome messages
     // - Perform initial data migration
   },
-  
-  onUpgrade(options, nuxt, previousVersion) {
+
+  onUpgrade (options, nuxt, previousVersion) {
     // This runs when the module is upgraded to a newer version
     console.log(`Upgrading my-awesome-module from ${previousVersion} to 1.2.0`)
-    
+
     // You might want to:
     // - Migrate configuration files
-    // - Update database schemas  
+    // - Update database schemas
     // - Clean up deprecated files
     // - Display upgrade notes
-    
+
     if (semver.lt(previousVersion, '1.1.0')) {
       console.log('⚠️  Breaking changes in 1.1.0 - please check the migration guide')
     }
   },
-  
-  setup(options, nuxt) {
+
+  setup (options, nuxt) {
     // Regular setup logic runs on every build
     if (options.enabled) {
       // Configure the module
     }
-  }
+  },
 })
 ```
 
@@ -248,7 +248,7 @@ Install specified Nuxt module programmatically. This is helpful when your module
 ```ts twoslash
 import { defineNuxtModule, installModule } from '@nuxt/kit'
 
-export default defineNuxtModule({  
+export default defineNuxtModule({
   async setup () {
     // will install @nuxtjs/fontaine with Roboto font and Impact fallback
     await installModule('@nuxtjs/fontaine', {
@@ -258,10 +258,10 @@ export default defineNuxtModule({
           family: 'Roboto',
           fallbacks: ['Impact'],
           fallbackName: 'fallback-a',
-        }
-      ]
+        },
+      ],
     })
-  }
+  },
 })
 ```
 
@@ -284,7 +284,7 @@ async function installModule (moduleToInstall: string | NuxtModule, inlineOption
 ```ts
 import { defineNuxtModule, installModule } from '@nuxt/kit'
 
-export default defineNuxtModule({  
+export default defineNuxtModule({
   async setup (options, nuxt) {
     // will install @nuxtjs/fontaine with Roboto font and Impact fallback
     await installModule('@nuxtjs/fontaine', {
@@ -294,9 +294,9 @@ export default defineNuxtModule({
           family: 'Roboto',
           fallbacks: ['Impact'],
           fallbackName: 'fallback-a',
-        }
-      ]
+        },
+      ],
     })
-  }
+  },
 })
 ```

package/3.api/5.kit/10.runtime-config.md

@@ -10,7 +10,7 @@ links:
 
 ## `useRuntimeConfig`
 
-At build-time, it is possible to access the resolved Nuxt [runtime config](/docs/guide/going-further/runtime-config).
+At build-time, it is possible to access the resolved Nuxt [runtime config](/docs/4.x/guide/going-further/runtime-config).
 
 ### Type
 

package/3.api/5.kit/10.templates.md

@@ -21,17 +21,17 @@ import { addTemplate, defineNuxtModule } from '@nuxt/kit'
 import { defu } from 'defu'
 
 export default defineNuxtModule({
-  setup(options, nuxt) {
+  setup (options, nuxt) {
     const globalMeta = defu(nuxt.options.app.head, {
       charset: options.charset,
-      viewport: options.viewport
+      viewport: options.viewport,
     })
 
     addTemplate({
       filename: 'meta.config.mjs',
-      getContents: () => 'export default ' + JSON.stringify({ globalMeta, mixinKey: 'setup' })
+      getContents: () => 'export default ' + JSON.stringify({ globalMeta, mixinKey: 'setup' }),
     })
-  }
+  },
 })
 ```
 
@@ -88,7 +88,7 @@ In the module above, we generate a virtual file named `meta.config.mjs`. In the
 import { createHead as createServerHead } from '@unhead/vue/server'
 import { createHead as createClientHead } from '@unhead/vue/client'
 import { defineNuxtPlugin } from '#imports'
-// @ts-ignore
+// @ts-expect-error - virtual file
 import metaConfig from '#build/meta.config.mjs'
 
 export default defineNuxtPlugin((nuxtApp) => {
@@ -279,7 +279,9 @@ export default defineNuxtModule({
     ]
     // watch and rebuild routes template list when one of the pages changes
     nuxt.hook('builder:watch', async (event, relativePath) => {
-      if (event === 'change') { return }
+      if (event === 'change') {
+        return
+      }
 
       const path = resolve(nuxt.options.srcDir, relativePath)
       if (updateTemplatePaths.some(dir => path.startsWith(dir))) {