Update scalar input/output related CHANGELOG with new recommended codegen config #9491
Conversation
|
💻 Website PreviewThe latest changes are available as preview in: https://e0a5144f.graphql-code-generator.pages.dev |
diff --git a/website/algolia-lockfile.json b/website/algolia-lockfile.json
index 82e796d51..6afd04f3d 100644
--- a/website/algolia-lockfile.json
+++ b/website/algolia-lockfile.json
@@ -2826,7 +2826,7 @@
"anchor": "defined-shared-mappers-across-configurations"
}
],
- "content": "d9a253f60bca2d44b316f83a56e966f2",
+ "content": "86a1c5885c53c11576b7b27ca37fb58a",
"url": "https://www.the-guild.dev/graphql/codegen/plugins/typescript/typescript-resolvers",
"domain": "https://www.the-guild.dev/graphql/codegen",
"hierarchy": [ |
| config: { | ||
| scalars: { | ||
| // This option is required to match how GraphQL servers handle ID scalar | ||
| ID: { | ||
| input: 'string', | ||
| output: 'string | number' | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
I've added this section with the new config.
There was a problem hiding this comment.
When this page is rendered, the PluginApiDocs is at the top. Readers have to scroll quite far down to see the usage example.
I wonder if we should switch it, so the Usage example is first, then PluginApiDocs is at the bottom?
| <br/> | ||
| If you are willing to provide your own fetcher, you can directly jump to the ["Appendix I: React Query with a custom fetcher setup"](#appendix-i-react-query-with-a-custom-fetcher-setup) and continue the guide once React Query is properly setup. |
There was a problem hiding this comment.
Not sure why prettier didn't catch this in the previous PRs 🤔
Running yarn prettier fixes this though.
eddeee888
force-pushed
the
update-changelog-to-clarify-scalars
branch
from
76a5839 to
458e63b
Compare
There was a problem hiding this comment.
I've also update the GraphQL server guides with recommended scalars config
|
This is no longer needed because we have reverted the default ID input/output to |
Description
CHANGELOGs with references to scalar input/output changes do not have clear instruction on how to migrate for
typescript-resolversusers.This PR adds recommended codegen config to CHANGELOGs and
typescript-resolversdocumentationI'll also update the release to keep things in sync.
Type of change