Nuxt 配置

了解您可以在 nuxt.config.ts 文件中使用的所有选项。

alias

您可以通过定义额外的别名来访问 JavaScript 和 CSS 中的自定义目录，从而改善您的开发体验 (DX)。

类型: object
默认

{
  "~": "/<srcDir>",
  "@": "/<srcDir>",
  "~~": "/<rootDir>",
  "@@": "/<rootDir>",
  "#shared": "/<rootDir>/shared",
  "assets": "/<srcDir>/assets",
  "public": "/<rootDir>/public",
  "#build": "/<rootDir>/.nuxt",
  "#internal/nuxt/paths": "/<rootDir>/.nuxt/paths.mjs"
}

注意: 在 webpack 上下文（图片源、CSS - 但不包括 JavaScript）中，您必须通过在别名前加上 ~ 来访问它。

注意: 这些别名将自动添加到生成的 TypeScript 配置（.nuxt/tsconfig.app.json、.nuxt/tsconfig.server.json 等）中，以便您获得完整的类型支持和路径自动补全。如果您需要进一步扩展生成的配置提供的选项，请确保将它们添加到此处或 nuxt.config 中的 typescript.tsConfig 属性中。

示例:

import { fileURLToPath } from 'node:url'

export default defineNuxtConfig({
  alias: {
    'images': fileURLToPath(new URL('./assets/images', import.meta.url)),
    'style': fileURLToPath(new URL('./assets/style', import.meta.url)),
    'data': fileURLToPath(new URL('./assets/other/data', import.meta.url)),
  },
})

<template>
  <img src="~images/main-bg.jpg">
</template>

<script>
import data from 'data/test.json'
</script>

<style>
// Uncomment the below
//@import '~style/variables.scss';
//@import '~style/utils.scss';
//@import '~style/base.scss';
body {
  background-image: url('~images/main-bg.jpg');
}
</style>

analyzeDir

Nuxt 运行 nuxt analyze 时将生成的文件夹存储到该目录中。

如果指定了相对路径，它将相对于您的 rootDir。

类型: string
默认: "/<rootDir>/.nuxt/analyze"

app

Nuxt 应用程序配置。

`baseURL`

您的 Nuxt 应用程序的基本路径。

例如

类型: string
默认: "/"

示例:

export default defineNuxtConfig({
  app: {
    baseURL: '/prefix/',
  },
})

这也可以通过设置 NUXT_APP_BASE_URL 环境变量在运行时设置。

示例:

NUXT_APP_BASE_URL=/prefix/ node .output/server/index.mjs

`buildAssetsDir`

构建站点资源的文件夹名称，相对于 baseURL（如果设置了 cdnURL 则相对于它）。这在构建时设置，不应在运行时自定义。

类型: string
默认: "/_nuxt/"

`cdnURL`

一个绝对 URL，用于从公共文件夹提供服务（仅限生产环境）。

例如

类型: string
默认: ""

示例:

export default defineNuxtConfig({
  app: {
    cdnURL: 'https://mycdn.org/',
  },
})

这可以在运行时通过设置 NUXT_APP_CDN_URL 环境变量来设置为不同的值。

示例:

NUXT_APP_CDN_URL=https://mycdn.org/ node .output/server/index.mjs

`head`

为每个页面上的 <head> 设置默认配置。

类型: object
默认

{
  "meta": [
    {
      "name": "viewport",
      "content": "width=device-width, initial-scale=1"
    },
    {
      "charset": "utf-8"
    }
  ],
  "link": [],
  "style": [],
  "script": [],
  "noscript": []
}

示例:

export default defineNuxtConfig({
  app: {
    head: {
      meta: [
      // <meta name="viewport" content="width=device-width, initial-scale=1">
        { name: 'viewport', content: 'width=device-width, initial-scale=1' },
      ],
      script: [
      // <script src="https://myawesome-lib.js"></script>
        { src: 'https://awesome-lib.js' },
      ],
      link: [
      // <link rel="stylesheet" href="https://myawesome-lib.css">
        { rel: 'stylesheet', href: 'https://awesome-lib.css' },
      ],
      // please note that this is an area that is likely to change
      style: [
      // <style>:root { color: red }</style>
        { textContent: ':root { color: red }' },
      ],
      noscript: [
      // <noscript>JavaScript is required</noscript>
        { textContent: 'JavaScript is required' },
      ],
    },
  },
})

`keepalive`

KeepAlive 配置在页面之间的默认值。

这可以通过在单个页面上使用 definePageMeta 来覆盖。只允许 JSON 序列化的值。

类型：boolean
默认: false

请参阅: Vue KeepAlive

`layoutTransition`

布局转换的默认值。

这可以通过在单个页面上使用 definePageMeta 来覆盖。只允许 JSON 序列化的值。

类型：boolean
默认: false

请参阅: Vue 转换文档

`pageTransition`

页面转换的默认值。

这可以通过在单个页面上使用 definePageMeta 来覆盖。只允许 JSON 序列化的值。

类型：boolean
默认: false

请参阅: Vue 转换文档

`rootAttrs`

自定义 Nuxt 根元素 ID。

类型: object
默认

{
  "id": "__nuxt"
}

`rootId`

自定义 Nuxt 根元素 ID。

类型: string
默认: "__nuxt"

`rootTag`

自定义 Nuxt 根元素标签。

类型: string
默认: "div"

