配置文档 Configuration

nuxt.config

Nuxt 应用程序的起点仍然是您的 nuxt.config 文件。

迁移步骤

1. 您应该迁移到提供类型化配置架构的新“defineNuxtConfig”函数。
   Nuxt 2Nuxt 3

   ts

   Nuxt 2

   ts

   export default {
     // ...
   }
   

2. 如果您使用的是 router.extendRoutes，您可以迁移到新的 pages:extend 挂钩：
   Nuxt 2Nuxt 3

   ts

   Nuxt 2

   ts

   export default {
     router: {
       extendRoutes(routes) {
         //
       }
     }
   }
   

ESM 语法

Nuxt 3 是一个 ESM 原生框架。 尽管 unjs/jiti 在加载 nuxt.config 文件时提供半兼容性，但请避免在此文件中使用 require 和 module.exports。

1. 将 module.exports 更改为 export default
2. 将 const lib = require('lib') 更改为 import lib from 'lib'

异步配置

为了使 Nuxt 加载行为更可预测，不推荐使用异步配置语法。 考虑使用 Nuxt 钩子进行异步操作。

Dotenv

Nuxt 内置支持加载 .env 文件。 避免直接从 nuxt.config 导入它。

模块

Nuxt 和 Nuxt 模块现在仅限构建时。

迁移步骤

1. 将所有的 buildModules 移到 modules 中。
2. 检查模块的 Nuxt 3 兼容性。
3. 如果您有任何指向目录的本地模块，您应该将其更新为指向入口文件：

  export default defineNuxtConfig({
    modules: [
-     '~/modules/my-module'
+     '~/modules/my-module/index'
    ]
  })

Directory Changes

static/ 目录(用于存储静态资产)已重命名为 public/。 您可以将 static 目录重命名为 public，或者通过在 nuxt.config 中设置 dir.public 来保留名称。

TypeScript

如果您使用 Nuxt 的 TypeScript 集成，那么迁移您的应用程序会容易得多。 这并不意味着您需要使用 TypeScript 编写您的应用程序，只是 Nuxt 将为您的编辑器提供自动类型提示。

您可以 在文档中 阅读更多关于 Nuxt 的 TypeScript 支持的信息。

迁移步骤

1. 创建一个包含以下内容的 tsconfig.json：
   json

   {
     "extends": "./.nuxt/tsconfig.json"
   }
   

2. 运行npx nuxi prepare生成.nuxt/tsconfig.json。
3. 按照 docs 中的说明安装 Volar。

Vue变更

推荐的 Vue 最佳实践有很多变化，Vue 2 和 3 之间也有一些重大变化。

建议阅读 Vue 3 迁移指南，尤其是 重大变更列表。

目前无法将 Vue 3 迁移构建 与 Nuxt 3 一起使用。

Vuex

Nuxt 不再提供 Vuex 集成。 相反，官方 Vue 建议使用 pinia，它通过 Nuxt 模块 内置了 Nuxt 支持。 在此处了解更多关于 pinia 的信息。

使用 pinia 提供全局状态管理的一种简单方法是：

安装 @pinia/nuxt 模块：

yarn add pinia @pinia/nuxt

在应用程序的根目录下创建一个 store 文件夹：

import { defineStore } from 'pinia'

export const useMainStore = defineStore('main', {
  state: () => ({
    counter: 0,
  }),
  actions: {
    increment() {
      // `this` is the store instance
      this.counter++
    },
  },
})

创建一个 plugin 文件来全球化您的商店：

import { useMainStore } from '~/store'

export default defineNuxtPlugin(({ $pinia }) => {
  return {
    provide: {
      store: useMainStore($pinia)
    }
  }
})

如果您想继续使用 Vuex，可以按照 这些步骤 手动迁移到 Vuex 4。

完成后，您需要将以下插件添加到您的 Nuxt 应用程序中：

import store from '~/store'

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.vueApp.use(store)
})