Transformer

一个高性能的 transformer，可将不受支持的语法重写为目标运行时支持的形式。

特性

以下功能按固定顺序运行，无论选项的顺序如何：

1. React 编译器 — 最先运行，基于原始源代码。
2. TypeScript — 类型剥离。
3. 装饰器。
4. 插件 — 例如 styled-components。
5. React Refresh — 组件插桩，在 JSX 转换之前运行。
6. JSX — 将 JSX 转换为 JavaScript。
7. 降级 — 从 ES2026 降级到 ES2015。
8. 注入 — 全局变量注入。
9. 定义 — 全局变量替换。

Oxc 还支持在不使用 TypeScript 编译器的情况下进行 TypeScript Isolated Declarations emit。

通用选项

transform 函数接受文件名、源代码以及一个选项对象：

import { transform } from "oxc-transform";

const result = await transform("lib.ts", sourceCode, {
  // 强制指定源语言。默认根据文件名推断。
  lang: "tsx", // "js" | "jsx" | "ts" | "tsx" | "dts"

  // 将源文件视为脚本、模块或 CommonJS。默认自动推断。
  sourceType: "module", // "script" | "module" | "commonjs" | "unambiguous"

  // 当前工作目录。用于解析相对路径。
  cwd: "/path/to/project",

  // 启用 source map 生成。
  sourcemap: true,

  // 配置运行时 helper 策略。
  helpers: {
    mode: "Runtime", // "Runtime"（从 @oxc-project/runtime 导入）或 "External"（使用全局 babelHelpers）
  },

  // 更多选项请参见子页面：
  // typescript, jsx, target, assumptions, define, inject, decorator, plugins
});

transform 函数是异步的。也提供具有相同签名的同步版本 transformSync。

安装

Node.js

• 使用 node 绑定包 oxc-transform。
• 在 stackblitz 上试用。

Rust

使用带有 transformer 特性的总包 crate oxc。

Rust 使用示例可在此处查看。

集成

• unplugin-oxc
• unplugin-isolated-decl
• oxc-webpack-loader