v3

[cometkim]

https://github.com/cometkim/gatsby-plugin-typegen/milestone/3

Todos

• Predictable & Debuggable scheduler (Thanks to XState)
• Remove graphql-tools dependency and integrate more inside Gatsby
• Integration with stable lifecycle API (SET_SCHEMA and SET_GRAPHQL_DEFINITIONS)
• Clean implementation & Tests
  • codegen
  • emitSchema
  • emitPluginDocument
  • autofix
• E2E Test on example project
  • Add TypeScript example
  • Add Flow example

Issues

• Resolves Ignore unnamed queries #40
• Resolves Ignore dev-only field (host, port) #103
• Resolves Stabilize output #104
• Intermittent errors with Gatsby Cloud builds  #109
• Fixes emitPluginDocuments broken after Gatsby upgrade #113
• Fixes Don't print errors in MDX files #117
• Fixes Error: Cannot use GraphQLSchema "[object GraphQLSchema]" from another module or realm. #120
• Resolves Migrate the plugin options validation to be schema-based #122
• Fixes Static query type is not generated after reboot #124
• Resolves Remove dev-only query documents from plugin-documents.graphql #131
• Fixes tagName option seems to be ignored #139, gatsby-source-graphql & Apollo client #99
• Resolves Scalar JSON always undefined due to default config of JSON set to type never #146
• Fixes AggregateError: GraphQLDocumentError: Unknown type "__FRAGMENT_TYPE_NAME__". #157
• Fixes gatsby-types.d.ts is not generated #159
• Fixes codegen fails with parallel sourcing #160
• Fixes Plugin option types not accurate/outdated (?) or bug regarding emitSchema  #161
• Fixes Query type generation fails sometimes #162
• Resolves Gatsby v4 #168
• Resolves Update @graphql-tools deps #169
• Fixes Lots of unmet peer dependencies? #171

[lgtm-com]

This pull request introduces 1 alert when merging e8c0f4f into 2bcbfc7 - view on LGTM.com

new alerts:

• 1 for Unused variable, import, function or class

[lgtm-com]

This pull request introduces 3 alerts when merging c8aad18 into 7ee59cd - view on LGTM.com

new alerts:

• 3 for Unused variable, import, function or class

[lgtm-com]

This pull request introduces 3 alerts when merging bbde5d7 into 223d73b - view on LGTM.com

new alerts:

• 3 for Unused variable, import, function or class

[lgtm-com]

This pull request introduces 3 alerts when merging 3e08ca9 into 223d73b - view on LGTM.com

new alerts:

• 3 for Unused variable, import, function or class

[cometkim]

I took a long break from working on this project.

I still have a lot of ideas and things to improve, but I'm losing focus. (even though I'm still actively using this plugin for my gatsby projects)

Maybe we need to get another maintainer after this work. please contact me if anyone has an interest.

[cometkim]

@LekoArts VSCode extension's feature should work with valid graphql-config, or if invalid, it must be reported by it.

The emitPluginDocument option exists to extract the pre-defined fragments by the plugin or gatsby core and should not have any effect on the project if not used.

It would be a good idea to keep valid settings together in examples.

[cometkim]

The plugin intentionally creates types only for named queries.

It requires using a globally unique query name for maintaining the correct colocation pattern and is also a limitation of both Gatsby and GraphQL Codegen.

When it is not given, Gatsby uses the pathname to make it internally, but this is inappropriate as a type name and can be easily broken by moving files.

[cometkim]

This PR seems to remove a lot of files in plugin/.yarn/cache, can you also do this in master and rebase then? The GitHub UI is really laggy with this amount of files laughing

@LekoArts I've tried it, but it seems that GitHub has already given up tracking changes here 😅

The code has been rewritten almost from scratch, so it will be better to walk around the code directly in the branch than to read the changes.

[cometkim]

I've checked that this works well in production and doesn't cause any issues on Gatsby Cloud (Fixes #109)

However, it seems that some documents included within the theme are not generated properly.

And flattenGeneratedTypes option makes generated types a bit bloated

[kvchen]

Is it possible to add the flattenGeneratedTypesIncludeFragments: true option in addition to flattenGeneratedTypes? In v2, the exported types included named fragments - that seems to have gone away in v3. This makes it difficult to use typed GraphQL fragments in subcomponents.

I'd file a new pull request, but the change is so small that it might be easier to just add it to this pull request.

[lgtm-com]

This pull request introduces 2 alerts when merging 42650bd into 5f78b2a - view on LGTM.com

new alerts:

• 2 for Variable not declared before use

[cometkim]

Merged to main