模块

模块兼容性

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 和 3 都兼容。

模块迁移

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

使用 @nuxt/bridge 测试

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

如果您的模块中存在夹具或示例，请将 @nuxt/bridge 包添加到其配置中（请参阅 示例）

从 CommonJS 迁移到 ESM

Nuxt 3 原生支持 TypeScript 和 ECMAScript 模块。有关更多信息和升级，请查看 原生 ES 模块。

确保插件默认导出

如果您注入的 Nuxt 插件没有 export default（例如全局 Vue 插件），请确保在末尾添加 export default () => { }。

// ~/plugins/vuelidate.js
import Vue from 'vue'
import Vuelidate from 'vuelidate'

Vue.use(Vuelidate)

避免运行时模块

在 Nuxt 3 中，Nuxt 现在仅是构建时依赖项，这意味着模块不应尝试挂钩到 Nuxt 运行时。

即使您的模块仅添加到 buildModules（而不是 modules）中，它也应该能够工作。例如

• 避免在 Nuxt 模块内更新 process.env 并在 Nuxt 插件中读取；请改用 runtimeConfig。
• (*) 避免依赖于生产环境中的 vue-renderer:* 等运行时钩子
• (*) 避免通过在模块内部导入来添加 serverMiddleware。相反，通过引用文件路径来添加它们，以便它们独立于模块的上下文

(*) 除非仅用于 nuxt dev 目的，并使用 if (nuxt.options.dev) { } 保护。

使用 TypeScript（可选）

虽然这不是必需的，但大多数 Nuxt 生态系统正在转向使用 TypeScript，因此强烈建议您考虑迁移。