`spaLoaderTag`

自定义 Nuxt SpaLoader 元素标签。

类型: string
默认: "div"

`teleportAttrs`

自定义 Nuxt Teleport 元素属性。

类型: object
默认

{
  "id": "teleports"
}

`teleportId`

自定义 Nuxt Teleport 元素 ID。

类型: string
默认: "teleports"

`teleportTag`

自定义 Nuxt Teleport 元素标签。

类型: string
默认: "div"

`viewTransition`

视图转换的默认值。

这仅在您的 nuxt.config 文件中启用了实验性视图转换支持时才有效。这可以通过在单个页面上使用 definePageMeta 来覆盖。

类型：boolean
默认: false

请参阅: Nuxt 视图转换 API 文档

appConfig

额外的应用程序配置

为了程序化使用和类型支持，您可以直接使用此选项提供应用程序配置。它将与 app.config 文件作为默认值合并。

appId

对于多应用程序项目，Nuxt 应用程序的唯一 ID。

默认为 nuxt-app。

类型: string
默认: "nuxt-app"

build

共享构建配置。

`analyze`

Nuxt 允许可视化您的捆绑包以及如何优化它们。

设置为 true 以启用捆绑分析，或传递一个包含选项的对象用于 webpack或用于 vite.

类型: object
默认

{
  "template": "treemap",
  "projectRoot": "/<rootDir>",
  "filename": "/<rootDir>/.nuxt/analyze/{name}.html"
}

示例:

export default defineNuxtConfig({
  analyze: {
    analyzerMode: 'static',
  },
})

`templates`

建议使用 @nuxt/kit 中的 addTemplate 代替此选项。

类型: array

示例:

export default defineNuxtConfig({
  build: {
    templates: [
      {
        src: '~/modules/support/plugin.js', // `src` can be absolute or relative
        dst: 'support.js', // `dst` is relative to project `.nuxt` dir
      },
    ],
  },
})

`transpile`

如果您想使用 Babel 编译特定的依赖项，可以在此处添加它们。transpile 中的每个项目可以是包名、函数、字符串或匹配依赖项文件名的正则表达式对象。

您还可以使用函数进行条件编译。该函数将接收一个对象 ({ isDev, isServer, isClient, isModern, isLegacy })。

类型: array

示例:

export default defineNuxtConfig({
  build: {
    transpile: [({ isLegacy }) => isLegacy && 'ky'],
  },
})

buildDir

定义 Nuxt 构建文件存放的目录。

许多工具假定 .nuxt 是一个隐藏目录（因为它以 . 开头）。如果这是一个问题，您可以使用此选项来防止这种情况。

类型: string
默认: "/<rootDir>/.nuxt"

示例:

export default defineNuxtConfig({
  buildDir: 'nuxt-build',
})

buildId

与构建匹配的唯一标识符。这可能包含项目当前状态的哈希值。

类型: string
默认: "4a2e2d30-418f-41df-8e58-ed5df06de7fd"

builder

用于捆绑应用程序 Vue 部分的构建器。

Nuxt 支持客户端应用程序的多个构建器。默认情况下，使用 Vite，但您可以切换到 webpack、Rspack，甚至提供自定义构建器实现。

类型: 'vite' | 'webpack' | 'rspack' | string | { bundle: (nuxt: Nuxt) => Promise<void> }
默认: "@nuxt/vite-builder"

使用支持的构建器

export default defineNuxtConfig({
  // default - uses @nuxt/vite-builder
  // builder: 'vite',

  // uses @nuxt/webpack-builder
  // builder: 'webpack',

  // uses @nuxt/rspack-builder
  builder: 'rspack',
})

如果您正在使用 webpack 或 rspack，您需要确保在项目中显式安装了 @nuxt/webpack-builder 或 @nuxt/rspack-builder。

使用自定义构建器对象

您可以通过传递一个带有 bundle 函数的对象来提供自定义构建器

export default defineNuxtConfig({
  builder: {
    async bundle (nuxt) {
      const entry = await resolvePath(resolve(nuxt.options.appDir, 'entry'))

      // Build client and server bundles
      await buildClient(nuxt, entry)
      if (nuxt.options.ssr) {
        await buildServer(nuxt, entry)
      }

      // ... it's a bit more complicated than that, of course!
    },
  },
})

创建自定义构建器包

要将自定义构建器创建为单独的包，它应该导出一个 bundle 函数。然后您可以在 nuxt.config.ts 中指定包名

export default defineNuxtConfig({
  builder: 'my-custom-builder',
})

compatibilityDate

为您的应用程序指定一个兼容性日期。

这用于控制 Nitro、Nuxt Image 和其他模块中的预设行为，这些模块可能会在没有主要版本升级的情况下改变行为。我们计划将来改进围绕此功能的工具。

css

您可以定义要全局设置的 CSS 文件/模块/库（包含在每个页面中）。

Nuxt 将根据文件扩展名自动猜测文件类型并使用适当的预处理器。如果您需要使用它们，仍然需要安装所需的加载器。

类型: array

示例:

export default defineNuxtConfig({
  css: [
  // Load a Node.js module directly (here it's a Sass file).
    'bulma',
    // CSS file in the project
    '~/assets/css/main.css',
    // SCSS file in the project
    '~/assets/css/main.scss',
  ],
})

调试

设置为 true 以启用调试模式。

