How argano/graphql-codegen-documents works
graphql-codegen-documents is a GraphQL Code Generator plugin that creates query, mutation, and subscription documents from a schema while excluding operations already present in supplied documents. The principal workflow is: Code Generator supplies schema, documents, and config; the plugin entry point parses and visits the schema and documents; the generator visitor builds output text, which is written as a generated GraphQL document for later Code Generator plugins. The README also documents a separate, preceding plugin run. This map is based on the README and sampled source; external Code Generator internals are not expanded.
Main entry points: index.ts Plugin function · visitor.ts Document generator · operations-visitor.ts Operation visitor
Components 8
Plugin entry
- Plugin function
src/index.ts
AST visitors
- Operation visitor
src/operations-visitor.ts - Document generator
src/visitor.ts
Codegen workflow
- Generated documents
- Later Codegen plugins
Other components
- GraphQL Codegen
- GraphQL schema
- Existing documents
Connections 11
- GraphQL Codegen → Plugin function: invokes plugin
- GraphQL Codegen → GraphQL schema: supplies schema
- GraphQL Codegen → Existing documents: supplies documents
- Plugin function → GraphQL schema: prints schema
- Plugin function → Existing documents: concatenates ASTs
- Plugin function → Operation visitor: visits document AST
- Plugin function → Document generator: visits schema AST
- Plugin function → Operation visitor: gets operation names
- Plugin function → Document generator: requests generation
- Document generator → Generated documents: returns document text
- Later Codegen plugins → Generated documents: reads documents