Repository navigation
docs: improve readmes - #17
Merged
Merged
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
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.
Summary
README.md: package table with npm badges, requirements, usage, development and release process.codegen.ts, every config option with type and default, real example output, and notes/limitations..nvmrc(no workflow usesnode-version-file; the jobs use thepnpm-installaction'snode-versioninput / default).Verification
All snippets were run against a small schema with the locally built packages and
@graphql-codegen/cli7.4.6; the example output in the READMEs is the real output (trimmed where noted). The k6 SDK and example script were type checked, bundled with esbuild and run with k6 against a mock GraphQL server. The typedefs output was loaded withmakeExecutableSchema.Behaviour documented as limitations
documentMode: "graphQLTag"generates aRequestertype that usesDocumentNodewithout importing it, anddocumentMode: "string"references an undefinedTypedDocumentString. The README recommendsdocumentMode: "documentNode"..graphqlfile all end up in each request (and fragments in that file appear twice).clean: trueempties the whole output directory.