@ graphox/ babel- 插件
概览
确保 GraphQL AST 文件被正确编码,防止它们在初始块中结束 .
为什么使用这个插件?
Codegen 已经在编译时间生成 AST 文件 。 问题在于捆绑者的行为:
没有插件 :
Initial chunk: ALL generated AST files (~50KB+)
Lazy chunks: empty or minimal
带有插件 :
Initial chunk: ~1KB (just imports)
Lazy chunks: each operation in its chunk
安装
pnpm add --save-dev @graphox/babel-plugin
快速启动
1. 配置图解
# graphox.yaml
output_dir: "__generated__"
projects:
- schema: "schema.graphql"
include: "src/**/*.{ts,tsx}"
2. 运行代码源
pnpm graphox codegen
3. 配置贝贝
// babel.config.js
const path = require('path');
module.exports = {
presets: ['@babel/preset-typescript'],
plugins: [
['@graphox/babel-plugin', {
manifestPath: path.resolve(__dirname, '__generated__/manifest.json'),
outputDir: path.resolve(__dirname, '__generated__'),
graphqlImportPaths: ['@/graphql']
}]
]
};
Metro( 反应原生)
地铁在车盖下使用巴别尔变压器. 配置在 metro.config.js数字 :
// metro.config.js
module.exports = {
transformer: {
babelTransformerPath: require.resolve('@graphox/babel-plugin'),
},
};
为了完全兼容,请在 babel.config.js。 。 。 .
代码分割影响
| 配置 | 初始块 | 超级懒鬼 |
|---|---|---|
| 没有插件 | ~50KB+(全部 AST) 组合键 | ~ 1KB 键 |
| 带有插件 | ~ 1KB 键 | ~ 1KB 键 |
多个项目
在一个插件条目中记录每个输出目录的构建解析, 所以 跨越项目边界的导入可以重写 :
['@graphox/babel-plugin', {
outputs: [
{ outputDir: path.resolve(__dirname, '__generated__') },
{ outputDir: path.resolve(repoRoot, 'packages/catalog/graphql') },
],
}]
在拥有输出的软件包中,文档是通过相对路径导入的. 跨越包的边界, 导入通过包的公开 相反,因为相对路径会通过它的子路径输出:
// 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 字段.
文件名称和来源可能在产出中重复——决议的范围为: 输入的切入点。 输出目录必须明确且必须 不是窝.
配置选项
| 选项 | 类型 | 需求 | 说明 |
|---|---|---|---|
outputs | object[] | 对* | 每个项目一个条目;见下文 |
emitExtensions | string | 没有 | 生成导入的文件扩展名 : "none" (违约), "ts", (中文(简体) ), "js", (中文(简体) ), "dts" |
每个条目 outputs数字 :
| 选项 | 类型 | 需求 | 说明 |
|---|---|---|---|
outputDir | string | 对 | 包含生成文件的目录 |
manifestPath | string | 没有 | 路径 manifest.json默认为 <outputDir>/manifest.json |
manifestData | object[] | 没有 | 内含显示数据, 而不是 manifestPath |
graphqlImportPaths | string[] | 没有 | 作为 GraphQL 切入点处理的额外导入路径 |
importAlias | string | 没有 | 此输出的公开指定符 。 从包裹里引出 name 财务报告和审定财务报表 exports |
packageRoot | string | 没有 | 拥有此输出的软件包的根 。 推断为最近的目录 package.json |
* 单产出形式——这些字段位于顶层而不是内部
outputs ——仍被接受并行为为一要素 outputs。 。 。 .
喷出量
控制所生成导入路径所附加的文件扩展名。 应该符合 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() 电话.
何时使用
| 构建工具 | 建议插件 |
|---|---|
| 原生反应( Metro) | 宝贝 |
| 网络软件包 | 宝贝 |
| 创建反应应用 | 宝贝 |
| 故事书 | 宝贝 |
| 建设 | 使用 SWC 插件 |
| 涡轮包装/下游js | 使用 SWC 插件 |
另见
许可证
麻省理工学院——见 自由主义。 。 。 .