目前，它会在服务器上打印钩子名称和时间，并在浏览器中记录钩子参数。您还可以将其设置为一个对象以启用特定的调试选项。

类型：boolean
默认: false

开发

Nuxt 是否以开发模式运行。

通常，您不需要设置此项。

类型：boolean
默认: false

devServer

`cors`

为开发服务器设置 CORS 选项

`origin`

类型: array
默认

[
  {}
]

`https`

是否启用 HTTPS。

类型：boolean
默认: false

示例:

export default defineNuxtConfig({
  devServer: {
    https: {
      key: './server.key',
      cert: './server.crt',
    },
  },
})

`url`

监听开发服务器 URL。

不应直接设置此项，因为它将始终被开发服务器以完整 URL 覆盖（用于模块和内部使用）。

类型: string
默认: "https://:3000"

devServerHandlers

仅用于 Nitro 开发服务器的处理程序。

类型: array

请参阅: Nitro 服务器路由文档

devtools

启用 Nuxt DevTools 用于开发。

Devtools 的重大更改可能不会反映在 Nuxt 版本上。

请参阅: Nuxt DevTools获取更多信息。

dir

自定义 Nuxt 使用的默认目录结构。

除非必要，否则最好坚持使用默认值。

`assets`

资产目录（在您的构建中别名为 ~assets）。

类型: string
默认: "app/assets"

`layouts`

布局目录，其中每个文件都将自动注册为 Nuxt 布局。

类型: string
默认: "app/layouts"

`middleware`

中间件目录，其中每个文件都将自动注册为 Nuxt 中间件。

类型: string
默认: "app/middleware"

`modules`

模块目录，其中每个文件都将自动注册为 Nuxt 模块。

类型: string
默认: "modules"

`pages`

将处理该目录以自动生成您的应用程序页面路由。

类型: string
默认: "app/pages"

`plugins`

插件目录，其中每个文件都将自动注册为 Nuxt 插件。

类型: string
默认: "app/plugins"

`public`

包含您的静态文件的目录，这些文件将通过 Nuxt 服务器直接访问，并在应用程序生成时复制到您的 dist 文件夹中。

类型: string
默认: "public"

`shared`

共享目录。此目录在应用程序和服务器之间共享。

类型: string
默认: "shared"

esbuild

`options`

配置 Nuxt 中使用的共享 esbuild 选项，并传递给其他构建器，例如 Vite 或 webpack。

extends

从多个本地或远程源扩展项目。

该值应为指向源目录或相对于当前配置的配置路径的字符串或字符串数组。您可以使用 github:、gh:、gitlab: 或 bitbucket:

请参阅: c12 关于扩展配置层的文档

请参阅: giget 文档

extensions

Nuxt 解析器应解析的扩展名。

类型: array
默认

[
  ".js",
  ".jsx",
  ".mjs",
  ".ts",
  ".tsx",
  ".vue"
]

hooks

钩子是 Nuxt 事件的监听器，通常用于模块中，但在 nuxt.config 中也可用。

在内部，钩子遵循使用冒号的命名模式（例如，build:done）。为了便于配置，您也可以在 nuxt.config 中将它们构造为分层对象（如下所示）。

示例:

import fs from 'node:fs'
import path from 'node:path'

export default defineNuxtConfig({
  hooks: {
    build: {
      done (builder) {
        const extraFilePath = path.join(
          builder.nuxt.options.buildDir,
          'extra-file',
        )
        fs.writeFileSync(extraFilePath, 'Something extra')
      },
    },
  },
})

ignore

比 ignorePrefix 更具可定制性：所有与 ignore 数组中指定的 glob 模式匹配的文件都将在构建中被忽略。

类型: array
默认

[
  "**/*.stories.{js,cts,mts,ts,jsx,tsx}",
  "**/*.{spec,test}.{js,cts,mts,ts,jsx,tsx}",
  "**/*.d.{cts,mts,ts}",
  "**/.{pnpm-store,vercel,netlify,output,git,cache,data}",
  "**/*.sock",
  ".nuxt/analyze",
  ".nuxt",
  "**/-*.*"
]

ignoreOptions

直接将选项传递给 node-ignore（Nuxt 用于忽略文件）。

请参阅: node-ignore

示例:

export default defineNuxtConfig({
  ignoreOptions: {
    ignorecase: false,
  },
})

ignorePrefix

app/pages/、app/layouts/、app/middleware/ 和 public/ 目录中，如果文件名以 ignorePrefix 指定的前缀开头，则所有文件都将在构建过程中被忽略。这是为了防止某些文件在构建的应用程序中被处理或提供。默认情况下，ignorePrefix 设置为'-'，忽略任何以'-'开头的文件。

类型: string
默认: "-"

imports (导入)

配置 Nuxt 如何自动将可组合函数导入到您的应用程序中。

请参阅: Nuxt 文档

`dirs`

将自动导入的自定义目录数组。请注意，此选项不会覆盖默认目录（~/composables, ~/utils）。

类型: array

示例:

export default defineNuxtConfig({
  imports: {
  // Auto-import pinia stores defined in `~/stores`
    dirs: ['stores'],
  },
})

`scan`

是否扫描您的 app/composables/ 和 app/utils/ 目录以自动导入可组合函数。由 Nuxt 或其他模块（例如从 vue 或 nuxt 导入）注册的自动导入仍将启用。

类型：boolean
默认: true

logLevel

构建日志时的日志级别。

