模块
了解如何从 Nuxt 2 迁移到 Nuxt 3 模块。
模块兼容性
Nuxt 3 对使用 @nuxt/kit 自动包装的 Nuxt 2 模块有一个基本的向后兼容层。但通常要遵循一些步骤来使模块兼容 Nuxt 3,有时,要实现跨版本兼容还需要使用 Nuxt Bridge。
我们已经准备了一份专用指南,用于使用 @nuxt/kit 编写兼容 Nuxt 3 的模块。目前最佳的迁移路径是遵循它并重写你的模块。本指南的其余部分包含了准备工作步骤,如果你希望避免完全重写但又要让模块兼容 Nuxt 3,可以使用这些步骤。
插件兼容性
Nuxt 3 的插件不完全向后兼容 Nuxt 2。Vue 兼容性
使用 Composition API 的插件或组件需要独占的 Vue 2 或 Vue 3 支持。
通过使用 vue-demi,它们应该同时兼容 Nuxt 2 和 3。
模块迁移
当 Nuxt 3 用户添加你的模块时,你将无法访问模块容器(this.*),因此你将需要使用来自 @nuxt/kit 的工具来访问容器功能。
使用 @nuxt/bridge 测试
迁移到 @nuxt/bridge 是支持 Nuxt 3 的第一步,也是最重要的一步。
如果你的模块中有一个 fixture 或示例,请将 @nuxt/bridge 包添加到它的配置中(参见示例)。
从 CommonJS 迁移到 ESM
Nuxt 3 原生支持 TypeScript 和 ECMAScript 模块。请查看原生 ES 模块了解更多信息及升级方法。
确保插件默认导出
如果你注入了一个没有 export default 的 Nuxt 插件(例如全局 Vue 插件),请确保在其末尾添加 export default () => { }。
// ~/plugins/vuelidate.js
import Vue from 'vue'
import Vuelidate from 'vuelidate'
Vue.use(Vuelidate)
// ~/plugins/vuelidate.js
import Vue from 'vue'
import Vuelidate from 'vuelidate'
Vue.use(Vuelidate)
export default () => { }
避免运行时模块
使用 Nuxt 3,Nuxt 现在是一个仅在构建时使用的依赖,这意味着模块不应尝试钩入 Nuxt 运行时。
即使你的模块只被添加到 buildModules(而不是 modules),你的模块也应该正常工作。例如:
- 避免在 Nuxt 模块内更新
process.env并由 Nuxt 插件读取;改用runtimeConfig。 - (*)避免依赖
vue-renderer:*这样的运行时钩子用于生产 - (*)避免通过在模块内导入的方式来添加
serverMiddleware。相反,通过引用文件路径来添加它们,使它们独立于模块的上下文
(*)除非这仅用于 nuxt dev 目的,并用 if (nuxt.options.dev) { } 保护。
使用 TypeScript(可选)
虽然这不是必须的,但 Nuxt 生态的大部分正在转向使用 TypeScript,因此强烈建议考虑迁移。.js 文件重命名为 .ts 来开始迁移。TypeScript 被设计为渐进式的!
::