GraphQL代码生成器：typescript-mock-data插件指南

GraphQL代码生成器：typescript-mock-data插件指南

graphql-codegen-typescript-mock-data [GraphQL Codegen Plugin](https://github.com/dotansimha/graphql-code-generator) for building mock data based on the schema. 项目地址: https://gitcode.com/gh_mirrors/gr/graphql-codegen-typescript-mock-data

---

概览

本指南将引导您了解如何使用graphql-codegen-typescript-mock-data，这是一个基于GraphQL模式生成模拟数据的神器。适合于快速搭建测试环境或原型设计阶段。

1. 目录结构及介绍

假设您已经克隆了仓库到本地，以下是典型的项目目录结构：

├── src                      # 源码目录，存放插件的核心逻辑。
│   └── ...                 # 包含各种处理和生成逻辑的.ts文件。
├── test                     # 测试目录，用于验证插件功能的测试文件。
│   └── ...                 # 含有单元测试或集成测试文件。
├── .gitignore               # Git忽略文件配置。
├── README.md                # 项目说明文档。
├── package.json             # 包含项目元数据和依赖管理的文件。
├── package-lock.json        # 自动生成，记录精确的依赖版本信息。
└── ...                       # 可能还有其他配置文件如tsconfig.json等。

2. 项目的启动文件介绍

对于这个特定的插件，没有一个传统的“启动文件”来运行整个项目作为服务。它作为一个NPM包被安装并集成到您的GraphQL代码生成流程中。主要的执行入口通常是在你的项目的.graphql.config.js或者在使用graphql-codegen命令时指定的配置文件里通过指令调用的。

在您的项目中，启动过程涉及添加此插件到GraphQL Code Generator的配置中，并执行代码生成命令，例如：

npx graphql-codegen

这里的启动更多指的是在目标项目中的集成和执行过程，而非该插件本身的启动。

3. 项目的配置文件介绍

配置文件通常不在graphql-codegen-typescript-mock-data本身，而是您项目中的.graphqlconfig.yml, .graphqlconfig.json, 或者 .graphqlconfig.js 文件（取决于您的偏好）。在这个配置文件中，您需要添加该插件以及其相应的选项，示例配置可能如下所示：

# 示例.graphqlconfig.yml
projects:
  myProject:
    schemaPath: src/schema.graphql
    extensions:
      codegen:
        generates:
          ./src/mocks.ts:
            plugin: typescript-mock-data
            config:
              typesFile: './generated/types.ts'
              useTypeImports: true
              # 更多自定义配置项...

在配置中，您可以指定哪些字段应该怎样mock，是否添加__typename，enum类型如何转换等高级设置。

总结来说，graphql-codegen-typescript-mock-data不是一个独立运行的应用，而是一个集成工具，通过配置您的项目来生成模拟数据，简化开发流程。确保阅读官方文档和示例配置以充分利用所有功能。

graphql-codegen-typescript-mock-data [GraphQL Codegen Plugin](https://github.com/dotansimha/graphql-code-generator) for building mock data based on the schema. 项目地址: https://gitcode.com/gh_mirrors/gr/graphql-codegen-typescript-mock-data