dotansimha/graphql-code-generator

Automatically exclude schema from documents

Open

#5409 aperta il 16 gen 2021

Vedi su GitHub
 (1 commento) (2 reazioni) (0 assegnatari)TypeScript (1295 fork)batch import
corehelp wantedkind/enhancement

Metriche repository

Star
 (10.341 star)
Metriche merge PR
 (Merge medio 22g 9h) (53 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Indaga su come il parsing della configurazione del codegen gestisce i glob dei documenti. Cerca dove schema e documenti vengono separati e aggiungi la logica per escludere automaticamente il percorso dello schema dal glob dei documenti. Controlla i file 'config.ts' o 'load.ts' nella directory 'packages/graphql codegen cli'. Considera l'uso di una libreria come 'globby' per escludere il file dello schema dal pattern glob dei documenti.
Tech stack
typescriptgraphql
Dominio
tooling
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75