Add support for optional Description for those objects which allow it #66
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
Doesn’t support multi-line descriptions because string parser currently doesn’t support multi-line strings. Tests for all additions. Two strategies used for two different kind of places for descriptions: 1) for items in lists (EnumValueDefinition, FieldDefinition, InputValueDefinition) uses new parseDescription(…) to get the optional description if present. 2) for object definitions where a bunch at the same level have optional descriptions followed by a distinguishing token (SchemaDefinition, ScalarTypeDefintion, ObjectTypeDefinition, InterfaceTypeDefinition, UnionTypeDefinition, EnumTypeDefinition, InputObjectTypeDefinition, DirectiveDefinition) we have to advance the lexer to the distinguishing token so we replace the .string Token in lastToken with a copy with only the token kind set to new Token kind, .description. Then each of the specific parsers for those Definitions checks .lastToken to see if it’s a kind is .description and if so, uses that for it’s optional description field. This was the approach that modified the existing code the least and seemed to keep in the spirit of the current implementation.
…are merged in. prefixed with “fails_” currently so will not be run.
Member
|
Thank you @haikusw. If you need more inspiration for tests you can check the tests in the canonical implementation: https://github.com/graphql/graphql-js/tree/master/src/language/__tests__ |
uses blockstrings2 re-do and matches closer to canonical js approach. cleaned up test names. update tests.
Contributor
Author
|
This is now ready for review and merging if deemed ok. Thanks. |
paulofaria
approved these changes
Aug 27, 2020
Member
|
Great work @haikusw! Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This addresses #63 "GraphQL parser does not support optional
Descriptions"This adds description support via
parseTypeSystemDefinition:SchemaDefinitionScalarTypeDefintionObjectTypeDefinitionInterfaceTypeDefinitionUnionTypeDefinitionEnumTypeDefinitionInputObjectTypeDefinitionDirectiveDefinitionothers:
EnumValueDefinitionFieldDefinitionInputValueDefinitionThis also supports multi-line Descriptions now that the Blockstring PRs #65 and #68 have been merged in, and this includes several tests for those.
All my work has been done on macOS 10.15.6 using Xcode 12b5.
Fixes #63