dotansimha/graphql-code-generator

Automatically exclude schema from documents

Open

#5 409 ouverte le 16 janv. 2021

Voir sur GitHub
 (1 commentaire) (2 réactions) (0 assignés)TypeScript (1 295 forks)batch import
corehelp wantedkind/enhancement

Métriques du dépôt

Stars
 (10 341 stars)
Métriques de merge PR
 (Merge moyen 22j 9h) (53 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Étudiez comment l'analyse de la configuration du codegen gère les globs de documents. Cherchez où le schéma et les documents sont séparés, et ajoutez une logique pour exclure automatiquement le chemin du schéma du glob de documents. Vérifiez les fichiers 'config.ts' ou 'load.ts' dans le répertoire 'packages/graphql codegen cli'. Envisagez d'utiliser une bibliothèque comme 'globby' pour exclure le fichier de schéma du motif glob des documents.
Stack technique
typescriptgraphql
Domaine
tooling
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75