mirror of https://github.com/oxc-project/oxc.git synced 2026-09-14 19:36:11 +08:00

Files

T

History

Boshen 1c4f519e36 feat(napi): add Relay transform plugin (#25503 )

## What

Ports the Relay `graphql` tagged template transform (babel-plugin-relay / swc_relay) as an individual napi transform, per #24914:

- **`crates/oxc_relay`** — the core transform as its own crate (modeled on `oxc_react_compiler`): replaces `graphql` tagged templates with references to relay-compiler artifacts. Definition names are extracted textually like `swc_relay` (equivalent to `\b(fragment|mutation|query|subscription)\s+(\w+)` with `#` comments stripped; hand-rolled scanner, no regex dependency).
- **`napi/transform-relay`** (`oxc-transform-relay`) — standalone napi package copied from the `napi/transform-react` template: parse → semantic → relay traverse → codegen. Only `graphql` tags are rewritten; TypeScript/JSX syntax is preserved untouched, so the output composes with any downstream toolchain.

## Options

| option | default | behavior |
|---|---|---|
| `artifactDirectory` | unset | when set, the import path is computed lexically relative to the transformed file (babel-plugin-relay `getRelativeImportPath` semantics — swc emits absolute paths instead); unset → `./__generated__/` next to the file |
| `language` | `javascript` | `typescript` imports `Name.graphql.ts`, otherwise `Name.graphql.js` |
| `eagerEsModules` | `true` | hoisted default imports (babel-plugin-relay ≥ v17 parity); `false` emits inline `require()` (`@swc/plugin-relay` / Next.js behavior) |

A `graphql` tag with no extractable definition name produces an error diagnostic (babel throws; swc silently skips).

Not supported, documented in both READMEs: dev-mode artifact hash validation, `jsModuleFormat: "haste"`, `isDevVariableName`, swc's Next.js-specific `projects`/`pagesDir`, and GraphQL document validation.

closes #24914

---

Implemented with Claude Code.

2026-08-13 13:56:01 +00:00

src

…

tests

…

Cargo.toml

…

CHANGELOG.md

…

README.md

…

README.md

oxc_relay

Rust port of the Relay graphql tagged template transform (babel-plugin-relay / swc_relay).

Replaces graphql tagged template expressions with references to the artifact files generated by relay-compiler:

const data = graphql`
  query FooQuery {
    id
  }
`;

becomes (with eager_es_modules: true, the default):

import _FooQuery from "./__generated__/FooQuery.graphql.js";
const data = _FooQuery;

or (with eager_es_modules: false):

const data = require("./__generated__/FooQuery.graphql.js");

This crate backs the oxc-transform-relay Node.js package in napi/transform-relay.

Limitations

Compared to babel-plugin-relay:

No development-mode artifact hash validation (console.error on stale artifacts) — like swc_relay, the transform is production-shaped.
No jsModuleFormat: "haste" and no isDevVariableName.
The definition name is extracted textually (like swc_relay), not by parsing the GraphQL document, so documents are not validated.