@ graphox/ swc- 插件
概览
为 Graphox 编码预建的 SWC 插件 。 这个软件包将WASM二进制捆绑起来,以便于与rsbuild,Turbopack,或原生SWC一起使用.
先决条件
从源头构建 WASM 插件需要:
- Rust工具链: 被钉入
rust-toolchain.toml—— 说rustup安装它, 编辑wasm32-wasip1目标,自动 - 节点.js 22.13+(由pnpm 11要求)
- 小时 11点:
corepack enable && corepack install -g pnpm@latest
对于预建软件包的用户,只需要Node.js 18+.
安装
pnpm add @graphox/swc-plugin
所需资源
- 节点.js 18+
- rsbuilding、涡轮包装或原生SWC
主机版本
以 WASM 模块形式编译的插件船 swc_core,则
SWC 主机只运行它自己的 swc_core 这至少是新的。 每个主机嵌入
swc_core 因此,各层各有不同:
| 东道主 | 最低 |
|---|---|
@swc/core | 1.15.0 (韩语) |
@rspack/core,以及 @rsbuild/core 通过它 | 2.2.0 (中文(简体) ) |
在旧主机上 建造失败 failed to invoke plugin,通常与
给主机命名提示 swc_core 版本。 更新主机——插件无法
工作围绕它.
使用量
构建配置
// rsbuild.config.ts
import { defineConfig } from '@rsbuild/core';
import { createSWCPlugin } from '@graphox/swc-plugin';
import path from 'path';
export default defineConfig({
source: {
alias: {
'__generated__': path.resolve(__dirname, './__generated__'),
},
},
tools: {
swc: {
jsc: {
parser: {
syntax: 'typescript',
tsx: true,
},
experimental: {
plugins: [
createSWCPlugin({
manifestPath: './__generated__/manifest.json',
outputDir: './__generated__'
})
],
},
},
},
},
});
下一个.js 配置
// next.config.mjs
import path from 'node:path';
import { fileURLToPath } from 'node:url';
import { createSWCPlugin } from '@graphox/swc-plugin';
const appDir = path.dirname(fileURLToPath(import.meta.url));
// Turbopack passes the plugin each module's path relative to this directory:
// here the root of a workspace two levels above the app
const root = path.join(appDir, '..', '..');
/** @type {import('next').NextConfig} */
const nextConfig = {
turbopack: { root },
experimental: {
swcPlugins: [
createSWCPlugin({
outputs: [{ outputDir: path.join(appDir, '__generated__') }],
root,
}),
],
},
};
export default nextConfig;
设定 turbopack.root 财务报告和审定财务报表 root 到同一目录: 工作空间根
单列波 应用程序的目录。 Webpack 构建通过绝对路径和
忽略 root。 。 。 .
多个项目
模块对照多个输出目录解决 GraphQL 的工作空间 应全部登记在 一个 插件实例 :
graphox.createSWCPlugin({
outputs: [
{ outputDir: path.resolve(__dirname, 'app/graphql') },
{ outputDir: path.resolve(repoRoot, 'packages/auth/graphql') },
{ outputDir: path.resolve(repoRoot, 'packages/catalog/graphql') },
],
})
每个产出一个实例是昂贵和不完整的:
- 费用. SWC 将整个 AST 序列化到插件中并返回每个 每个模块上的插件,无论插件是否更改任何内容. 模块 完全属于一个输出, 因此在 N 例中, 其中 N− 1 个回合 每个单元都保证不操作.
- 正确之处. 实例只知道自己的项目,所以不能重写 跨越工程边界的导入。 记录了每个产出 一起重定向从另一个项目的切入点导入的文档 直接在项目生成的文件.
跨项目进口
在拥有输出的软件包中,文档是通过相对路径导入的. 跨越包的边界, 相对路径会到达包的 子路径导出, 所以导入要通过软件包的公开显示符 相反:
// packages/storefront/graphql/storefront.codegen.ts, before
import { ProductCardFragmentDoc } from "@example/catalog/graphql";
// after
import { ProductCardFragmentDoc } from "@example/catalog/graphql/catalog.codegen";
这需要自有软件包导出其输出内的文件 目录, 而不仅仅是切入点 :
{
"name": "@example/catalog",
"exports": {
"./graphql": "./graphql/index.ts",
"./graphql/*": "./graphql/*"
}
}
插件从软件包中推断出规格 name 财务报告和审定财务报表 exports,以及
警告在缺少通配符时指定要添加的确切条目。 推论是
故意保守主义 exports 子路径
解析到输出目录——如此设置 importAlias 明确用于软件包
没有 exports 字段,或仅通过捆绑者化名解决.
文件名称和来源可能在整个产出中重复。 界定两个项目
SetPriceMutationDocument,即使有相同的源文本,也很好:
解析范围为输入的入口,而不是搜索
跨越一个合并的地图.
输出目录必须明确,不得筑巢.
配置选项
| 选项 | 类型 | 需求 | 说明 |
|---|---|---|---|
outputs | object[] | 对* | 每个项目一个条目;见下文。 首选单一产出领域 |
emitExtensions | string | 没有 | 生成导入的文件扩展名 : "none" (违约), "ts", (中文(简体) ), "js", (中文(简体) ), "dts" |
root | string | 没有 | 目录主机的模块路径相对,对于一个通过相对路径的主机(Turbopack). 反对 cwd |
每个条目 outputs数字 :
| 选项 | 类型 | 需求 | 说明 |
|---|---|---|---|
outputDir | string | 对 | 包含生成文件的目录 |
manifestPath | string | 没有 | 路径 manifest.json默认为 <outputDir>/manifest.json |
manifestData | object[] | 没有 | 内含显示数据, 而不是 manifestPath |
graphqlImportPaths | string[] | 没有 | 作为 GraphQL 切入点处理的额外导入路径 |
importAlias | string | 没有 | 此输出的公开规格, 例如 . @example/catalog/graphql从包裹中推断出来的 name 财务报告和审定财务报表 exports |
packageRoot | string | 没有 | 拥有此输出的软件包的根 。 推断为最近的目录 package.json |
* 单一产出形式—— outputDir, (中文(简体) ), manifestPath, (中文(简体) ), manifestData, (中文(简体) ),
graphqlImportPaths, (中文(简体) ), importAlias 财务报告和审定财务报表 packageRoot 在最高一级——仍然是
被接受并表现为一个单一要素 outputs。 。 。 .
地方发展
您可以通过设置 WASM 插件路径来覆盖 GRAPHOX_SWC_PLUGIN_PATH 环境变量。 这对测试 Rust 插件的本地建筑有用而无需复制文件 .
export GRAPHOX_SWC_PLUGIN_PATH=$(pwd)/target/wasm32-wasip1/release/graphox_swc_plugin.wasm
超接是一个绝对路径,Turbopack不加载.
喷出量
控制所生成导入路径所附加的文件扩展名。 应该符合 emit_extensions 设置 graphox.yaml数字 :
| 数值 | 结果 |
|---|---|
"none" (默认) | import { X } from "./file.codegen" |
"ts" | import { X } from "./file.codegen.ts" |
"js" | import { X } from "./file.codegen.js" |
"dts" | import { X } from "./file.codegen.d.ts" |
分块文档
何时 generate_ast_for_fragments: true 在配置中被启用,片段文档也包含在运算表中,并由插件正确重写.
没有文件的碎片,例如: @type_only 一,单从其出处列出于清单. 插件替换其 graphql() 调用 {},该值 graphql.ts 返回它,所以 ResultOf<typeof Doc> 仍然按键.
与 graphql_tag_fallback: true, (中文(简体) ), graphql.ts 在运行时剖析这样的片段, 插件无法做到这一点 。 碎片则从清单中被忽略出,插件则无法在其上建构 graphql() 电话.
来源建筑
如果您需要重建 WASM 插件 :
# Install dependencies
pnpm install
# Build TypeScript only (requires pre-built WASM)
pnpm run build
# Build WASM only (requires Rust toolchain)
pnpm run build:wasm
# Build everything (TypeScript + WASM)
pnpm run build:all
# Run tests
pnpm test
另见
许可证
麻省理工学院——见 自由主义。 。 。 .