https://github.com/niieani/codegen-typescript-graphql-module-declarations-plugin
A codegen plugin - similar to the TypeScript GraphQL Files Modules Plugin, but uses typed nodes.
https://github.com/niieani/codegen-typescript-graphql-module-declarations-plugin
Last synced: 8 months ago
JSON representation
A codegen plugin - similar to the TypeScript GraphQL Files Modules Plugin, but uses typed nodes.
- Host: GitHub
- URL: https://github.com/niieani/codegen-typescript-graphql-module-declarations-plugin
- Owner: niieani
- License: mit
- Created: 2021-02-25T07:58:24.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-03T01:59:08.000Z (9 months ago)
- Last Synced: 2025-02-08T01:42:01.904Z (8 months ago)
- Language: TypeScript
- Size: 3.52 MB
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# codegen-typescript-graphql-module-declarations-plugin
This [graphql-code-generator](https://graphql-code-generator.com/) plugin is based on the [TypeScript GraphQL Files Modules](https://graphql-code-generator.com/docs/plugins/typescript-graphql-files-modules), but generates typed document nodes, using the types generated earlier by [TypedDocumentNode](https://graphql-code-generator.com/docs/plugins/typed-document-node) plugin.
You need to run graphql-code-generator with the TypedDocumentNode plugin first and set `typedDocumentNodeModule` option to the module path of the generated file.
For configuration options see [index.ts](./src/index.ts).
This plugin generates TypeScript typings for `.graphql` files containing GraphQL documents, which later on can be consumed using [`graphql-tag/loader`](https://github.com/apollographql/graphql-tag#webpack-preprocessing-with-graphql-tagloader) or use `string` types if you will use the operations as raw strings, and get type-check and type-safety for your imports. This means that any time you import objects from `.graphql` files, your IDE will provide auto-complete.
This plugin also handles `.graphql` files containing multiple GraphQL documents, and name the imports according to the operation name.
> ⚠ Fragments are not generated with named imports, only as default imports, due to `graphql-tag/loader` behavior.