# @anatine/graphql-codegen-zod 中文文档

规范地址：https://npmcn.com/package/%40anatine/graphql-codegen-zod/

版本：0\.4\.1
npm 元数据更新时间：2024-03-19T21:46:32.522Z
中文译文更新时间：2026-11-06T06:44:50.254Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40anatine/graphql-codegen-zod
原文对照：https://npmcn.com/package/%40anatine/graphql-codegen-zod/?lang=original
项目主页：https://github.com/anatine/zod-plugins/tree/main/packages/graphql-codegen-zod
源码仓库：https://github.com/anatine/zod-plugins

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

- 包体积（解压后）：41.9 kB，52 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@graphql-tools/utils ^8\.8\.0，graphql-code-generator ^0\.18\.2，zod ^3\.17\.3
- 首次发布：2022-06-26T19:12:45.587Z
- 最新版本发布：2024-03-19T21:46:32.093Z
- 近 30 天下载量：4375（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 0 个）

## 中文简介

它是一个从 Graphql Schema 到 Zod Schema 的图书馆

## 安装

```sh
npm install @anatine/graphql-codegen-zod
```

也可以使用：`pnpm add @anatine/graphql-codegen-zod`、`yarn add @anatine/graphql-codegen-zod`、`bun add @anatine/graphql-codegen-zod`

## README

# GraphQL 代码计划到 Zod 计划

这个项目的原因是维持一个单一的真理来源,介于图克勒和佐德之间. 这对表格的验证很有用。 灵感来自 [代码- ql- yup](https://github.com/tinezmatias/codegen-graphql-yup)

## 配置

-   仅使用 Validation: boolean( 默认虚假) 如果您想要为您所有输入对象定义生成一个包含或不包含指令的图案, 请将它写入真实中 .
-   zodSchemasMap: 将您所显示的平面图到一个zod类型. 这对像电子邮件地址簿这样的平面画很有用 `z.string().email()`

### 简单使用

如果您只想要验证所需的字段, 您可以用以下方式使用插件

```yaml
generates:
  schemas.ts:
    plugins:
      - @anatine/graphql-codegen-zod
```

### 充分利用

如果需要比仅仅需要的字段更多的验证,则必须遵循这个步骤.

这是因为在图克l 透视中,我们没有获得指令

-   在您的计划中添加指令 .
-   在 Codegen.yml 配置中,使用文件像 schema.

### 指令Schema

```graphql
directive @validation(
  pattern: String
  min: Int
  max: Int
  requiredMessage: String
  typeOf: String
) on INPUT_FIELD_DEFINITION | ARGUMENT_DEFINITION
```

## 示例

结果. graphql

```graphql
directive @validation(
  pattern: String
  min: Int
  max: Int
  requiredMessage: String
  typeOf: String
) on INPUT_FIELD_DEFINITION | ARGUMENT_DEFINITION
enum TestEnum {
  ENUM1
  ENUM2
}
type TestSampleType {
  id: ID!
  name: String!
  email: String
}
input TestInput {
  string: String
  stringRequired: String!
  enum: TestEnum
  enumRequired: TestEnum!
  scalar: EmailAddress
  scalarRequired: EmailAddress!
  enumArray: [TestEnum]
  enumArrayRequired: [TestEnum]!
  emailArray: [EmailAddress]
  emailArrayRequired: [EmailAddress]!
  emailRequiredArray: [EmailAddress!]
  emailRequiredArrayRequired: [EmailAddress!]!
  stringArray: [String]
  stringArrayRequired: [String]!
  stringRequiredArray: [String!]
  stringRequiredArrayRequired: [String!]!
}
input RegisterAddressInput {
  postalCode: TestInput!
  state: [String]!
  city: String!
  someNumber: Int @validation(min: 10, max: 20)
  someNumberFloat: Float @validation(min: 10.50, max: 20.50)
  someBoolean: Boolean
  ipAddress: IPAddress
  line2: String @validation(min: 10, max: 20)
}
scalar EmailAddress
scalar IPAddress
```

代码( yml)

```yaml
schema: './apps/codegen-e2e/src/*.graphql'
generates:
  './apps/codegen-e2e/generated/output.ts':
    plugins:
      - @anatine/graphql-codegen-zod
    config:
      allowEnumStringTypes: true
      onlyWithValidation: false
      lazy: true
      zodSchemasMap:
        EmailAddress: z.string().email()
        IPAddress: z.string()
        DateTime: z.string()
        JSON: z.object()
        Date: z.string()
      zodTypesMap:
        EmailAddress: string
```

## 常见问题

### @anatine/graphql-codegen-zod 是什么？

它是一个从 Graphql Schema 到 Zod Schema 的图书馆

### 如何安装 @anatine/graphql-codegen-zod？

在项目目录运行 npm install @anatine/graphql-codegen-zod，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@graphql-tools/utils（^8\.8\.0）、graphql-code-generator（^0\.18\.2）、zod（^3\.17\.3）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @anatine/graphql-codegen-zod 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @anatine/graphql-codegen-zod 支持 ESM 还是 CommonJS？

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

### @anatine/graphql-codegen-zod 可以商用吗？

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

### @anatine/graphql-codegen-zod 的下载量有多少？

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

### @anatine/graphql-codegen-zod 还在维护吗？

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