GraphQL-Let 使用指南

1. 项目目录结构及介绍

GraphQL-Let 是一个旨在简化 GraphQL 代码生成过程的工具，支持多种集成方式如 Webpack loader、Babel 插件等。其内部结构设计以高效和易用为核心，以下是典型项目中可能遇到的核心目录和文件说明：

• src: 主要源代码存放目录，通常包含你的业务逻辑和GraphQL查询或 mutation 的定义。
• schemas: 存放GraphQL模式(schema)文件的目录，如果适用的话。
• graphql-let.yml: 配置文件，用于指定文档位置、代码生成的插件和配置选项。
• __tests__: 单元测试相关文件夹，用于存放测试用例。
• .gitattributes, .gitignore, package.json: 标准的Git管理和项目配置文件。
• webpack.config.js (如果使用Webpack): Webpack的配置文件，用于设置graphql-let的Webpack加载器。
• babel.config.js (如果使用Babel插件): Babel配置文件，定义了对graphql-let宏的支持。

2. 项目的启动文件介绍

在GraphQL-Let的上下文中，“启动文件”依赖于你是如何集成这个库的。如果你通过WebPack或Babel来使用它，那么“启动文件”可能指的是应用的入口点（例如 index.js 或 app.js）。

• Webpack集成: 无需直接修改启动文件来启用GraphQL-Let，而是通过修改webpack.config.js来配置GraphQL的加载器。

• Babel Plugin/Macros: 使用Babel插件时，更改或添加到.babelrc或babel.config.js中的配置是关键，不需要直接操作启动文件来处理GraphQL代码。

对于Next.js或者Create React App等框架，你可能会通过修改配置或引入特定的Babel宏来启用该功能，而不需要直接触碰应用的主入口文件。

3. 项目的配置文件介绍

graphql-let.yml

这是GraphQL-Let的核心配置文件，决定了哪些GraphQL文件将被处理，以及如何处理它们。示例配置可以包括：

schema: path/to/schema.graphql
documents:
  - "**/*.graphql"
  - "**/*.gql"
plugins:
  - typescript
  - typescript-operations
  - typescript-react-apollo

• schema: 指定你的GraphQL模式文件的位置。
• documents: 定义了GraphQL查询和变异所在文件的查找路径，使用glob模式。
• plugins: 列出你需要执行的代码生成插件，这些插件将根据你的GraphQL文档生成相应的TypeScript类型和函数。

通过调整这些配置，你可以控制生成代码的方式和位置，从而更好地适应项目的具体需求。记住，根据你的具体需求，可能还需要安装对应的npm包作为这些插件的支持。