feat(visitor-plugin-common): support object form for the codegenScalarType extension#10893
Open
ifeanyi-ugwu wants to merge 1 commit into
Open
Conversation
…rType extension
Read the `codegenScalarType` scalar extension through the existing
`normalizeScalarType` helper, so it accepts either a string (mapped to both the
input and output slots, unchanged) or `{ input, output }` to map the two
positions independently — matching what the `scalars` config option already
supports. This lets a schema-first scalar declare a stricter parsed/input type
than its accepted resolver-return/output type, instead of collapsing both into
one.
🦋 Changeset detectedLatest commit: ac97787 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
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.
Description
The
codegenScalarTypescalar extension is read as a single string and copied into both theinputandoutputslots of the generatedScalarsmap:So a schema-first scalar (one that ships
codegenScalarTypein its type extensions) can't declare a stricter parsed/input type than its wider resolver-return/output type — the two positions the generatedScalarsmap already distinguishes.The
scalarsconfig option already supports this, via thenormalizeScalarTypehelper that acceptsstring | { input, output }. This PR routes the extension through that same helper, giving the extension parity:codegenScalarType: 'Foo'→{ input: Foo; output: Foo }— unchangedcodegenScalarType: { input: 'A', output: 'B' }→{ input: A; output: B }Motivation
Scalar libraries such as
graphql-scalarsship onecodegenScalarTypestring per scalar, which can only ever describe one of the two positions. This closes that gap for every schema-first scalar — e.g.DateTimecan declare{ input: 'Date', output: 'Date | string | number' }(parsed value is aDate; a resolver may return aDate, an ISO string, or a timestamp).Notes
codegenScalarTypeextension previously had no test coverage; two tests are added (string form + object form).@graphql-codegen/visitor-plugin-common, minor).