dotansimha/graphql-code-generator

Automatically exclude schema from documents

Open

#5.409 aberto em 16 de jan. de 2021

Ver no GitHub
 (1 comment) (2 reactions) (0 assignees)TypeScript (1.295 forks)batch import
corehelp wantedkind/enhancement

Métricas do repositório

Stars
 (10.341 stars)
Métricas de merge de PR
 (Mesclagem média 22d 9h) (53 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Investigue como a análise da configuração do codegen lida com os globs de documentos. Procure onde o schema e os documentos são separados e adicione lógica para excluir automaticamente o caminho do schema do glob de documentos. Verifique os arquivos 'config.ts' ou 'load.ts' no diretório 'packages/graphql codegen cli'. Considere usar uma biblioteca como 'globby' para excluir o arquivo de schema do padrão glob de documentos.
Pilha de tecnologia
typescriptgraphql
Domain
tooling
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75