GraphQL CLI 使用教程

graphql-cli 项目地址: https://gitcode.com/gh_mirrors/gra/graphql-cli

1. 项目介绍

GraphQL CLI 是一个用于常见 GraphQL 开发工作流程的命令行工具。它提供了许多有用的命令，帮助开发者更高效地管理 GraphQL 项目。GraphQL CLI 兼容基于 graphql-config 的编辑器和 IDE，并拥有强大的插件系统，可以扩展其功能。

主要特性

命令行工具: 提供了一系列命令来简化 GraphQL 开发流程。
插件系统: 支持自定义插件，扩展 GraphQL CLI 的功能。
兼容性: 与 graphql-config 兼容，适用于多种编辑器和 IDE。

2. 项目快速启动

安装

你可以使用 yarn 或 npm 全局安装 GraphQL CLI：

# 使用 yarn 安装
yarn global add graphql-cli

# 使用 npm 安装
npm install -g graphql-cli

初始化项目

安装完成后，你可以使用 graphql-cli 初始化一个新的 GraphQL 项目：

npx graphql-cli init

在初始化过程中，系统会提示你输入一些项目信息，并根据你的选择生成一个包含 graphql-config 配置的完整项目。

示例配置

你可以手动创建一个 graphqlrc.yml 文件来配置 GraphQL CLI：

schema: "server/src/schema/**/*.graphql"
documents: "client/src/documents/**/*.graphql"

3. 应用案例和最佳实践

案例1：使用 GraphQL CLI 生成代码

GraphQL CLI 可以与 GraphQL Code Generator 结合使用，自动生成客户端和服务器端的代码。以下是一个简单的示例：

schema: "server/src/schema/**/*.graphql"
documents: "client/src/documents/**/*.graphql"
extensions:
  codegen:
    generates:
      server/src/generated-types.d.ts:
        plugins:
          - typescript
          - typescript-resolvers
      client/src/generated-types.tsx:
        plugins:
          - typescript
          - typescript-operations
          - typescript-react-apollo
        config:
          withHooks: true

案例2：使用 GraphQL CLI 管理插件

GraphQL CLI 支持通过插件扩展功能。你可以安装和管理插件，例如 graphql-cli-codegen：

yarn add @graphql-cli/codegen

然后在 graphqlrc.yml 中配置插件：

extensions:
  codegen:
    generates:
      server/src/generated-types.d.ts:
        plugins:
          - typescript
          - typescript-resolvers

4. 典型生态项目

GraphQL Code Generator

GraphQL Code Generator 是一个强大的工具，可以根据你的 GraphQL 模式和文档生成代码。它支持多种插件和模板，适用于前后端开发。

GraphQL Inspector

GraphQL Inspector 是一个用于检查和比较 GraphQL 模式的工具。它可以帮助你发现模式中的变化，并确保这些变化不会破坏现有的客户端。

Graphback

Graphback 是一个用于生成 GraphQL 后端代码的工具。它可以根据你的 GraphQL 模式自动生成 CRUD 操作和数据库模型。

通过这些生态项目，GraphQL CLI 可以与多种工具集成，提供更全面的开发体验。

graphql-cli 项目地址: https://gitcode.com/gh_mirrors/gra/graphql-cli