在 CI 中运行或 TTY 不可用时默认为“silent”。此选项随后在 Vite 中用作“silent”，在 webpack 中用作“none”

类型: string
默认: "info"

modules

模块是 Nuxt 扩展，可以扩展其核心功能并添加无限集成。

每个模块都是字符串（可以指代包，也可以是文件路径）、带有模块作为第一个字符串和选项作为第二个对象的元组，或者是内联模块函数。Nuxt 尝试使用节点 require 路径（在 node_modules 中）解析模块数组中的每个项，然后如果使用 ~ 别名，则将从项目 srcDir 中解析。

类型: array

注意: 模块按顺序执行，因此顺序很重要。首先加载 nuxt.config.ts 中定义的模块。然后，执行 modules/ 目录中找到的模块，它们按字母顺序加载。

示例:

export default defineNuxtConfig({
  modules: [
  // Using package name
    '@nuxt/scripts',
    // Relative to your project srcDir
    '~/custom-modules/awesome.js',
    // Providing options
    ['@nuxtjs/google-analytics', { ua: 'X1234567' }],
    // Inline definition
    function () {},
  ],
})

modulesDir

用于设置用于路径解析的模块目录（例如，webpack 的 resolveLoading、nodeExternals 和 postcss）。

配置路径是相对于 options.rootDir（默认是当前工作目录）。如果您的项目组织为 yarn workspace 风格的单一仓库，则可能需要设置此字段。

类型: array
默认

[
  "/<rootDir>/node_modules"
]

示例:

export default defineNuxtConfig({
  modulesDir: ['../../node_modules'],
})

nitro

Nitro 配置。

请参阅: Nitro 配置文档

`runtimeConfig`

类型: object
默认

{
  "public": {},
  "app": {
    "buildId": "4a2e2d30-418f-41df-8e58-ed5df06de7fd",
    "baseURL": "/",
    "buildAssetsDir": "/_nuxt/",
    "cdnURL": ""
  },
  "nitro": {
    "envPrefix": "NUXT_"
  }
}

optimization

构建时优化配置。

`asyncTransforms`

直接传递给 unctx 转换器的选项，该转换器在 await 后保留异步上下文。

`asyncFunctions`

类型: array
默认

[
  "defineNuxtPlugin",
  "defineNuxtRouteMiddleware"
]

`objectDefinitions`

`defineNuxtComponent`

类型: array
默认

[
  "asyncData",
  "setup"
]

`defineNuxtPlugin`

类型: array
默认

[
  "setup"
]

`definePageMeta`

类型: array
默认

[
  "middleware",
  "validate"
]

`keyedComposables`

注入键的函数。

只要传递给函数的参数数量小于 argumentLength，就会注入一个额外的魔术字符串，该字符串可用于在服务器和客户端之间进行请求去重。您需要采取措施来处理这个额外的键。该键将根据文件中调用函数的位置而唯一。

类型: array
默认

[
  {
    "name": "callOnce",
    "argumentLength": 3
  },
  {
    "name": "defineNuxtComponent",
    "argumentLength": 2
  },
  {
    "name": "useState",
    "argumentLength": 2
  },
  {
    "name": "useFetch",
    "argumentLength": 3
  },
  {
    "name": "useAsyncData",
    "argumentLength": 3
  },
  {
    "name": "useLazyAsyncData",
    "argumentLength": 3
  },
  {
    "name": "useLazyFetch",
    "argumentLength": 3
  }
]

`treeShake`

从特定构建中进行代码摇树。

`composables`

从服务器或客户端构建中进行可组合函数的摇树。

示例:

export default defineNuxtConfig({
  optimization: {
    treeShake: {
      composables: {
        client: { vue: ['onMounted'] },
        server: { vue: ['onServerPrefetch'] },
      },
    },
  },
})

`client`

类型: object
默认

{
  "vue": [
    "onRenderTracked",
    "onRenderTriggered",
    "onServerPrefetch"
  ],
  "#app": [
    "definePayloadReducer",
    "definePageMeta",
    "onPrehydrate"
  ]
}

`服务器`

类型: object
默认

{
  "vue": [
    "onMounted",
    "onUpdated",
    "onUnmounted",
    "onBeforeMount",
    "onBeforeUpdate",
    "onBeforeUnmount",
    "onRenderTracked",
    "onRenderTriggered",
    "onActivated",
    "onDeactivated"
  ],
  "#app": [
    "definePayloadReviver",
    "definePageMeta"
  ]
}

pages

是否在 Nuxt 3 中使用 vue-router 集成。如果您不提供值，则如果您在源文件夹中有 app/pages/ 目录，它将被启用。

此外，您可以提供一个 glob 模式或模式数组，以仅扫描某些文件以查找页面。

示例:

export default defineNuxtConfig({
  pages: {
    pattern: ['**/*/*.vue', '!**/*.spec.*'],
  },
})

plugins

Nuxt 应用程序插件数组。

每个插件都可以是字符串（可以是文件的绝对路径或相对路径）。如果它以 .client 或 .server 结尾，则它将自动仅在适当的上下文中加载。它也可以是带有 src 和 mode 键的对象。

类型: array

注意: 插件也会从 ~/plugins 目录自动注册，这些插件不需要在 nuxt.config 中列出，除非您需要自定义它们的顺序。所有插件都按其源路径去重。

请参阅: app/plugins/ 目录文档

