配置

nuxt.config

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

迁移

1. 您应该迁移到新的 defineNuxtConfig 函数，它提供了类型化的配置模式。
   Nuxt 2Nuxt 3

   export default {
     // ...
   }
   

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

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

3. 如果您使用了 router.routeNameSplitter，可以通过在新的 pages:extend 钩子中更新路由名称生成逻辑来实现相同效果：
   Nuxt 2Nuxt 3

   export default {
     router: {
       routeNameSplitter: '/'
     }
   }
   

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'
    ]
  })

目录变更

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

TypeScript

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

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

迁移

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

   {
     "files": [],
     "references": [
       {
         "path": "./.nuxt/tsconfig.app.json"
       },
       {
         "path": "./.nuxt/tsconfig.server.json"
       },
       {
         "path": "./.nuxt/tsconfig.shared.json"
       },
       {
         "path": "./.nuxt/tsconfig.node.json"
       }
     ]
   }
   

2. 运行 npx nuxt prepare 生成 tsconfig 文件。
3. 按照文档中的说明安装 Volar。

Vue 变更

Vue 2 和 Vue 3 之间存在许多推荐的最佳实践变更，以及若干重大变更。

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

目前无法在 Nuxt 3 中使用 Vue 3 迁移构建。

Vuex

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

提供全局状态管理的简单方法如下：

安装 @pinia/nuxt 模块：

yarn add pinia @pinia/nuxt

在您的 Nuxt 配置中启用该模块：

import { defineNuxtConfig } from 'nuxt/config';

export default defineNuxtConfig({
  modules: ['@pinia/nuxt']
})

在应用根目录创建一个 store 文件夹：

import { defineStore } from 'pinia'

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

创建一个插件文件以全局化您的 store：

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);
})

对于大型应用，此迁移可能涉及大量工作。如果更新 Vuex 仍存在障碍，您可以考虑使用社区模块：nuxt3-vuex-module，它应该可以开箱即用。