ES 模块

Nuxt 使用原生 ES 模块。

本指南旨在解释什么是 ES 模块，以及如何让 Nuxt 应用（或上游库）与 ESM 兼容。

背景

CommonJS 模块

CommonJS (CJS) 是由 Node.js 引入的一种格式，允许在隔离的 JavaScript 模块之间共享功能（了解详情）。你可能已经熟悉这种语法

const a = require('./a')

module.exports.a = a

像 webpack 和 Rollup 这样的打包工具支持此语法，并允许你在浏览器中使用用 CommonJS 编写的模块。

ESM 语法

大多数时候，当人们讨论 ESM 与 CJS 时，他们是在讨论编写模块的不同语法。

import a from './a'

export { a }

在 ECMAScript 模块（ESM）成为标准之前（花了十多年时间！），像 webpack 甚至像 TypeScript 这样的语言就开始支持所谓的 ESM 语法。然而，它与实际规范存在一些关键区别；这里有一篇有用的解释说明。

什么是“原生”ESM？

你可能很长一段时间以来一直在使用 ESM 语法编写应用。毕竟，浏览器本身就支持它，在 Nuxt 2 中，我们将你编写的所有代码都编译成了适当的格式（服务端使用 CJS，浏览器使用 ESM）。

在为你的包添加模块时，情况则略有不同。一个示例库可能会同时暴露 CJS 和 ESM 版本，并让我们选择所需的版本

{
  "name": "sample-library",
  "main": "dist/sample-library.cjs.js",
  "module": "dist/sample-library.esm.js"
}

因此在 Nuxt 2 中，打包工具（webpack）会为服务端构建引入 CJS 文件（'main'），并为客户端构建使用 ESM 文件（'module'）。

module 字段是 webpack 和 Rollup 等打包工具使用的一种惯例，但 Node.js 本身并不识别它。Node.js 在模块解析时只使用 exports 和 main 字段。

然而，在最近的 Node.js LTS 版本中，现在已经可以在 Node.js 中使用原生 ESM 模块。这意味着 Node.js 本身可以处理使用 ESM 语法的 JavaScript，尽管它默认不会这样做。启用 ESM 语法的两种最常见方法是

在你的 package.json 中设置 "type": "module" 并继续使用 .js 扩展名
使用 .mjs 文件扩展名（推荐）

这就是我们在 Nuxt Nitro 中所做的；我们输出一个 .output/server/index.mjs 文件。这会告诉 Node.js 将此文件视为原生 ES 模块。

在 Node.js 环境中，什么是有效的导入？

当你 import 一个模块而不是 require 它时，Node.js 的解析方式会有所不同。例如，当你导入 sample-library 时，Node.js 会在该库的 package.json 中查找 exports 条目，如果未定义 exports，则回退到 main 条目。

动态导入也是如此，例如 const b = await import('sample-library')。

Node 支持以下几种导入方式（参见文档）

以 .mjs 结尾的文件 - 这些文件应使用 ESM 语法
以 .cjs 结尾的文件 - 这些文件应使用 CJS 语法
以 .js 结尾的文件 - 除非它们的 package.json 包含 "type": "module"，否则这些文件应使用 CJS 语法

可能会遇到哪些问题？

长期以来，模块作者一直在生成 ESM 语法的构建版本，但使用的是诸如 .esm.js 或 .es.js 之类的约定，并将其添加到其 package.json 的 module 字段中。直到现在这都不是问题，因为它们仅被 webpack 等打包工具使用，而打包工具并不特别关心文件扩展名。

然而，如果你尝试在 Node.js ESM 环境中导入带有 .esm.js 文件的包，它将无法工作，并且你会得到类似以下的错误

终端

(node:22145) Warning: To load an ES module, set "type": "module" in the package.json or use the .mjs extension.
/path/to/index.js:1

export default {}
^^^^^^

SyntaxError: Unexpected token 'export'
    at wrapSafe (internal/modules/cjs/loader.js:1001:16)
    at Module._compile (internal/modules/cjs/loader.js:1049:27)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1114:10)
    ....
    at async Object.loadESM (internal/process/esm_loader.js:68:5)

如果你从 Node.js 认为是 CJS 的 ESM 语法构建中进行命名导入，你也可能会遇到此错误

终端

file:///path/to/index.mjs:5
import { named } from 'sample-library'
         ^^^^^
SyntaxError: Named export 'named' not found. The requested module 'sample-library' is a CommonJS module, which may not support all module.exports as named exports.

CommonJS modules can always be imported via the default export, for example using:

import pkg from 'sample-library';
const { named } = pkg;

    at ModuleJob._instantiate (internal/modules/esm/module_job.js:120:21)
    at async ModuleJob.run (internal/modules/esm/module_job.js:165:5)
    at async Loader.import (internal/modules/esm/loader.js:177:24)
    at async Object.loadESM (internal/process/esm_loader.js:68:5)