示例:

export default defineNuxtConfig({
  plugins: [
    '~/custom-plugins/foo.client.js', // only in client side
    '~/custom-plugins/bar.server.js', // only in server side
    '~/custom-plugins/baz.js', // both client & server
    { src: '~/custom-plugins/both-sides.js' },
    { src: '~/custom-plugins/client-only.js', mode: 'client' }, // only on client side
    { src: '~/custom-plugins/server-only.js', mode: 'server' }, // only on server side
  ],
})

postcss

`plugins`

配置 PostCSS 插件的选项。

请参阅: PostCSS 文档

`autoprefixer`

解析 CSS 并向 CSS 规则添加供应商前缀的插件。

请参阅: autoprefixer

rootDir

定义应用程序的根目录。

此属性可以被覆盖（例如，运行 nuxt ./my-app/ 会将 rootDir 设置为当前/工作目录中 ./my-app/ 的绝对路径。通常不需要配置此选项。

类型: string
默认: "/<rootDir>"

routeRules

应用于匹配服务器路由的全局路由选项。

实验性: 这是一个实验性功能，API 可能会在未来发生变化。

请参阅: Nitro 路由规则文档

router

`options`

传递给 vue-router 的额外路由选项。除了 vue-router 的选项外，Nuxt 还提供了额外的选项来定制路由器（见下文）。

注意: 只有 JSON 可序列化的选项才能通过 Nuxt 配置传递。为了进行更多控制，您可以使用 router.options.ts 文件。

请参阅: Vue Router 文档

`hashMode`

