模块

模块兼容性

Nuxt 3 使用 @nuxt/kit 自动封装器为 Nuxt 2 模块提供了一个基本的向后兼容层。但通常需要遵循一些步骤才能使模块与 Nuxt 3 兼容，有时为了跨版本兼容性，需要使用 Nuxt Bridge。

我们准备了一份专用指南，用于使用 @nuxt/kit 编写适用于 Nuxt 3 的模块。目前最佳的迁移路径是遵循该指南并重写您的模块。本指南的其余部分包括了如果您希望避免完全重写但仍使模块与 Nuxt 3 兼容的准备步骤。

插件兼容性

Nuxt 3 插件与 Nuxt 2 不完全向后兼容。

Vue 兼容性

使用组合式 API 的插件或组件需要专属的 Vue 2 或 Vue 3 支持。

通过使用vue-demi它们应该与 Nuxt 2 和 Nuxt 3 兼容。

模块迁移

当 Nuxt 3 用户添加您的模块时，您将无法访问模块容器（this.*），因此您需要使用 @nuxt/kit 中的工具来访问容器功能。

使用 @nuxt/bridge 进行测试

迁移到 @nuxt/bridge 是支持 Nuxt 3 的第一步也是最重要的一步。

如果您的模块中有 fixture 或示例，请在其配置中添加 @nuxt/bridge 包（请参阅示例）

从 CommonJS 迁移到 ESM

Nuxt 3 原生支持 TypeScript 和 ECMAScript Modules。请查看原生 ES 模块以获取更多信息和升级。

确保插件默认导出

如果您注入的 Nuxt 插件没有 export default（例如全局 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，因此强烈建议考虑迁移。