nuxt logo

文档翻译(非官方)

配置

Nuxt 配置了合理的默认值以提高您的生产力。

默认情况下,Nuxt 被配置为涵盖大多数使用案例。可以通过 nuxt.config.ts 文件覆盖或扩展此默认配置。

Nuxt 配置

nuxt.config.ts 文件位于 Nuxt 项目的根目录,可以覆盖或扩展应用程序的行为。

一个最小的配置文件导出包含您的配置对象的 defineNuxtConfig 函数。defineNuxtConfig 辅助函数在全局范围内可用,无需导入。

nuxt.config.ts
export default defineNuxtConfig({
  // 我的 Nuxt 配置
})

该文件经常在文档中提到,例如添加自定义脚本、注册模块或更改渲染模式。

另请参阅 api > configuration > nuxt-config

您不必使用 TypeScript 来构建 Nuxt 应用程序。然而,强烈建议为 nuxt.config 文件使用 .ts 扩展名。这样,您可以在编辑配置时从 IDE 中获得提示,以避免拼写错误和错误。

环境覆盖

您可以在 nuxt.config 中配置完全类型化的、按环境划分的覆盖。

nuxt.config.ts
export default defineNuxtConfig({
  $production: {
    routeRules: {
      '/**': { isr: true }
    }
  },
  $development: {
    //
  },
  $env: {
    staging: {
      // 
    }
  },
})

要在运行 Nuxt CLI 命令时选择环境,只需将名称传递给 --envName 标志,例如:nuxt build --envName staging

要了解有关这些覆盖背后的机制的更多信息,请参阅 环境特定配置c12 文档。

如果您正在编写层,您还可以使用 $meta 键提供您或您的层的使用者可能使用的元数据。

环境变量和私有令牌

runtimeConfig API 将环境变量等值暴露给应用程序的其余部分。默认情况下,这些键仅在服务器端可用。runtimeConfig.publicruntimeConfig.app(Nuxt 内部使用)中的键也在客户端可用。

这些值应在 nuxt.config 中定义,并可以使用环境变量覆盖。

export default defineNuxtConfig({
  runtimeConfig: {
    // 仅在服务器端可用的私有键
    apiSecret: '123',
    // public 中的键也在客户端暴露
    public: {
      apiBase: '/api'
    }
  }
})

这些变量通过 useRuntimeConfig() 组合函数暴露给应用程序的其余部分。

pages/index.vue
const runtimeConfig = useRuntimeConfig()
另请参阅 guide > going-further > runtime-config

应用配置

app.config.ts 文件位于源目录(默认情况下为项目根目录),用于暴露可以在构建时确定的公共变量。与 runtimeConfig 选项相反,这些不能使用环境变量覆盖。

一个最小的配置文件导出包含您的配置对象的 defineAppConfig 函数。defineAppConfig 辅助函数在全局范围内可用,无需导入。

app.config.ts
export default defineAppConfig({
  title: 'Hello Nuxt',
  theme: {
    dark: true,
    colors: {
      primary: '#ff0000'
    }
  }
})

这些变量通过 useAppConfig 组合函数暴露给应用程序的其余部分。

pages/index.vue
const appConfig = useAppConfig()
另请参阅 guide > directory-structure > app-config

runtimeConfig vs. app.config

如上所述,runtimeConfigapp.config 都用于将变量暴露给应用程序的其余部分。为了确定您应该使用哪一个,这里有一些指导原则:

  • runtimeConfig:需要在构建后使用环境变量指定的私有或公共令牌。
  • app.config:在构建时确定的公共令牌,网站配置如主题变体、标题和任何不敏感的项目配置。
功能runtimeConfigapp.config
客户端HydratedBundled
环境变量✅ 是❌ 否
响应式✅ 是✅ 是
类型支持✅ 部分✅ 是
每个请求的配置❌ 否✅ 是
热模块替换❌ 否✅ 是
非原始 JS 类型❌ 否✅ 是

外部配置文件

Nuxt 使用 nuxt.config.ts 文件作为配置的单一真实来源,并跳过读取外部配置文件。在构建项目的过程中,您可能需要配置这些。下表突出显示了常见配置,以及在适用情况下如何使用 Nuxt 进行配置。

名称配置文件如何配置
Nitronitro.config.ts使用 nuxt.config 中的 nitro
PostCSSpostcss.config.js使用 nuxt.config 中的 postcss
Vitevite.config.ts使用 nuxt.config 中的 vite
webpackwebpack.config.ts使用 nuxt.config 中的 webpack

以下是其他常见配置文件的列表:

名称配置文件如何配置
TypeScripttsconfig.json更多信息
ESLinteslint.config.js更多信息
Prettierprettier.config.js更多信息
Stylelintstylelint.config.js更多信息
TailwindCSStailwind.config.js更多信息
Vitestvitest.config.ts更多信息

Vue 配置

使用 Vite

如果您需要将选项传递给 @vitejs/plugin-vue@vitejs/plugin-vue-jsx,可以在 nuxt.config 文件中进行配置。

  • vite.vue 用于 @vitejs/plugin-vue。查看 可用选项
  • vite.vueJsx 用于 @vitejs/plugin-vue-jsx。查看 可用选项
nuxt.config.ts
export default defineNuxtConfig({
  vite: {
    vue: {
      customElement: true
    },
    vueJsx: {
      mergeProps: true
    }
  }
})
另请参阅 api > configuration > nuxt-config#vue

使用 webpack

如果您使用 webpack 并需要配置 vue-loader,可以在 nuxt.config 文件中使用 webpack.loaders.vue 键进行配置。可用选项在 此处定义

nuxt.config.ts
export default defineNuxtConfig({
  webpack: {
    loaders: {
      vue: {
        hotReload: true,
      }
    }
  }
})
另请参阅 api > configuration > nuxt-config#loaders

启用实验性 Vue 功能

您可能需要在 Vue 中启用实验性功能,例如 propsDestructure。Nuxt 提供了一种简单的方法来在 nuxt.config.ts 中启用这些功能,无论您使用哪个构建器:

nuxt.config.ts
export default defineNuxtConfig({
  vue: {
    propsDestructure: true
  }
})

从 Vue 3.4 和 Nuxt 3.9 迁移的实验性 reactivityTransform

自 Nuxt 3.9 和 Vue 3.4 起,reactivityTransform 已从 Vue 移至 Vue Macros,后者具有 Nuxt 集成

另请参阅 api > configuration > nuxt-config#vue-1