全局变量替换

Oxc transformer 支持替换全局变量。

求值顺序

inject 先于 define 运行，且二者都在所有其他转换之后运行。有关完整顺序，请参见 transformer 概览。

定义

“Define” 功能提供了一种用常量表达式替换全局变量的方式。这个功能类似于 Terser 的 global_defs 选项和 esbuild 的 define 选项。

// 输入
const foo = __DEV__ ? 1 : 2;

// 输出
const foo = 1;

// 示例
import { transform } from "oxc-transform";

const result = await transform("lib.js", sourceCode, {
  define: {
    __DEV__: "true",
  },
});

每个 define 条目都会将一个表达式映射到包含表达式的代码字符串。键可以是标识符（例如 __DEV__）、由标识符组成的点分序列（例如 process.env.NODE_ENV 或 import.meta.env.MODE），也可以是对上述任一形式使用 typeof 的表达式（例如 typeof window 或 typeof globalThis.process）。值必须是有效的表达式。

import { transform } from "oxc-transform";

const result = await transform("lib.js", sourceCode, {
  define: {
    "typeof window": '"undefined"',
  },
});

始终给值加引号

define 的值是表达式字符串。这意味着值应该始终是字符串。如果你想表示字符串字面量，就应该给它加引号（例如 __MODE__: '"development"'、__MODE__: JSON.stringify("development")）。

对象引用不会共享

与 esbuild 不同，当向 define 选项的值传入对象时，对象引用不会共享。这意味着如果你修改了该对象，这些修改不会反映到其他地方。

const foo = __OBJECT__;
foo.bar = 1;
console.log(foo.bar); // 1

const bar = __OBJECT__;
console.log(foo.bar); // undefined

// 示例
import { transform } from "oxc-transform";

const result = await transform("lib.js", sourceCode, {
  define: {
    __OBJECT__: "{}",
  },
});

注入

“Inject” 功能提供了一种用模块导入来替换全局变量的方法。此功能类似于 esbuild 的 inject 选项和 @rollup/plugin-inject。

// 输入
const foo = new Promise((resolve) => resolve(1));

// 输出
import { Promise as P } from "es6-promise";
const foo = new P((resolve) => resolve(1));

// 示例
import { transform } from "oxc-transform";

const result = await transform("lib.js", sourceCode, {
  inject: {
    P: ["es6-promise", "Promise"],
  },
});

每个 inject 条目都会将一个表达式映射到一个导入的标识符。其键必须是一个标识符（例如 __DEV__），或由标识符组成的点分序列（例如 process.env.NODE_ENV）。其值必须是导入源字符串，或者是由导入源和导入名称组成的字符串元组（* 表示命名空间导入）。

const examples = {
  // 从 'es6-promise' 导入 { Promise }
  Promise: ["es6-promise", "Promise"],
  // 从 'es6-promise' 导入 { Promise as P }
  P: ["es6-promise", "Promise"],
  // 从 'jquery' 导入 $
  $: "jquery",
  // 从 'fs' 导入 * as fs
  fs: ["fs", "*"],
  // 使用本地模块替代第三方模块
  "Object.assign": path.resolve("src/helpers/object-assign.js"),
};

全局变量替换 ​

定义 ​

注入 ​

全局变量替换

定义

注入