@nuxt/docs 4.2.2 → 4.3.0

package/2.directory-structure/1.server.md

@@ -112,8 +112,6 @@ For example, you can define a custom handler utility that wraps the original han
 **Example:**
 
 ```ts [server/utils/handler.ts]
-import type { EventHandler, EventHandlerRequest } from 'h3'
-
 export const defineWrappedResponseHandler = <T extends EventHandlerRequest, D> (
   handler: EventHandler<T, D>,
 ): EventHandler<T, D> =>
@@ -130,6 +128,28 @@ export const defineWrappedResponseHandler = <T extends EventHandlerRequest, D> (
   })
 ```
 
+```ts [server/api/hello.get.ts]
+export default defineWrappedResponseHandler(event => 'hello world')
+```
+
+## Server Alias
+
+You can use the `#server` alias to import files from anywhere within the `server/` directory, regardless of the importing file's location.
+
+```ts [server/api/users/[id]/profile.ts]
+// Instead of relative paths like this:
+// import { formatUser } from '../../../utils/formatUser'
+
+// Use the #server alias:
+import { formatUser } from '#server/utils/formatUser'
+```
+
+This alias ensures consistent imports across your server code, especially useful in deeply nested route handlers.
+
+::note
+The `#server` alias can only be used within the `server/` directory. Importing from `#server` in client code will result in an error.
+::
+
 ## Server Types
 
 Auto-imports and other types are different for the `server/` directory, as it is running in a different context from the `app/` directory.
