dotansimha/graphql-code-generator

Automatically exclude schema from documents

Open

#5409 opened on Jan 16, 2021

View on GitHub
 (1 comment) (2 reactions) (0 assignees)TypeScript (10,341 stars) (1,295 forks)batch import
corehelp wantedkind/enhancement

Description

Describe the bug

My codegen configuration looks like this:

schema: ./src/graphql/schema/schema.graphql
documents: "**/*.graphql"

Running graphql-codegen causes the following error:

      Unable to find any GraphQL type definitions for the following pointers:
        
          - src/graphql/schema/schema.graphql

After quite a bit of playing around I realised why this is happening: graphql-codegen is trying to read either a query or mutation from src/graphql/schema/schema.graphql! 🤦

I have fixed this by changing my config to the following:

schema: ./src/graphql/schema/schema.graphql
documents:
  - "**/*.graphql"
  - "!src/graphql/schema/schema.graphql"

However, it seems really backwards that graphql-codegen would even attempt to parse the schema. It knows it's a schema! Let's just not parse it?!

Expected behavior

Don't fail if the documents glob includes the schema file.

Contributor guide

Tech stack
typescriptnodejs
Domain
toolingdeveloper experience
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
GraphQLTypeScriptglobbing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate how the codegen configuration parsing handles documents globs. Look for where schema and documents are separated, and add logic to automatically exclude the schema path from the documents glob. Check the 'config.ts' or 'load.ts' files in the 'packages/graphql codegen cli' directory. Consider using a library like 'globby' to exclude the schema file from the documents glob pattern.