排查 ESM 问题

如果你遇到这些错误，问题几乎可以肯定是出在上游库上。他们需要修复他们的库以支持被 Node 导入。

转译库

在此期间，你可以通过将这些库添加到 build.transpile 中来告诉 Nuxt 不要尝试导入它们

export default defineNuxtConfig({
  build: {
    transpile: ['sample-library'],
  },
})

你可能会发现你也需要添加这些库正在导入的其他包。

为库设置别名

在某些情况下，你可能还需要手动将该库别名指向 CJS 版本，例如

export default defineNuxtConfig({
  alias: {
    'sample-library': 'sample-library/dist/sample-library.cjs.js',
  },
})

默认导出

具有 CommonJS 格式的依赖项可以使用 module.exports 或 exports 来提供默认导出

node_modules/cjs-pkg/index.js

module.exports = { test: 123 }
// or
exports.test = 123

如果我们 require 这样的依赖项，这通常运作良好

test.cjs

const pkg = require('cjs-pkg')

console.log(pkg) // { test: 123 }

处于原生 ESM 模式的 Node.js、启用了 esModuleInterop 的 typescript 以及诸如 webpack 之类的打包工具提供了一种兼容性机制，使我们能够默认导入此类库。该机制通常被称为 "interop require default"

import pkg from 'cjs-pkg'

console.log(pkg) // { test: 123 }

然而，由于语法检测的复杂性和不同的打包格式，互操作默认值有时仍可能会失败，从而导致类似以下的情况

import pkg from 'cjs-pkg'

console.log(pkg) // { default: { test: 123 } }

此外，在使用动态导入语法时（在 CJS 和 ESM 文件中都是如此），我们也会遇到这种情况

import('cjs-pkg').then(console.log) // [Module: null prototype] { default: { test: '123' } }

在这种情况下，我们需要手动对默认导出进行互操作

// Static import
import { default as pkg } from 'cjs-pkg'

// Dynamic import
import('cjs-pkg').then(m => m.default || m).then(console.log)

为了处理更复杂的情况并获得更高的安全性，我们建议并在 Nuxt 内部使用能够保留命名导出的 mlly。

import { interopDefault } from 'mlly'

// Assuming the shape is { default: { foo: 'bar' }, baz: 'qux' }
import myModule from 'my-module'

console.log(interopDefault(myModule)) // { foo: 'bar', baz: 'qux' }

库作者指南

好消息是，修复 ESM 兼容性问题相对简单。主要有两种选择

你可以将你的 ESM 文件重命名为以 .mjs 结尾。
这是推荐且最简单的方法。你可能需要解决库的依赖项以及构建系统的问题，但在大多数情况下，这应该能为你解决问题。为了获得最大的明确性，还建议将你的 CJS 文件重命名为以 .cjs 结尾。
你可以选择将整个库做成仅支持 ESM.
这意味着在你的 package.json 中设置 "type": "module"，并确保你构建的库使用 ESM 语法。然而，你可能会面临依赖项方面的问题 —— 并且这种方法意味着你的库只能在 ESM 环境中被消费。

迁移

从 CJS 过渡到 ESM 的第一步是将所有对 require 的使用更新为使用 import

module.exports = function () { /* ... */ }

exports.hello = 'world'

export default function () { /* ... */ }

export const hello = 'world'

const myLib = require('my-lib')

import myLib from 'my-lib'
// or
const dynamicMyLib = await import('my-lib').then(lib => lib.default || lib)

在 ESM 模块中，与 CJS 不同，全局变量 require、require.resolve、__filename 和 __dirname 不可用，应该用 import() 和 import.meta.filename 来替换。

const { join } = require('node:path')

const newDir = join(__dirname, 'new-dir')

import { fileURLToPath } from 'node:url'

const newDir = fileURLToPath(new URL('./new-dir', import.meta.url))

const someFile = require.resolve('./lib/foo.js')

import { resolvePath } from 'mlly'

const someFile = await resolvePath('my-lib', { url: import.meta.url })

最佳实践

优先使用命名导出而不是默认导出。这有助于减少 CJS 冲突。（参见默认导出章节）
尽可能避免依赖 Node.js 内置模块、CommonJS 或仅限 Node.js 的依赖项，以便你的库无需 Nitro 垫片即可在浏览器和 Edge Worker 中使用。
使用带有条件导出的新 exports 字段。（了解详情）。

{
  "exports": {
    ".": {
      "import": "./dist/mymodule.mjs"
    }
  }
}

这有帮助吗？

报告问题或在 GitHub 上编辑此页