{"id":20447643,"url":"https://github.com/acrool/acrool-graphql-codegen","last_synced_at":"2025-04-13T01:10:33.771Z","repository":{"id":151799403,"uuid":"624685667","full_name":"acrool/acrool-graphql-codegen","owner":"acrool","description":"graphql code generator","archived":false,"fork":false,"pushed_at":"2024-12-12T11:57:37.000Z","size":398,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-20T14:53:22.718Z","etag":null,"topics":["graphql","graphql-codegen","react-query"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/acrool.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-07T02:47:38.000Z","updated_at":"2024-12-12T11:57:41.000Z","dependencies_parsed_at":"2024-05-19T03:27:47.307Z","dependency_job_id":"374d006d-0ff0-47bf-bd13-79c85422a3db","html_url":"https://github.com/acrool/acrool-graphql-codegen","commit_stats":null,"previous_names":["imagine10255/bear-graphql-codegen"],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acrool%2Facrool-graphql-codegen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acrool%2Facrool-graphql-codegen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acrool%2Facrool-graphql-codegen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acrool%2Facrool-graphql-codegen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/acrool","download_url":"https://codeload.github.com/acrool/acrool-graphql-codegen/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248650750,"owners_count":21139681,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["graphql","graphql-codegen","react-query"],"created_at":"2024-11-15T10:28:05.314Z","updated_at":"2025-04-13T01:10:33.766Z","avatar_url":"https://github.com/acrool.png","language":"TypeScript","funding_links":[],"categories":["API Utils"],"sub_categories":[],"readme":"# Acrool Graphql Codegen Plugins - react-query\n\n\u003cp align=\"center\"\u003e\n    This is a graphql code generator plugins use react hooks\n\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![NPM](https://img.shields.io/npm/v/@acrool/graphql-codegen-react-query.svg?style=for-the-badge)](https://www.npmjs.com/package/@acrool/graphql-codegen-react-query)\n[![npm](https://img.shields.io/bundlejs/size/@acrool/graphql-codegen-react-query?style=for-the-badge)](https://github.com/acrool/@acrool/graphql-codegen-react-query/blob/main/LICENSE)\n[![npm](https://img.shields.io/npm/l/@acrool/graphql-codegen-react-query?style=for-the-badge)](https://github.com/acrool/react-picker/blob/main/LICENSE)\n\n[![npm downloads](https://img.shields.io/npm/dm/@acrool/graphql-codegen-react-query.svg?style=for-the-badge)](https://www.npmjs.com/package/@acrool/graphql-codegen-react-query)\n[![npm](https://img.shields.io/npm/dt/@acrool/graphql-codegen-react-query.svg?style=for-the-badge)](https://www.npmjs.com/package/@acrool/graphql-codegen-react-query)\n\n\u003c/div\u003e\n\n\n## Features\n\n- Graphql code generator plugins\n- Quickly output grpahql .gql to react-query hooks\n- Directly customize using `react-query` methods, such as: `useQuery`, `useMutation`, `useInfiniteQuery`\n- Use `createQueryAndQueryClientHook` to generate `useQuery`, functions related to `useQueryClient`, such as `getQueryKey`, `fetchQuery`, `reFetchQuery`, `setQueryData`, `invalidateQueries`\n\n\n## Install\n\n```bash\nyarn add -D @acrool/graphql-codegen-react-query\n```\n\n## Usage\n\n\nadd package.json script\n\n```json\n{\n  \"scripts\":{\n    \"generate\": \"graphql-codegen --config ./codegen.ts\"\n  }\n}\n```\n\n\n./codegen.ts\n\n```ts\nimport { CodegenConfig } from '@graphql-codegen/cli'\n\nconst config: CodegenConfig = {\n    schema: [\n        './schema.graphql',\n        'scalar Upload'\n    ],\n    documents: [\n        './src/store/fragment.gql',\n        './src/store/{main,custom}/**/{doc,subscription}.gql',\n    ],\n    config: {\n        maybeValue: \"T | undefined\",\n        inputMaybeValue: \"T | null\",\n    },\n    generates: {\n        './src/library/graphql/__generated__.ts': {\n            plugins: [\n                // https://the-guild.dev/graphql/codegen/plugins/typescript/typescript\n                'typescript',\n                // https://the-guild.dev/graphql/codegen/plugins/typescript/typescript-operations\n                'typescript-operations',\n                '@acrool/graphql-codegen-react-query',\n                {\n                    add: {\n                        content: `\nimport {ReadStream} from 'fs-capacitor';\nimport {EDataLevel} from '@acrool/react-gantt';\n\ninterface GraphQLFileUpload {\n  filename: string;\n  mimetype: string;\n  encoding: string;\n  createReadStream(options?:{encoding?: string, highWaterMark?: number}): ReadStream;\n}`\n                    }\n                },\n            ],\n            config: {\n                typesPrefix: 'I',\n                enumPrefix: false,\n                declarationKind: 'interface',\n                withMutationFn: true,\n                strictScalars: false,\n                skipTypename: true,\n                inputValue: true,\n                // avoidOptionals: true,\n                // ignoreEnumValuesFromSchema: false,\n                scalars: {\n                    Upload: 'Promise\u003cGraphQLFileUpload\u003e',\n                    ID: 'string',\n                    IP: 'string',\n                    UUID: 'string',\n                    Role: 'Role',\n                    Time: 'string',\n                    FileData: 'string',\n                    PeriodUnit: 'string',\n                    Duration: 'number',\n                    Locale: 'string',\n                    TransactionID: 'string',\n                    // OrderBy: `'desc'|'asc'`,\n                    OrderBy: 'string',\n                    Timestamp: 'string',\n                },\n                omitOperationSuffix: true,\n                exposeDocument: false,\n                exposeQuerySetData: true,\n                exposeQueryClientHook: true,\n                exposeFetcher: true,\n                fetcher: {\n                    queryFunc: './createQueryHookFactory#createQueryHook',\n                    queryAndQueryClientFunc: './createQueryHookFactory#createQueryAndQueryClientHook',\n                    infiniteQueryFunc: './createQueryHookFactory#createInfiniteQueryHook',\n                    mutationFunc: './createQueryHookFactory#createMutationHook',\n                    isQueryAndQueryClient: true,\n                }\n            }\n        },\n    },\n}\n\nexport default config\n```\n\ncopy ./src/example in your project lib path\n\nadd your gql file\n\nrun script\n\n```bash\nyarn generate\n```\n\n\n\n\n\n## Release\n\n```bash\nyarn build:react-query \u0026\u0026 npm publish ./src/react-query --access=public\nyarn build:qtk-query \u0026\u0026 npm publish ./src/rtk-query --access=public\n```\n\n- [@acrool/graphql-codegen-react-query](https://github.com/acrool/acrool-graphql-codegen/tree/main/src/react-query)\n- [Example](./src/example)\n\n\n## License\n\nMIT © [acrool](https://github.com/acrool)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facrool%2Facrool-graphql-codegen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Facrool%2Facrool-graphql-codegen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facrool%2Facrool-graphql-codegen/lists"}