• Plugins
  • other
  • schema-ast
Package nameWeekly DownloadsVersionLicenseUpdated
@graphql-codegen/schema-astDownloadsVersionLicenseAug 8th, 2022

Installation

yarn add -D @graphql-codegen/schema-ast

Examples

# …
schema:
  - 'http://localhost:3000/graphql'
  - './src/**/*.graphql'
  - 'scalar MyCustomScalar'
generates:
  path/to/file.graphql:
    plugins:
      - schema-ast

This plugin prints the merged schema as string. If multiple schemas are provided, they will be merged and printed as one schema.

Config API Reference

includeDirectives

type: boolean default: false

Include directives to Schema output.

Usage Examples

schema:
  - './src/schema.graphql'
generates:
  path/to/file.graphql:
    plugins:
      - schema-ast
    config:
      includeDirectives: true
includeIntrospectionTypes

type: boolean default: false

Include introspection types to Schema output.

Usage Examples

schema:
  - './src/schema.graphql'
generates:
  path/to/file.graphql:
    plugins:
      - schema-ast
    config:
      includeIntrospectionTypes: true
commentDescriptions

type: boolean default: false

Set to true in order to print description as comments (using # instead of """)

Usage Examples

schema: http://localhost:3000/graphql
generates:
  schema.graphql:
    plugins:
      - schema-ast
    config:
      commentDescriptions: true
sort

type: boolean default: true

Set to false to disable sorting

federation

type: boolean

Last updated on August 10, 2022
reason-clienttime