# @gatsbyjs/relay-compiler 中文文档

规范地址：https://npmcn.com/package/%40gatsbyjs/relay-compiler/

版本：2\.0\.0-printer-fix\.4
npm 元数据更新时间：2026-06-30T21:59:43.171Z
中文译文更新时间：2026-11-16T00:06:51.380Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40gatsbyjs/relay-compiler
原文对照：https://npmcn.com/package/%40gatsbyjs/relay-compiler/?lang=original
项目主页：https://facebook.github.io/relay/
源码仓库：https://github.com/facebook/relay

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：2.8 MB，97 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：16 个
- peer 依赖：graphql ^14\.1\.0
- 首次发布：2019-02-14T11:06:27.203Z
- 最新版本发布：2019-08-23T11:27:31.007Z
- 近 30 天下载量：29497（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 0 个）

## 中文简介

一个用于构建GraphQL驱动应用程序的编译工具.

## 安装

```sh
npm install @gatsbyjs/relay-compiler
```

也可以使用：`pnpm add @gatsbyjs/relay-compiler`、`yarn add @gatsbyjs/relay-compiler`、`bun add @gatsbyjs/relay-compiler`

## README

# 中继编译器

中继编译器是GraphQL的代码生成工具包. 它包含了GraphQL代码-gen的核心功能,包括文件解析,验证,语法树解析和变换.

GraphQL 编译软件包 [导出库代码](https://npmcn.com/package/%40gatsbyjs/relay-compiler/GraphQLCompilerPublic.js) 用于查找所需的模块,或以自定义输入和输出来扩展编译器。 注意,GraphQL-编译器的内部API处于常态迭代下,因此滚动自有版本可能导致与未来发行相容.

下图说明了完整的GraphQL代码生成管道的高层次结构:

![CodegenPipeline](https://github.com/facebook/relay/raw/master/packages/relay-compiler/docs/Architecture.png)

要了解核心编译步骤的基本工作流程,即上图"GraphQL编译器"块发生的情况,请参见: [这里](https://npmcn.com/package/%40gatsbyjs/relay-compiler/ARCHITECTURE.md)。 。 。 .

您可以通过添加自己的编译器来构建自己的版本 `FileWriter`,通过互换或添加a `FileParser` 和额外 `IRTransforms` (IR,代表 `Intermediate Representation`,用于可变性的特有用途语法树格式.

-   GraphQL-编译软件包提供了 [`GraphQLFileParser`](https://npmcn.com/package/%40gatsbyjs/relay-compiler/core/GraphQLFileParser.js),用于分析一般 `.graphql` 文档和 a [`GraphQLTextParser`](https://npmcn.com/package/%40gatsbyjs/relay-compiler/core/GraphQLTextParser.js),用于在任意源文件中使用自定义标记解析 GraphQL 文本。 你也可以自己写 `FileParser` 随便你.
    
-   您可以添加额外内容 `IRTransforms` 通过扩展基础 [`GraphQLIRTransforms`](https://npmcn.com/package/%40gatsbyjs/relay-compiler/core/GraphQLIRTransforms.js)。可以找到样本 [这里](https://npmcn.com/package/%40gatsbyjs/core/RelayIRTransforms.js)。 。 。 .
    
-   同样,您可以通过扩展基本 [`GraphQLValidator`](https://npmcn.com/package/%40gatsbyjs/relay-compiler/core/GraphQLValidator.js)。 。 。 . 样本 [这里](https://npmcn.com/package/%40gatsbyjs/core/RelayValidator.js)。 。 。 .
    
-   样本 `FileWriter` 可见 [这里](https://npmcn.com/package/%40gatsbyjs/codegen/RelayFileWriter.js)。 。 。 .
    

要运行您的编译器, 您还需要一个脚本来组装所有上述组件 。 可找到一个样本文件 [这里](https://npmcn.com/package/%40gatsbyjs/bin/RelayCompilerBin.js)。 。 。 .

## 常见问题

### @gatsbyjs/relay-compiler 是什么？

一个用于构建GraphQL驱动应用程序的编译工具\.

### 如何安装 @gatsbyjs/relay-compiler？

在项目目录运行 npm install @gatsbyjs/relay-compiler，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：graphql（^14\.1\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 relay-compiler，可以用 npx relay-compiler 直接运行。

### @gatsbyjs/relay-compiler 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/gatsbyjs\_\_relay-compiler 是否存在。

### @gatsbyjs/relay-compiler 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @gatsbyjs/relay-compiler 可以商用吗？

@gatsbyjs/relay-compiler 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @gatsbyjs/relay-compiler 的下载量有多少？

根据 npm 官方下载统计，@gatsbyjs/relay-compiler 在 2026/10/16 – 2026/11/14 这 30 天内被下载 29,497 次，日均约 983 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @gatsbyjs/relay-compiler 还在维护吗？

最新版本 2\.0\.0-printer-fix\.4 发布于 2019/08/23（7 年前）；至今共发布 5 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/02/14。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

