模块解析

JavaScript 中的模块解析是一个复杂的主题。

当前的生态系统正处于从 CommonJS 模块到原生 ES 模块的多年转型之中。TypeScript 强制执行自己的一套关于导入扩展名的规则，这些规则与 ESM 不兼容。不同的构建工具通过不同的不兼容机制支持路径重映射。

Bun 旨在提供一个一致且可预测的模块解析系统，使其能够正常工作。不幸的是，它仍然相当复杂。

语法

考虑以下文件。

import { hello } from "./hello";

hello();

export function hello() {
  console.log("Hello world!");
}

当我们运行 index.ts 时，它会打印 “Hello world!”。

bun index.ts

Hello world!

在这种情况下，我们从 ./hello 导入，这是一个没有扩展名的相对路径。扩展名导入是可选的，但受支持。 为了解析此导入，Bun 将按顺序检查以下文件

• ./hello.tsx
• ./hello.jsx
• ./hello.ts
• ./hello.mjs
• ./hello.js
• ./hello.cjs
• ./hello.json
• ./hello/index.tsx
• ./hello/index.jsx
• ./hello/index.ts
• ./hello/index.mjs
• ./hello/index.js
• ./hello/index.cjs
• ./hello/index.json

导入路径可以选择性地包含扩展名。如果存在扩展名，Bun 将仅检查具有该确切扩展名的文件。

import { hello } from "./hello";
import { hello } from "./hello.ts"; // this works

如果您从 "*.js{x}" 导入，Bun 将额外检查匹配的 *.ts{x} 文件，以与 TypeScript 的 ES 模块支持 兼容。

import { hello } from "./hello";
import { hello } from "./hello.ts"; // this works
import { hello } from "./hello.js"; // this also works

Bun 同时支持 ES 模块 (import/export 语法) 和 CommonJS 模块 (require()/module.exports)。以下 CommonJS 版本也将在 Bun 中工作。

const { hello } = require("./hello");

hello();

function hello() {
  console.log("Hello world!");
}

exports.hello = hello;

尽管如此，在新项目中不鼓励使用 CommonJS。

模块系统

Bun 原生支持 CommonJS 和 ES 模块。ES 模块是新项目的推荐模块格式，但 CommonJS 模块在 Node.js 生态系统中仍然被广泛使用。

在 Bun 的 JavaScript 运行时中，ES 模块和 CommonJS 模块都可以使用 require。如果目标模块是 ES 模块，require 返回模块命名空间对象 (等同于 import * as)。如果目标模块是 CommonJS 模块，require 返回 module.exports 对象 (与 Node.js 中相同)。

使用 require()

您可以 require() 任何文件或包，甚至是 .ts 或 .mjs 文件。

const { foo } = require("./foo"); // extensions are optional
const { bar } = require("./bar.mjs");
const { baz } = require("./baz.tsx");

// my-commonjs.cjs
const stuff = require("./stuff");
module.exports = { stuff };

使用 import

您可以 import 任何文件或包，甚至是 .cjs 文件。

import { foo } from "./foo"; // extensions are optional
import bar from "./bar.ts";
import { stuff } from "./my-commonjs.cjs";

一起使用 import 和 require()

在 Bun 中，您可以在同一文件中同时使用 import 或 require —— 它们始终都有效。

import { stuff } from "./my-commonjs.cjs";
import Stuff from "./my-commonjs.cjs";
const myStuff = require("./my-commonjs.cjs");

顶层 await

此规则的唯一例外是顶层 await。您无法 require() 使用顶层 await 的文件，因为 require() 函数本质上是同步的。

幸运的是，很少有库使用顶层 await，因此这很少成为问题。但是，如果您在应用程序代码中使用顶层 await，请确保该文件没有从应用程序的其他地方被 require()。相反，您应该使用 import 或 动态 import()。

导入包

Bun 实现了 Node.js 模块解析算法，因此您可以使用裸标识符从 node_modules 导入包。

import { stuff } from "foo";

此算法的完整规范已在 Node.js 文档 中正式记录；我们不会在此处重复。简而言之：如果您从 "foo" 导入，Bun 会向上扫描文件系统，查找包含包 foo 的 node_modules 目录。

一旦找到 foo 包，Bun 会读取 package.json 以确定应如何导入该包。为了确定包的入口点，Bun 首先读取 exports 字段并检查以下条件。

{
  "name": "foo",
  "exports": {
    "bun": "./index.js",
    "node": "./index.js",
    "require": "./index.js", // if importer is CommonJS
    "import": "./index.mjs", // if importer is ES module
    "default": "./index.js",
  }
}

在 package.json 中首先出现的这些条件中的任何一个都用于确定包的入口点。

Bun 遵循子路径 "exports" 和 "imports"。

{
  "name": "foo",
  "exports": {
    ".": "./index.js"
  }
}

子路径导入和条件导入协同工作。

{
  "name": "foo",
  "exports": {
    ".": {
      "import": "./index.mjs",
      "require": "./index.js"
    }
  }
}

与 Node.js 中一样，在 "exports" 映射中指定任何子路径将阻止其他子路径被导入；您只能导入显式导出的文件。给定上面的 package.json

import stuff from "foo"; // this works
import stuff from "foo/index.mjs"; // this doesn't

如果未定义 exports，Bun 将回退到 "module" (仅限 ESM 导入)，然后回退到 "main"。

{
  "name": "foo",
  "module": "./index.js",
  "main": "./index.js"
}

自定义条件

--conditions 标志允许您指定在从 package.json "exports" 解析包时要使用的条件列表。

bun build 和 Bun 的运行时都支持此标志。

# Use it with bun build:

bun build --conditions="react-server" --target=bun ./app/foo/route.js

# Use it with bun's runtime:

bun --conditions="react-server" ./app/foo/route.js

您还可以通过 Bun.build 以编程方式使用 conditions

await Bun.build({
  conditions: ["react-server"],
  target: "bun",
  entryPoints: ["./app/foo/route.js"],
});

路径重映射

本着将 TypeScript 视为一等公民的精神，Bun 运行时将根据 tsconfig.json 中的 compilerOptions.paths 字段重新映射导入路径。这与 Node.js 有很大的不同，Node.js 不支持任何形式的导入路径重映射。

{
  "compilerOptions": {
    "paths": {
      "config": ["./config.ts"],         // map specifier to file
      "components/*": ["components/*"],  // wildcard matching
    }
  }
}

如果您不是 TypeScript 用户，则可以在项目根目录中创建一个 jsconfig.json 以实现相同的行为。

(function (module, exports, require) {
  // transpiled module
})(module, exports, require);