dotansimha/graphql-code-generator

Pass the client in the codgen.yml, when using graphql-request with react-query

Open

#5,156 创建于 2020年12月1日

在 GitHub 查看
 (1 评论) (2 反应) (0 负责人)TypeScript (10,341 star) (1,295 fork)batch import
help wantedkind/enhancementplugins

描述

Is your feature request related to a problem? Please describe.

When using react-query plugin with graphql-request, it requires you to always pass the client in the generated query like in the provided example:

import { useMyQuery } from './generated';
import { client } from './my-graphql-request-client';

export const MyComponent = () => {
  const { status, data, error, isFetching } = useMyQuery(client, {});
};

Describe the solution you'd like It would be cool to pass the client in the codegen.yml, like for the example you do with the fetch option:

plugins:
  - add:
     content: "import { endpointUrl, fetchParams } from './my-config';"
  - typescript
  - typescript-operations
  - typescript-react-query
config:
  fetcher:
    endpoint: 'endpointUrl'
    fetchParams: 'fetchParams'

贡献者指南

技术栈
typescriptreact
领域
frontend
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
graphql code generatorreact querygraphql request
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
Start by examining the existing fetcher configuration in the react query plugin (likely in packages/plugins/typescript/react query/src/config.ts). Understand how the endpoint and fetchParams options are passed from codegen.yml to the generated hooks. Then, design a similar 'client' option that allows users to specify a client instance. Modify the plugin to accept this option and pass it to the generated useQuery/useMutation hooks. Finally, update the documentation and add tests to cover the new feature.