配置
nuxt.config
您 Nuxt 应用的起点仍然是您的 nuxt.config
文件。
迁移
- 您应该迁移到新的
defineNuxtConfig
函数,该函数提供类型化的配置模式。export default { // ... }
export default defineNuxtConfig({ // ... })
- 如果您使用了
router.extendRoutes
,您可以迁移到新的pages:extend
钩子:export default { router: { extendRoutes (routes) { // } } }
export default defineNuxtConfig({ hooks: { 'pages:extend' (routes) { // } } })
- 如果您使用了
router.routeNameSplitter
,您可以通过在新的pages:extend
钩子中更新路由名称生成逻辑来实现相同的结果:export default { router: { routeNameSplitter: '/' } }
import { createResolver } from '@nuxt/kit' export default defineNuxtConfig({ hooks: { 'pages:extend' (routes) { const routeNameSplitter = '/' const root = createResolver(import.meta.url).resolve('./pages') function updateName(routes) { if (!routes) return for (const route of routes) { const relativePath = route.file.substring(root.length + 1) route.name = relativePath.slice(0, -4).replace(/\/index$/, '').replace(/\//g, routeNameSplitter) updateName(route.children) } } updateName(routes) }, }, })
ESM 语法
Nuxt 3 是一个 原生 ESM 框架。尽管 unjs/jiti
在加载 nuxt.config
文件时提供了半兼容性,但请避免在此文件中使用 require
和 module.exports
。
- 将
module.exports
更改为export default
- 将
const lib = require('lib')
更改为import lib from 'lib'
异步配置
为了使 Nuxt 加载行为更加可预测,异步配置语法已被弃用。考虑使用 Nuxt 钩子进行异步操作。
Dotenv
Nuxt 内置支持加载 .env
文件。请避免直接从 nuxt.config
中导入它。
模块
Nuxt 和 Nuxt 模块现在仅在构建时使用。
迁移
- 将所有
buildModules
移动到modules
。 - 检查模块的 Nuxt 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 支持的更多信息 在这里。
vue-tsc
通过 nuxi typecheck
命令对您的应用进行类型检查。迁移
- 创建一个包含以下内容的
tsconfig.json
:{ "extends": "./.nuxt/tsconfig.json" }
- 运行
npx nuxi prepare
以生成.nuxt/tsconfig.json
。 - 按照 文档 中的说明安装 Volar。
Vue 更改
在推荐的 Vue 最佳实践中有许多更改,以及 Vue 2 和 3 之间的一些破坏性更改。
建议阅读 Vue 3 迁移指南,特别是 破坏性更改列表。
目前无法在 Nuxt 3 中使用 Vue 3 迁移构建。
Vuex
Nuxt 不再提供 Vuex 集成。相反,官方 Vue 建议使用 pinia
,它通过 Nuxt 模块 提供内置的 Nuxt 支持。在这里了解更多关于 pinia 的信息。
通过 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,该模块应能开箱即用。