您可以在 SPA 模式下启用哈希历史记录。在此模式下，路由器在内部传递的实际 URL 前使用哈希字符 (#)。启用后，URL 永远不会发送到服务器，并且不支持 SSR。

类型：boolean
默认: false

默认: false

`scrollBehaviorType`

自定义哈希链接的滚动行为。

类型: string
默认: "auto"

默认: 'auto'

此对象的值只能通过 useRuntimeConfig 从服务器访问。它主要应该包含不暴露在前端的私有配置。这可能包括对您的 API 秘密令牌的引用。在 public 和 app 下的任何内容也将暴露给前端。值将通过运行时的匹配环境变量自动替换，例如设置环境变量 NUXT_API_KEY=my-api-key NUXT_PUBLIC_BASE_URL=/foo/ 将覆盖以下示例中的两个值。

类型: object
默认

{
  "public": {},
  "app": {
    "buildId": "4a2e2d30-418f-41df-8e58-ed5df06de7fd",
    "baseURL": "/",
    "buildAssetsDir": "/_nuxt/",
    "cdnURL": ""
  }
}

示例:

export default defineNuxtConfig({
  runtimeConfig: {
    apiKey: '', // Default to an empty string, automatically set at runtime using process.env.NUXT_API_KEY
    public: {
      baseURL: '', // Exposed to the frontend as well.
    },
  },
})

服务器

Nuxt 服务器构建器的配置。

`builder`

指定用于捆绑应用程序服务器部分的服务器构建器。

默认情况下，Nuxt 使用 @nuxt/nitro-server，它提供独立的 Nitro 集成。这种架构允许不同的 Nitro 集成模式，例如使用 Nitro 作为 Vite 插件（与 Vite 环境 API）。

类型: string | { bundle: (nuxt: Nuxt) => Promise<void> }
默认: "@nuxt/nitro-server"

此选项仅供内部使用，API 尚未最终确定。在依赖当前实现之前，请先提交一个 issue。

serverDir

定义 Nuxt 应用程序的服务器目录，其中包含 Nitro 路由、中间件和插件。

如果指定了相对路径，它将相对于您的 rootDir。

类型: string
默认: "/<srcDir>/server"

serverHandlers

Nitro 服务器处理程序。

每个处理程序都接受以下选项

handler: 定义处理程序的文件路径。 - route: 处理程序可用的路由。这遵循以下约定rou3。 - method: 应处理的请求的 HTTP 方法。 - middleware: 指定是否是中间件处理程序。 - lazy: 指定是否使用延迟加载导入处理程序。
类型: array

请参阅: server/ 目录文档

注意: server/api、server/middleware 和 server/routes 中的文件将由 Nuxt 自动注册。

示例:

export default defineNuxtConfig({
  serverHandlers: [
    { route: '/path/foo/**:name', handler: '~/server/foohandler.ts' },
  ],
})

sourcemap

配置是否以及如何为服务器和/或客户端捆绑包生成源映射。

如果设置为单个布尔值，则该值适用于服务器和客户端。此外，'hidden' 选项也适用于服务器和客户端。客户端和服务器的可用选项： - true：生成源映射并在最终捆绑包中包含源引用。 - false：不生成任何源映射。 - 'hidden'：生成源映射但不包含最终捆绑包中的引用。

类型: object
默认

{
  "server": true,
  "client": false
}

spaLoadingTemplate

布尔值或 HTML 文件的路径，其内容将插入到任何使用 ssr: false 渲染的 HTML 页面中。

如果未设置，它将使用您的某个层中的 ~/spa-loading-template.html 文件（如果存在）。 - 如果为 false，则不会加载任何 SPA 加载指示器。 - 如果为 true，Nuxt 将在您的某个层中查找 ~/spa-loading-template.html 文件，否则将使用默认的 Nuxt 图像。一些好的加载器来源是SpinKit或SVG Spinners.
默认: null

示例: ~/spa-loading-template.html

<!-- https://github.com/barelyhuman/snips/blob/dev/pages/css-loader.md -->
<div class="loader"></div>
<style>
.loader {
  display: block;
  position: fixed;
  z-index: 1031;
  top: 50%;
  left: 50%;
  transform: translate(-50%, -50%);
  width: 18px;
  height: 18px;
  box-sizing: border-box;
  border: solid 2px transparent;
  border-top-color: #000;
  border-left-color: #000;
  border-bottom-color: #efefef;
  border-right-color: #efefef;
  border-radius: 50%;
  -webkit-animation: loader 400ms linear infinite;
  animation: loader 400ms linear infinite;
}

@-webkit-keyframes loader {
  0% {
    -webkit-transform: translate(-50%, -50%) rotate(0deg);
  }
  100% {
    -webkit-transform: translate(-50%, -50%) rotate(360deg);
  }
}
@keyframes loader {
  0% {
    transform: translate(-50%, -50%) rotate(0deg);
  }
  100% {
    transform: translate(-50%, -50%) rotate(360deg);
  }
}
</style>

srcDir

定义 Nuxt 应用程序的源目录。

如果指定了相对路径，它将相对于 rootDir。

类型: string
默认: "app" (Nuxt 4), "." (Nuxt 3 与 compatibilityMode: 3)

示例:

export default defineNuxtConfig({
  srcDir: 'app/',
})

这需要以下文件夹结构

-| app/
---| assets/
---| components/
---| layouts/
---| middleware/
---| pages/
---| plugins/
---| app.config.ts
---| app.vue
---| error.vue
-| server/
-| public/
-| modules/
-| nuxt.config.js
-| package.json

ssr

是否启用 HTML 渲染 - 动态（在服务器模式下）或在生成时。如果设置为 false，生成的页面将没有内容。

类型：boolean
默认: true

telemetry

手动禁用 Nuxt 遥测。

请参阅: Nuxt 遥测获取更多信息。

test

您的应用程序是否正在进行单元测试。

类型：boolean
默认: false

theme

从本地或远程源扩展项目。

该值应为指向源目录或相对于当前配置的配置路径的字符串。您可以使用 github:、gitlab:、bitbucket: 或 https:// 从远程 git 仓库进行扩展。

类型: string

typescript

Nuxt 的 TypeScript 集成配置。

`builder`

要为您的项目包含哪些构建器类型。

默认情况下，Nuxt 根据您的 builder 选项推断此项（默认为 'vite'），但您可以关闭构建器环境类型（使用 false）以完全自行处理，或选择 'shared' 选项。建议模块作者使用 'shared' 选项，他们将希望支持多个可能的构建器。

默认: null

`hoist`

要在 compilerOptions.paths 中生成深层别名的模块。这尚不支持子路径。在 pnpm monorepo 中使用 Nuxt 且 shamefully-hoist=false 时可能需要。

类型: array
默认

[
  "nitropack/types",
  "nitropack/runtime",
  "nitropack",
  "defu",
  "h3",
  "consola",
  "ofetch",
  "@unhead/vue",
  "@nuxt/devtools",
  "vue",
  "@vue/runtime-core",
  "@vue/compiler-sfc",
  "vue-router",
  "vue-router/auto-routes",
  "unplugin-vue-router/client",
  "@nuxt/schema",
  "nuxt"
]

`includeWorkspace`

在 Nuxt 项目中包含父工作区。主要用于主题和模块作者。

类型：boolean
默认: false

`shim`

生成 *.vue shim。

我们建议让官方 Vue 扩展为您的组件生成准确的类型。请注意，如果您正在使用其他无法理解 .vue 文件类型的库（例如 ESLint），您可能希望将其设置为 true。

类型：boolean
默认: false

`strict`

TypeScript 带有某些检查，可以为您的程序提供更高的安全性和分析。一旦您将代码库转换为 TypeScript，您就可以开始启用这些检查以获得更高的安全性。阅读更多

类型：boolean
默认: true

`tsConfig`

您可以使用此选项扩展生成的 TypeScript 配置（.nuxt/tsconfig.app.json、.nuxt/tsconfig.server.json 等）。

`typeCheck`

启用构建时类型检查。

如果设置为 true，这将在开发中进行类型检查。您可以通过将其设置为 build 将其限制为构建时类型检查。需要将 typescript 和 vue-tsc 安装为开发依赖项。

类型：boolean
默认: false

请参阅: Nuxt TypeScript 文档

unhead

一个对象，允许我们配置 unhead nuxt 模块。

`legacy`

为 unhead 模块启用旧版兼容模式。这会应用以下更改： - 禁用 Capo.js 排序 - 添加 DeprecationsPlugin：支持 hid、vmid、children、body - 添加 PromisesPlugin：支持 promises 作为输入

类型：boolean
默认: false

请参阅: unhead 迁移文档

示例:

export default defineNuxtConfig({
  unhead: {
    legacy: true,
  },
})

`renderSSRHeadOptions`

一个将传递给 renderSSRHead 以自定义输出的对象。

类型: object
默认

{
  "omitLineBreaks": false
}

示例:

export default defineNuxtConfig({
  unhead: {
    renderSSRHeadOptions: {
      omitLineBreaks: true,
    },
  },
})

vite

将直接传递给 Vite 的配置。

请参阅: Vite 配置文档了解更多信息。请注意，并非所有 vite 选项都受 Nuxt 支持。

`build`

`assetsDir`

类型: string
默认: "_nuxt/"

`emptyOutDir`

类型：boolean
默认: false

`cacheDir`

类型: string
默认: "/<rootDir>/node_modules/.cache/vite"

`clearScreen`

类型：boolean
默认: true

`define`

类型: object
默认

{
  "__VUE_PROD_HYDRATION_MISMATCH_DETAILS__": false,
  "process.dev": false,
  "import.meta.dev": false,
  "process.test": false,
  "import.meta.test": false
}

`esbuild`

类型: object
默认

{
  "target": "esnext",
  "jsxFactory": "h",
  "jsxFragment": "Fragment",
  "tsconfigRaw": {}
}

`模式`

类型: string
默认: "production"

`optimizeDeps`

`esbuildOptions`

类型: object
默认

{
  "target": "esnext",
  "jsxFactory": "h",
  "jsxFragment": "Fragment",
  "tsconfigRaw": {}
}

`exclude`

类型: array
默认

[
  "vue-demi"
]

`publicDir`

`resolve`

`extensions`

类型: array
默认

[
  ".mjs",
  ".js",
  ".ts",
  ".jsx",
  ".tsx",
  ".json",
  ".vue"
]

`root`

类型: string
默认: "/<srcDir>"

`服务器`

`fs`

`allow`

类型: array
默认

[
  "/<rootDir>/.nuxt",
  "/<srcDir>",
  "/<rootDir>",
  "/<workspaceDir>"
]

`vue`

`features`

`propsDestructure`

类型：boolean
默认: true

`isProduction`

类型：boolean
默认: true

`script`

`hoistStatic`

`template`

`compilerOptions`

类型: object

`transformAssetUrls`

类型: object
默认

{
  "video": [
    "src",
    "poster"
  ],
  "source": [
    "src"
  ],
  "img": [
    "src"
  ],
  "image": [
    "xlink:href",
    "href"
  ],
  "use": [
    "xlink:href",
    "href"
  ]
}

`vueJsx`

类型: object
默认

{
  "isCustomElement": {
    "$schema": {
      "title": "",
      "description": "",
      "tags": []
    }
  }
}

vue

Vue.js 配置

`compilerOptions`

将在构建时传递给 Vue 编译器的选项。

请参阅: Vue 文档

`config`

可以全局配置 Vue 应用程序。只有可序列化的选项可以在您的 nuxt.config 中设置。所有其他选项应在 Nuxt 插件中运行时设置。

请参阅: Vue 应用程序配置文档

`propsDestructure`

为 defineProps 启用响应式解构

类型：boolean
默认: true

`runtimeCompiler`

在运行时捆绑包中包含 Vue 编译器。

类型：boolean
默认: false

`transformAssetUrls`

`image`

类型: array
默认

[
  "xlink:href",
  "href"
]

`img`

类型: array
默认

[
  "src"
]

`source`

类型: array
默认

[
  "src"
]

`use`

类型: array
默认

[
  "xlink:href",
  "href"
]

`video`

类型: array
默认

[
  "src",
  "poster"
]

watch

watch 属性允许您定义在更改时将重新启动 Nuxt 开发服务器的模式。

它是一个字符串或正则表达式数组。字符串应为绝对路径或相对于 srcDir（以及任何层的 srcDir）的相对路径。正则表达式将与相对于项目 srcDir（以及任何层的 srcDir）的路径进行匹配。

类型: array

类型：boolean
默认: true

`ignorePermissionErrors`

类型：boolean
默认: true

类型：number
默认: 1000

webpack

`aggressiveCodeRemoval`

硬替换 typeof process、typeof window 和 typeof document 以进行捆绑包的 tree-shake。

类型：boolean
默认: false

`analyze`

如果您正在使用 webpack，Nuxt 使用 webpack-bundle-analyzer 来可视化您的捆绑包以及如何优化它们。

设置为 true 以启用捆绑分析，或传递一个包含选项的对象用于 webpack或用于 vite.

类型: object
默认

{
  "template": "treemap",
  "projectRoot": "/<rootDir>",
  "filename": "/<rootDir>/.nuxt/analyze/{name}.html"
}

示例:

export default defineNuxtConfig({
  webpack: {
    analyze: {
      analyzerMode: 'static',
    },
  },
})

`cssSourceMap`

启用 CSS 源映射支持（开发环境中默认为 true）。

类型：boolean
默认: false

`devMiddleware`

请参阅webpack-dev-middleware可用选项。

`stats`

类型: string
默认: "none"

`experiments`

配置webpack experiments

`extractCSS`

启用通用 CSS 提取。

使用在底层使用 mini-css-extract-plugin，您的 CSS 将被提取到单独的文件中，通常每个组件一个文件。这允许单独缓存您的 CSS 和 JavaScript。如果您想将所有 CSS 提取到一个文件中，有一个解决方案。但是，请注意，不建议将所有内容提取到单个文件中。提取到多个 CSS 文件有利于缓存和预加载隔离。它还可以通过仅下载和解析所需的资源来提高页面性能。

类型：boolean
默认: true

示例:

export default defineNuxtConfig({
  webpack: {
    extractCSS: true,
    // or
    extractCSS: {
      ignoreOrder: true,
    },
  },
})

filenames

示例:

export default defineNuxtConfig({
  webpack: {
    extractCSS: true,
    optimization: {
      splitChunks: {
        cacheGroups: {
          styles: {
            name: 'styles',
            test: /\.(css|vue)$/,
            chunks: 'all',
            enforce: true,
          },
        },
      },
    },
  },
})

`自定义捆绑包文件名。`

要了解更多关于清单文件的使用，请查看

webpack 文档注意: 在生产环境中使用非哈希文件名时要小心，因为大多数浏览器会缓存资产，并且在首次加载时不会检测到更改。.

此示例将花哨的块名更改为数字 ID

chunk

示例:

export default defineNuxtConfig({
  webpack: {
    filenames: {
      chunk: ({ isDev }) => (isDev ? '[name].js' : '[id].[contenthash].js'),
    },
  },
})

`app`

类型: function

`font`

类型: function

`css`

类型: function

`friendlyErrors`

类型: function

`img`

类型: function

`video`

类型: function

`设置为 false 以禁用由`

FriendlyErrorsWebpackPlugin提供的覆盖层.

类型：boolean
默认: true

`esModule`

类型：boolean
默认: false

`importLoaders`

类型：number
默认: 0

`url`

`filter`

类型: function

`cssModules`

请参阅css-loader可用选项。

`esModule`

类型：boolean
默认: false

`importLoaders`

类型：number
默认: 0

`modules`

`localIdentName`

类型: string
默认: "[local]_[hash:base64:5]"

`url`

`filter`

类型: function

`esbuild`

类型: object
默认

{
  "target": "esnext",
  "jsxFactory": "h",
  "jsxFragment": "Fragment",
  "tsconfigRaw": {}
}

请参阅: esbuild 加载器

`file`

请参阅: file-loader 选项

默认:

{ "esModule": false }

`esModule`

类型：boolean
默认: false

`limit`

类型：number
默认: 1000

`fontUrl`

请参阅: file-loader 选项

默认:

{ "esModule": false }

`esModule`

类型：boolean
默认: false

`limit`

类型：number
默认: 1000

`imgUrl`

请参阅: file-loader 选项

默认:

{ "esModule": false }

`esModule`

类型：boolean
默认: false

`limit`

类型：number
默认: 1000

`less`

默认

{
  "sourceMap": false
}

请参阅: less-loader 选项

`pugPlain`

请参阅: pug 选项

`sass`

请参阅: sass-loader 选项

默认:

{
  "sassOptions": {
    "indentedSyntax": true
  }
}

`sassOptions`

`indentedSyntax`

类型：boolean
默认: true

`scss`

默认

{
  "sourceMap": false
}

请参阅: sass-loader 选项

`stylus`

默认

{
  "sourceMap": false
}

请参阅: stylus-loader 选项

`vue`

请参阅vue-loader可用选项。

`compilerOptions`

类型: object

`propsDestructure`

类型：boolean
默认: true

`transformAssetUrls`

类型: object
默认

{
  "video": [
    "src",
    "poster"
  ],
  "source": [
    "src"
  ],
  "img": [
    "src"
  ],
  "image": [
    "xlink:href",
    "href"
  ],
  "use": [
    "xlink:href",
    "href"
  ]
}

`vueStyle`

默认

{
  "sourceMap": false
}

`optimization`

配置webpack 优化.

`minimize`

将 minimize 设置为 false 以禁用所有最小化器。（默认在开发中禁用）。

类型：boolean
默认: true

`minimizer`

您可以将 minimizer 设置为自定义插件数组。

`runtimeChunk`

类型: string
默认: "single"

`splitChunks`

`automaticNameDelimiter`

类型: string
默认: "/"

`cacheGroups`

`chunks`

类型: string
默认: "all"

`optimizeCSS`

OptimizeCSSAssets 插件选项。

当 extractCSS 启用时，默认为 true。

类型：boolean
默认: false

请参阅: css-minimizer-webpack-plugin 文档.

`plugins`

添加 webpack 插件。

类型: array

示例:

import webpack from 'webpack'
import { version } from './package.json'

export default defineNuxtConfig({
  webpack: {
    plugins: [
      // ...
      new webpack.DefinePlugin({
        'process.VERSION': version,
      }),
    ],
  },
})

`postcss`

自定义 PostCSS 加载器。选项与postcss-loader 选项

`postcssOptions`

`plugins`

类型: object
默认

{
  "autoprefixer": {},
  "cssnano": {}
}

`profile`

在 webpackbar 中启用性能分析器。

通常通过 CLI 参数 --profile 启用。

类型：boolean
默认: false

请参阅: webpackbar.

`serverURLPolyfill`

用于提供 URL 和 URLSearchParams 的 polyfill 库。

默认为 'url'（查看包).

类型: string
默认: "url"

`warningIgnoreFilters`

用于隐藏构建警告的过滤器。

类型: array

workspaceDir

定义应用程序的工作区目录。

这通常用于 monorepo 设置。Nuxt 将尝试自动检测您的工作区目录，但您可以在此处覆盖它。通常不需要配置此选项。

类型: string
默认: "/<workspaceDir>"

这有帮助吗？

报告问题或在 GitHub 上编辑此页面

导入元信息

使用 `import.meta` 了解您的代码正在哪里运行。

Hello World

一个最小的 Nuxt 应用程序只需要 `app.vue` 和 `nuxt.config.js` 文件。