Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
This updates the README examples to use
codegen.ts, which is what GraphQL Code Generator documents first now. The examples keep validation plugin options on the plugin entry, while shared Codegen options stay on the output config.YAML is still supported. I moved the old-style YAML examples into
docs/yaml-configuration.mdand linked it from the README so existing projects are not left guessing.Notes
The quick start uses
zodv4as the concrete example. The docs now call out that users should install the validator they actually use and changeschematoyup,zod,myzod, orvalibotas needed.Validation
git diff --checkgraphql-codegen --config codegen.tsagainst a temporary schema using the README quick-start shapenpm pack --dry-runto confirmdocs/yaml-configuration.mdis included in the package