@@ -277,8 +297,8 @@ export default defineEventHandler((event) => {
 
   if (!Number.isInteger(id)) {
     throw createError({
-      statusCode: 400,
-      statusMessage: 'ID should be an integer',
+      status: 400,
+      statusText: 'ID should be an integer',
     })
   }
   return 'All good'

package/2.directory-structure/2.nuxtrc.md

@@ -23,6 +23,9 @@ devtools.enabled=true
 # Add Nuxt modules
 modules[]=@nuxt/image
 modules[]=nuxt-security
+
+# Module setups (automatically added by Nuxt)
+setups.@nuxt/test-utils="3.23.0"
 ```
 
 If present, the properties in the `nuxt.config` file will overwrite the properties in `.nuxtrc` file.

package/2.directory-structure/3.tsconfig.md

@@ -42,6 +42,7 @@ Read more about the different type contexts of a Nuxt project here.
 You can customize the TypeScript configuration of your Nuxt project for each context (`app`, `shared`, `node`, and `server`) in the `nuxt.config.ts` file.
 <!-- @case-police-ignore tsConfig -->
 ```ts twoslash [nuxt.config.ts]
+// @errors: 2353
 export default defineNuxtConfig({
   typescript: {
     // customize tsconfig.app.json

package/2.directory-structure/index.md

@@ -54,6 +54,10 @@ The [`content/`](/docs/4.x/directory-structure/content) directory is enabled by
 
 The [`modules/`](/docs/4.x/directory-structure/modules) directory is the directory that contains the local modules of the Nuxt application. Modules are used to extend the functionality of the Nuxt application.
 
+## Layers Directory
+
+The [`layers/`](/docs/4.x/directory-structure/layers) directory allows you to organize and share reusable code, components, composables, and configurations. Layers within this directory are automatically registered in your project.
+
 ## Nuxt Files
 
 - [`nuxt.config.ts`](/docs/4.x/directory-structure/nuxt-config) file is the main configuration file for the Nuxt application.

package/3.guide/0.index.md

@@ -11,12 +11,18 @@ surround: false
   Discover the main concepts behind Nuxt, from auto-import, hybrid rendering to its TypeScript support.
   ::
   ::card{icon="i-lucide-square-check" title="Best Practices" to="/docs/4.x/guide/best-practices"}
-  Learn about best practices when developing with Nuxt
+  Learn about best practices when developing with Nuxt.
+  ::
+  ::card{icon="i-lucide-bot" title="Working with AI" to="/docs/4.x/guide/ai"}
+  Integrate AI tools into your Nuxt workflow with MCP Server and LLMs.txt.
+  ::
+  ::card{icon="i-lucide-box" title="Module Author Guide" to="/docs/4.x/guide/modules"}
+  Learn how to create Nuxt modules to integrate, enhance or extend any Nuxt application.
   ::
   ::card{icon="i-lucide-book-open" title="Recipes" to="/docs/4.x/guide/recipes"}
   Find solutions to common problems and learn how to implement them in your Nuxt project.
   ::
   ::card{icon="i-lucide-star" title="Going Further" to="/docs/4.x/guide/going-further"}
-  Master Nuxt with advanced concepts like experimental features, hooks, modules, and more.
+  Master Nuxt with advanced concepts like experimental features, hooks, and more.
   ::
 ::

package/3.guide/1.concepts/1.rendering.md

@@ -131,6 +131,7 @@ The `200.html` and `404.html` might be useful for the hosting provider you are u
 When prerendering a client-rendered app, Nuxt will generate `index.html`, `200.html` and `404.html` files by default. However, if you need to prevent any (or all) of these files from being generated in your build, you can use the `'prerender:generate'` hook from [Nitro](/docs/4.x/getting-started/prerendering#prerendergenerate-nitro-hook).
 
 ```ts twoslash [nuxt.config.ts]
+// @errors: 2353 7006
 export default defineNuxtConfig({
   ssr: false,
   nitro: {

package/3.guide/1.concepts/2.nuxt-lifecycle.md

@@ -54,7 +54,7 @@ After this step, Nuxt calls the [`app:created`](/docs/4.x/api/advanced/hooks#app
 After initializing plugins and before executing middleware, Nuxt calls the `validate` method if it is defined in the `definePageMeta` function. The `validate` method, which can be synchronous or asynchronous, is often used to validate dynamic route parameters.
 
 - The `validate` function should return `true` if the parameters are valid.
-- If validation fails, it should return `false` or an object containing a `statusCode` and/or `statusMessage` to terminate the request.
+- If validation fails, it should return `false` or an object containing a `status` and/or `statusText` to terminate the request.
 
 For more information, see the [Route Validation documentation](/docs/4.x/getting-started/routing#route-validation).
 

package/3.guide/1.concepts/5.modules.md

@@ -41,8 +41,21 @@ export default defineNuxtConfig({
 Nuxt modules are now build-time-only, and the `buildModules` property used in Nuxt 2 is deprecated in favor of `modules`.
 ::
 
+## Disabling Modules
+
+You can disable a module by setting its config key to `false` in your Nuxt config. This is particularly useful when you want to disable modules inherited from layers.
+
+```ts [nuxt.config.ts]
+export default defineNuxtConfig({
+  // Disable `@nuxt/image` module
+  image: false,
+})
+```
+
+:read-more{to="/docs/4.x/guide/going-further/layers#disabling-modules-from-layers"}
+
 ## Create a Nuxt Module
 
 Everyone has the opportunity to develop modules and we cannot wait to see what you will build.
 
-:read-more{to="/docs/4.x/guide/going-further/modules" title="Module Author Guide"}
+:read-more{to="/docs/4.x/guide/modules" title="Module Author Guide"}

package/3.guide/1.concepts/8.typescript.md

@@ -27,6 +27,10 @@ To enable type-checking at build or development time, install `vue-tsc` and `typ
   bun add -D vue-tsc typescript
   ```
 
+  ```bash [deno]
+  deno add -D npm:vue-tsc npm:typescript
+  ```
+
 ::
 
 Then, run [`nuxt typecheck`](/docs/4.x/api/commands/typecheck) command to check your types:
@@ -52,7 +56,7 @@ Nuxt projects rely on auto-generated types to work properly. These types are sto
 The generated `tsconfig.json` files inside the [`.nuxt`](/docs/4.x/directory-structure/nuxt) directory include **recommended basic TypeScript configuration** for your project, references to [auto-imports](/docs/4.x/guide/concepts/auto-imports), [API route types](/docs/4.x/guide/concepts/server-engine#typed-api-routes), path aliases like `#imports`, `~/file`, or `#build/file`, and more.
 
 ::warning
-Nuxt relies on this configuration, and [Nuxt Modules](/docs/4.x/guide/going-further/modules) can extend it as well. For this reason, it is not recommended to modify your `tsconfig.json` file directly, as doing so could overwrite important settings. Instead, extend it via `nuxt.config.ts`. [Learn more about extending the configuration here](/docs/4.x/directory-structure/tsconfig).
+Nuxt relies on this configuration, and [Nuxt modules](/docs/4.x/guide/modules) can extend it as well. For this reason, it is not recommended to modify your `tsconfig.json` file directly, as doing so could overwrite important settings. Instead, extend it via `nuxt.config.ts`. [Learn more about extending the configuration here](/docs/4.x/directory-structure/tsconfig).
 ::
 
 ::tip{icon="i-lucide-video" to="https://youtu.be/umLI7SlPygY" target="_blank"}
@@ -95,7 +99,7 @@ Similarly:
 - For the `server` context, place the augmentation file in the `server/` directory.
 - For types that are **shared between the app and server**, place the file in the `shared/` directory.
 
-::read-more{to="/docs/4.x/guide/going-further/modules#extending-tsconfigjson"}
+::read-more{to="/docs/4.x/guide/modules/recipes-advanced#extend-typescript-config"}
 Read more about augmenting specific type contexts from **files outside those contexts** in the Module Author Guide.
 ::
 

package/3.guide/3.ai/1.mcp.md

@@ -88,6 +88,28 @@ Add the server using the CLI command:
 claude mcp add --transport http nuxt-remote https://nuxt.com/mcp
 ```
 
+### Claude Desktop
+
+#### Setup Instructions
+
+1. Open Claude Desktop and navigate to "Settings" > "Developer".
+2. Click on "Edit Config". This will open the local Claude directory.
+3. Modify the `claude_desktop_config.json` file with your custom MCP server configuration.
+    ```json [claude_desktop_config.json]
+    {
+      "mcpServers": {
+        "nuxt": {
+          "command": "npx",
+          "args": [
+            "mcp-remote",
+            "https://nuxt.com/mcp"
+          ]
+        }
+      }
+    }
+    ```
+4. Restart Claude Desktop app. The Nuxt MCP server should now be registered.
+
 ### Cursor
 
 Click the button below to install the Nuxt MCP server directly in Cursor:

package/3.guide/4.modules/.navigation.yml

@@ -0,0 +1,3 @@
+title: Module Author Guide
+titleTemplate: '%s · Nuxt Modules Author Guide'
+icon: i-lucide-box

package/3.guide/4.modules/1.getting-started.md

@@ -0,0 +1,103 @@
+---
+title: "Create Your First Module"
+description: "Learn how to create your first Nuxt module using the official starter template."
+---
+
+## Create a Module
+
+We recommend you get started with Nuxt modules using our [starter template](https://github.com/nuxt/starter/tree/module):
+
+::code-group{sync="pm"}
+
+```bash [npm]
+npm create nuxt -- -t module my-module
+```
+
+```bash [yarn]
+yarn create nuxt -t module my-module
+```
+
+```bash [pnpm]
+pnpm create nuxt -t module my-module
+```
+
+```bash [bun]
+bun create nuxt --template=module my-module
+```
+::
+
+This will create a `my-module` project with all the boilerplate necessary to develop and publish your module.
+
+**Next steps:**
+
+1. Open `my-module` in your IDE of choice
+2. Install dependencies using your favorite package manager
+3. Prepare local files for development using `npm run dev:prepare`
+4. Follow this document to learn more about Nuxt modules
+
+## Use the Starter Template
+
+Learn how to perform basic tasks with the module starter.
+
+::tip{icon="i-lucide-video" to="https://vueschool.io/lessons/navigating-the-official-starter-template?friend=nuxt" target="_blank"}
+Watch Vue School video about Nuxt module starter template.
+::
+
+### Develop Your Module
+
+While your module source code lives inside the `src` directory, to develop a module you often need a Nuxt application to test it against. That's what the `playground` directory is for. It's a Nuxt application you can tinker with that is already configured to run with your module.
+
+You can interact with the playground like with any Nuxt application.
+
+- Launch its development server with `npm run dev`, it should reload itself as you make changes to your module in the `src` directory
+- Build it with `npm run dev:build`
+
+::note
+All other `nuxt` commands can be used against the `playground` directory (e.g. `nuxt <COMMAND> playground`). Feel free to declare additional `dev:*` scripts within your `package.json` referencing them for convenience.
+::
+
+### Run Tests
+
+The module starter comes with a basic test suite:
+
+- A linter powered by [ESLint](https://eslint.org), run it with `npm run lint`
+- A test runner powered by [Vitest](https://vitest.dev), run it with `npm run test` or `npm run test:watch`
+
+::tip
+Feel free to augment this default test strategy to better suit your needs.
+::
+
+### Build Your Module
+
+Nuxt modules come with their own builder provided by [`@nuxt/module-builder`](https://github.com/nuxt/module-builder#readme). This builder doesn't require any configuration on your end, supports TypeScript, and makes sure your assets are properly bundled to be distributed to other Nuxt applications.
+
+You can build your module by running `npm run prepack`.
+
+::tip
+While building your module can be useful in some cases, most of the time you won't need to build it on your own: the `playground` takes care of it while developing, and the release script also has you covered when publishing.
+::
+
+### Publish to npm
+
+::important
+Before publishing your module to npm, makes sure you have an [npmjs.com](https://www.npmjs.com) account and that you're authenticated to it locally with `npm login`.
+::
+
+While you can publish your module by bumping its version and using the `npm publish` command, the module starter comes with a release script that helps you make sure you publish a working version of your module to npm and more.
+
+To use the release script, first, commit all your changes (we recommend you follow [Conventional Commits](https://www.conventionalcommits.org) to also take advantage of automatic version bump and changelog update), then run the release script with `npm run release`.
+
+When running the release script, the following will happen:
+
+- First, it will run your test suite by:
+  - Running the linter (`npm run lint`)
+  - Running unit, integration, and e2e tests (`npm run test`)
+  - Building the module (`npm run prepack`)
+- Then, if your test suite went well, it will proceed to publish your module by:
+  - Bumping your module version and generating a changelog according to your Conventional Commits
+  - Publishing the module to npm (for that purpose, the module will be built again to ensure its updated version number is taken into account in the published artifact)
+  - Pushing a git tag representing the newly published version to your git remote origin
+
+::tip
+As with other scripts, feel free to fine-tune the default `release` script in your `package.json` to better suit your needs.
+::

package/3.guide/4.modules/2.module-anatomy.md

@@ -0,0 +1,138 @@
+---
+title: "Understand Module Structure"
+description: "Learn how Nuxt modules are structured and how to define them."
+---
+
+There are two types of Nuxt modules:
+
+- published modules are distributed on npm - you can see a list of some community modules on [the Nuxt website](/modules).
+- "local" modules exist within a Nuxt project, either [inlined in Nuxt config](/docs/4.x/api/nuxt-config#modules) or within [the `modules` directory](/docs/4.x/directory-structure/modules).
+
+In either case, they work in the same way.
+
+## Define Your Module
+
+::note
+When using the starter, your module definition is available at `src/module.ts`.
+::
+
+The module definition is the entry point of your module. It's what gets loaded by Nuxt when your module is referenced within a Nuxt configuration.
+
+At a low level, a Nuxt module definition is a simple, potentially asynchronous, function accepting inline user options and a `nuxt` object to interact with Nuxt.
+
+```ts
+export default function (inlineOptions, nuxt) {
+  // You can do whatever you like here..
+  console.log(inlineOptions.token) // `123`
+  console.log(nuxt.options.dev) // `true` or `false`
+  nuxt.hook('ready', (nuxt) => {
+    console.log('Nuxt is ready')
+  })
+}
+```
+
+You can get type hinting for this function using the higher-level `defineNuxtModule` helper provided by [Nuxt Kit](/docs/4.x/guide/going-further/kit).
+
+```ts
+import { defineNuxtModule } from '@nuxt/kit'
+
+export default defineNuxtModule((options, nuxt) => {
+  nuxt.hook('pages:extend', (pages) => {
+    console.log(`Discovered ${pages.length} pages`)
+  })
+})
+```
+
+However, **we do not recommend** using this low-level function definition. Instead, to define a module, **we recommend** using the object-syntax with `meta` property to identify your module, especially when publishing to npm.
+
+This helper makes writing Nuxt modules more straightforward by implementing many common patterns needed by modules, guaranteeing future compatibility and improving the experience for both module authors and users.
+
+```ts
+import { defineNuxtModule } from '@nuxt/kit'
+
+export default defineNuxtModule({
+  meta: {
+    // Usually the npm package name of your module
+    name: '@nuxtjs/example',
+    // The key in `nuxt.config` that holds your module options
+    configKey: 'sample',
+    // Compatibility constraints
+    compatibility: {
+      // Semver version of supported nuxt versions
+      nuxt: '>=3.0.0',
+    },
+  },
+  // Default configuration options for your module, can also be a function returning those
+  defaults: {},
+  // Shorthand sugar to register Nuxt hooks
+  hooks: {},
+  // Configuration for other modules - this does not ensure the module runs before
+  // your module, but it allows you to change the other module's configuration before it runs
+  moduleDependencies: {
+    'some-module': {
+      // You can specify a version constraint for the module. If the user has a different
+      // version installed, Nuxt will throw an error on startup.
+      version: '>=2',
+      // By default moduleDependencies will be added to the list of modules to be installed
+      // by Nuxt unless `optional` is set.
+      optional: true,
+      // Any configuration that should override `nuxt.options`.
+      overrides: {},
+      // Any configuration that should be set. It will override module defaults but
+      // will not override any configuration set in `nuxt.options`.
+      defaults: {},
+    },
+  },
+  // The function holding your module logic, it can be asynchronous
+  setup (moduleOptions, nuxt) {
+    // ...
+  },
+})
+```
+
+`defineNuxtModule` returns a wrapper function with the lower level `(inlineOptions, nuxt)` module signature. This wrapper function applies defaults and other necessary steps before calling your `setup` function:
+
+- Support `defaults` and `meta.configKey` for automatically merging module options
+- Type hints and automated type inference
+- Ensure module gets installed only once using a unique key computed from `meta.name` or `meta.configKey`
+- Automatically register Nuxt hooks
+- Automatically check for compatibility issues based on module meta
+- Expose `getOptions` and `getMeta` for internal usage of Nuxt
+- Ensuring backward and upward compatibility as long as the module is using `defineNuxtModule` from the latest version of `@nuxt/kit`
+- Integration with module builder tooling
+
+## Add Runtime Code
+
+::note
+When using the starter, the runtime directory is `src/runtime/`.
+::
+
+Modules, like everything in a Nuxt configuration, aren't included in your application runtime. However, you might want your module to provide, or inject runtime code to the application it's installed on. That's what the runtime directory enables you to do.
+
+Inside the runtime directory, you can provide any kind of assets related to the Nuxt app:
+- Vue components
+- Composables
+- [Nuxt plugins](/docs/4.x/directory-structure/app/plugins)
+
+To the [server engine](/docs/4.x/guide/concepts/server-engine), Nitro:
+- API routes
+- Middlewares
+- Nitro plugins
+
+Or any other kind of asset you want to inject in users' Nuxt applications:
+- Stylesheets
+- 3D models
+- Images
+- etc.
+
+You'll then be able to inject all those assets inside the application from your [module definition](#define-your-module).
+
+::tip
+Learn more about asset injection in [the recipes section](/docs/4.x/guide/modules/recipes-basics).
+::
+
+::warning
+Published modules cannot leverage auto-imports for assets within their runtime directory. Instead, they have to import them explicitly from `#imports` or alike.
+:br :br
+Auto-imports are not enabled for files within `node_modules` (the location where a published module will eventually live) for performance reasons.
+::