Descriptions on executable documents #4430
Open
+231
−33
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
Enhance GraphQL parser and printer to support descriptions for operations, variables, and fragments This commit is based on graphql#3402 , rebased onto graphql-js 16 and with added tests Implements graphql/graphql-spec#1170
benjie
reviewed
Jun 19, 2025
src/language/parser.ts
Outdated
Comment on lines
291
to
302
| if (hasDescription) { | ||
| throw syntaxError( | ||
| this._lexer.source, | ||
| this._lexer.token.start, | ||
| 'Unexpected description, descriptions are supported only on type definitions.', | ||
| ); | ||
| } | ||
|
|
||
| switch (keywordToken.value) { | ||
| case 'query': | ||
| case 'mutation': | ||
| case 'subscription': | ||
| return this.parseOperationDefinition(); | ||
| case 'fragment': | ||
| return this.parseFragmentDefinition(); | ||
| case 'extend': | ||
| if (hasDescription) { | ||
| throw syntaxError( | ||
| this._lexer.source, | ||
| this._lexer.token.start, | ||
| 'Unexpected description, descriptions are not supported on type extensions.', | ||
| ); | ||
| } |
There was a problem hiding this comment.
Currently this changes the behavior of the this.unexpected() fallback lower down. I think we should restore the previous format - two switch statements with a "no descriptions" assertion between them.
There was a problem hiding this comment.
I took a stab at addressing this feedback slightly differently to better preserve existing behavior, please see
benjie
requested changes
Jun 19, 2025
yaacovCR
force-pushed
the
executableDescriptions2025
branch
from
c70433e to
c573130
Compare
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Enhance GraphQL parser and printer to support descriptions for operations, variables, and fragments
This commit is based on #3402 , rebased onto graphql-js 16 and with added tests
Implements graphql/graphql-spec#1170