dotansimha/graphql-code-generator

Automatically exclude schema from documents

Open

#5,409 建立於 2021年1月16日

在 GitHub 查看
 (1 留言) (2 反應) (0 負責人)TypeScript (10,341 star) (1,295 fork)batch import
corehelp wantedkind/enhancement

描述

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.

貢獻者指南

技術棧
typescriptnodejs
領域
toolingdeveloper experience
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
GraphQLTypeScriptglobbing
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
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.