Incorporated concepts from PR 70

Shane32 · Shane32 · commit 68344cb66f1f · 2021-07-06T11:24:41.000-04:00
diff --git a/src/GraphQLParser.ApiTests/GraphQL-Parser.approved.txt b/src/GraphQLParser.ApiTests/GraphQL-Parser.approved.txt
@@ -47,6 +47,7 @@ namespace GraphQLParser.AST
         TypeExtensionDefinition = 35,
         DirectiveDefinition = 36,
         Comment = 37,
+        Description = 38,
     }
     public class GraphQLArgument : GraphQLParser.AST.ASTNode, GraphQLParser.AST.INamedNode
     {
@@ -62,6 +63,12 @@ namespace GraphQLParser.AST
         public GraphQLParser.ROM Text { get; set; }
         public override GraphQLParser.AST.GraphQLLocation Location { get; set; }
     }
+    public class GraphQLDescription : GraphQLParser.AST.ASTNode
+    {
+        public GraphQLDescription() { }
+        public override GraphQLParser.AST.ASTNodeKind Kind { get; }
+        public GraphQLParser.ROM Value { get; set; }
+    }
     public class GraphQLDirective : GraphQLParser.AST.ASTNode, GraphQLParser.AST.INamedNode
     {
         public GraphQLDirective() { }
@@ -280,10 +287,10 @@ namespace GraphQLParser.AST
         protected GraphQLTypeDefinition() { }
         public GraphQLParser.AST.GraphQLName? Name { get; set; }
     }
-    public abstract class GraphQLTypeDefinitionWithDescription : GraphQLParser.AST.GraphQLTypeDefinition
+    public abstract class GraphQLTypeDefinitionWithDescription : GraphQLParser.AST.GraphQLTypeDefinition, GraphQLParser.AST.IHasDescription
     {
         protected GraphQLTypeDefinitionWithDescription() { }
-        public GraphQLParser.AST.GraphQLScalarValue? Description { get; set; }
+        public GraphQLParser.AST.GraphQLDescription? Description { get; set; }
     }
     public class GraphQLTypeExtensionDefinition : GraphQLParser.AST.GraphQLTypeDefinition
     {
@@ -316,6 +323,10 @@ namespace GraphQLParser.AST
         public GraphQLParser.AST.GraphQLType? Type { get; set; }
         public GraphQLParser.AST.GraphQLVariable? Variable { get; set; }
     }
+    public interface IHasDescription
+    {
+        GraphQLParser.AST.GraphQLDescription? Description { get; set; }
+    }
     public interface IHasDirectivesNode
     {
         System.Collections.Generic.List<GraphQLParser.AST.GraphQLDirective>? Directives { get; set; }
diff --git a/src/GraphQLParser/AST/ASTNodeKind.cs b/src/GraphQLParser/AST/ASTNodeKind.cs
@@ -89,5 +89,10 @@ public enum ASTNodeKind
         /// and have no significance to the semantic meaning of a GraphQL Document.
         /// </summary>
         Comment,
+
+        /// <summary>
+        /// Description of a type definition.
+        /// </summary>
+        Description,
     }
 }
diff --git a/src/GraphQLParser/AST/GraphQLDescription.cs b/src/GraphQLParser/AST/GraphQLDescription.cs
@@ -0,0 +1,9 @@
+namespace GraphQLParser.AST
+{
+    public class GraphQLDescription : ASTNode
+    {
+        public override ASTNodeKind Kind => ASTNodeKind.Description;
+
+        public ROM Value { get; set; }
+    }
+}
diff --git a/src/GraphQLParser/AST/GraphQLTypeDefinition.cs b/src/GraphQLParser/AST/GraphQLTypeDefinition.cs
@@ -6,11 +6,11 @@ public abstract class GraphQLTypeDefinition : ASTNode, INamedNode
         public GraphQLName? Name { get; set; }
     }
 
-    public abstract class GraphQLTypeDefinitionWithDescription : GraphQLTypeDefinition
+    public abstract class GraphQLTypeDefinitionWithDescription : GraphQLTypeDefinition, IHasDescription
     {
         /// <summary>
-        /// Description of the node as represented by a nested node.
+        /// Description of the node
         /// </summary>
-        public GraphQLScalarValue? Description { get; set; }
+        public GraphQLDescription? Description { get; set; }
     }
 }
diff --git a/src/GraphQLParser/AST/IHasDescription.cs b/src/GraphQLParser/AST/IHasDescription.cs
@@ -0,0 +1,7 @@
+namespace GraphQLParser.AST
+{
+    public interface IHasDescription
+    {
+        GraphQLDescription? Description { get; set; }
+    }
+}
diff --git a/src/GraphQLParser/ParserContext.Parse.cs b/src/GraphQLParser/ParserContext.Parse.cs
@@ -233,10 +233,10 @@ private GraphQLDirective ParseDirective()
         private GraphQLDirectiveDefinition ParseDirectiveDefinition()
         {
             int start = _currentToken.Start;
-            GraphQLScalarValue? description = null;
+            GraphQLDescription? description = null;
             if (Peek(TokenKind.STRING))
             {
-                description = ParseString();
+                description = ParseDescription();
                 ParseComment();
             }
             var comment = GetComment();
@@ -349,10 +349,10 @@ private GraphQLDocument ParseDocument()
         private GraphQLEnumTypeDefinition ParseEnumTypeDefinition()
         {
             int start = _currentToken.Start;
-            GraphQLScalarValue? description = null;
+            GraphQLDescription? description = null;
             if (Peek(TokenKind.STRING))
             {
-                description = ParseString();
+                description = ParseDescription();
                 ParseComment();
             }
             var comment = GetComment();
@@ -395,10 +395,10 @@ private GraphQLValue ParseEnumValue(Token token)
         private GraphQLEnumValueDefinition ParseEnumValueDefinition()
         {
             int start = _currentToken.Start;
-            GraphQLScalarValue? description = null;
+            GraphQLDescription? description = null;
             if (Peek(TokenKind.STRING))
             {
-                description = ParseString();
+                description = ParseDescription();
                 ParseComment();
             }
             var comment = GetComment();
@@ -423,10 +423,10 @@ private GraphQLEnumValueDefinition ParseEnumValueDefinition()
         private GraphQLFieldDefinition ParseFieldDefinition()
         {
             int start = _currentToken.Start;
-            GraphQLScalarValue? description = null;
+            GraphQLDescription? description = null;
             if (Peek(TokenKind.STRING))
             {
-                description = ParseString();
+                description = ParseDescription();
                 ParseComment();
             }
 
@@ -624,10 +624,10 @@ private void Throw_From_ParseFragmentName()
         private GraphQLInputObjectTypeDefinition ParseInputObjectTypeDefinition()
         {
             int start = _currentToken.Start;
-            GraphQLScalarValue? description = null;
+            GraphQLDescription? description = null;
             if (Peek(TokenKind.STRING))
             {
-                description = ParseString();
+                description = ParseDescription();
                 ParseComment();
             }
             var comment = GetComment();
@@ -655,10 +655,10 @@ private GraphQLInputObjectTypeDefinition ParseInputObjectTypeDefinition()
         private GraphQLInputValueDefinition ParseInputValueDef()
         {
             int start = _currentToken.Start;
-            GraphQLScalarValue? description = null;
+            GraphQLDescription? description = null;
             if (Peek(TokenKind.STRING))
             {
-                description = ParseString();
+                description = ParseDescription();
                 ParseComment();
             }
             var comment = GetComment();
@@ -706,10 +706,10 @@ private GraphQLValue ParseInt(/*bool isConstant*/)
         private GraphQLInterfaceTypeDefinition ParseInterfaceTypeDefinition()
         {
             int start = _currentToken.Start;
-            GraphQLScalarValue? description = null;
+            GraphQLDescription? description = null;
             if (Peek(TokenKind.STRING))
             {
-                description = ParseString();
+                description = ParseDescription();
                 ParseComment();
             }
             var comment = GetComment();
@@ -964,10 +964,10 @@ private List<GraphQLObjectField> ParseObjectFields(bool isConstant)
         private GraphQLObjectTypeDefinition ParseObjectTypeDefinition()
         {
             int start = _currentToken.Start;
-            GraphQLScalarValue? description = null;
+            GraphQLDescription? description = null;
             if (Peek(TokenKind.STRING))
             {
-                description = ParseString();
+                description = ParseDescription();
                 ParseComment();
             }
             var comment = GetComment();
@@ -1084,10 +1084,10 @@ private GraphQLOperationTypeDefinition ParseOperationTypeDefinition()
         private GraphQLScalarTypeDefinition ParseScalarTypeDefinition()
         {
             int start = _currentToken.Start;
-            GraphQLScalarValue? description = null;
+            GraphQLDescription? description = null;
             if (Peek(TokenKind.STRING))
             {
-                description = ParseString();
+                description = ParseDescription();
                 ParseComment();
             }
             var comment = GetComment();
@@ -1173,6 +1173,22 @@ private GraphQLScalarValue ParseString(/*bool isConstant*/)
                 };
         }
 
+        private GraphQLDescription ParseDescription()
+        {
+            var token = _currentToken;
+            Advance();
+            return _ignoreOptions == IgnoreOptions.IgnoreCommentsAndLocations
+                ? new GraphQLDescription()
+                {
+                    Value = token.Value,
+                }
+                : new GraphQLDescription()
+                {
+                    Value = token.Value,
+                    Location = GetLocation(token.Start)
+                };
+        }
+
         private GraphQLType ParseType()
         {
             GraphQLType type;
@@ -1253,10 +1269,10 @@ private List<GraphQLNamedType> ParseUnionMembers()
         private GraphQLUnionTypeDefinition ParseUnionTypeDefinition()
         {
             int start = _currentToken.Start;
-            GraphQLScalarValue? description = null;
+            GraphQLDescription? description = null;
             if (Peek(TokenKind.STRING))
             {
-                description = ParseString();
+                description = ParseDescription();
                 ParseComment();
             }
             var comment = GetComment();

Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,7 @@ namespace GraphQLParser.AST`
`47`	`47`	`TypeExtensionDefinition = 35,`
`48`	`48`	`DirectiveDefinition = 36,`
`49`	`49`	`Comment = 37,`
	`50`	`+ Description = 38,`
`50`	`51`	`}`
`51`	`52`	`public class GraphQLArgument : GraphQLParser.AST.ASTNode, GraphQLParser.AST.INamedNode`
`52`	`53`	`{`
`@@ -62,6 +63,12 @@ namespace GraphQLParser.AST`
`62`	`63`	`public GraphQLParser.ROM Text { get; set; }`
`63`	`64`	`public override GraphQLParser.AST.GraphQLLocation Location { get; set; }`
`64`	`65`	`}`
	`66`	`+ public class GraphQLDescription : GraphQLParser.AST.ASTNode`
	`67`	`+ {`
	`68`	`+ public GraphQLDescription() { }`
	`69`	`+ public override GraphQLParser.AST.ASTNodeKind Kind { get; }`
	`70`	`+ public GraphQLParser.ROM Value { get; set; }`
	`71`	`+ }`
`65`	`72`	`public class GraphQLDirective : GraphQLParser.AST.ASTNode, GraphQLParser.AST.INamedNode`
`66`	`73`	`{`
`67`	`74`	`public GraphQLDirective() { }`
`@@ -280,10 +287,10 @@ namespace GraphQLParser.AST`
`280`	`287`	`protected GraphQLTypeDefinition() { }`
`281`	`288`	`public GraphQLParser.AST.GraphQLName? Name { get; set; }`
`282`	`289`	`}`
`283`		`- public abstract class GraphQLTypeDefinitionWithDescription : GraphQLParser.AST.GraphQLTypeDefinition`
	`290`	`+ public abstract class GraphQLTypeDefinitionWithDescription : GraphQLParser.AST.GraphQLTypeDefinition, GraphQLParser.AST.IHasDescription`
`284`	`291`	`{`
`285`	`292`	`protected GraphQLTypeDefinitionWithDescription() { }`
`286`		`- public GraphQLParser.AST.GraphQLScalarValue? Description { get; set; }`
	`293`	`+ public GraphQLParser.AST.GraphQLDescription? Description { get; set; }`
`287`	`294`	`}`
`288`	`295`	`public class GraphQLTypeExtensionDefinition : GraphQLParser.AST.GraphQLTypeDefinition`
`289`	`296`	`{`
`@@ -316,6 +323,10 @@ namespace GraphQLParser.AST`
`316`	`323`	`public GraphQLParser.AST.GraphQLType? Type { get; set; }`
`317`	`324`	`public GraphQLParser.AST.GraphQLVariable? Variable { get; set; }`
`318`	`325`	`}`
	`326`	`+ public interface IHasDescription`
	`327`	`+ {`
	`328`	`+ GraphQLParser.AST.GraphQLDescription? Description { get; set; }`
	`329`	`+ }`
`319`	`330`	`public interface IHasDirectivesNode`
`320`	`331`	`{`
`321`	`332`	`System.Collections.Generic.List<GraphQLParser.AST.GraphQLDirective>? Directives { get; set; }`
Original file line number	Diff line number	Diff line change
`@@ -89,5 +89,10 @@ public enum ASTNodeKind`
`89`	`89`	`/// and have no significance to the semantic meaning of a GraphQL Document.`
`90`	`90`	`/// </summary>`
`91`	`91`	`Comment,`
	`92`	`+`
	`93`	`+ /// <summary>`
	`94`	`+ /// Description of a type definition.`
	`95`	`+ /// </summary>`
	`96`	`+ Description,`
`92`	`97`	`}`
`93`	`98`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,11 +6,11 @@ public abstract class GraphQLTypeDefinition : ASTNode, INamedNode`
`6`	`6`	`public GraphQLName? Name { get; set; }`
`7`	`7`	`}`
`8`	`8`
`9`		`- public abstract class GraphQLTypeDefinitionWithDescription : GraphQLTypeDefinition`
	`9`	`+ public abstract class GraphQLTypeDefinitionWithDescription : GraphQLTypeDefinition, IHasDescription`
`10`	`10`	`{`
`11`	`11`	`/// <summary>`
`12`		`- /// Description of the node as represented by a nested node.`
	`12`	`+ /// Description of the node`
`13`	`13`	`/// </summary>`
`14`		`- public GraphQLScalarValue? Description { get; set; }`
	`14`	`+ public GraphQLDescription? Description { get; set; }`
`15`	`15`	`}`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -233,10 +233,10 @@ private GraphQLDirective ParseDirective()`
`233`	`233`	`private GraphQLDirectiveDefinition ParseDirectiveDefinition()`
`234`	`234`	`{`
`235`	`235`	`int start = _currentToken.Start;`
`236`		`- GraphQLScalarValue? description = null;`
	`236`	`+ GraphQLDescription? description = null;`
`237`	`237`	`if (Peek(TokenKind.STRING))`
`238`	`238`	`{`
`239`		`- description = ParseString();`
	`239`	`+ description = ParseDescription();`
`240`	`240`	`ParseComment();`
`241`	`241`	`}`
`242`	`242`	`var comment = GetComment();`
`@@ -349,10 +349,10 @@ private GraphQLDocument ParseDocument()`
`349`	`349`	`private GraphQLEnumTypeDefinition ParseEnumTypeDefinition()`
`350`	`350`	`{`
`351`	`351`	`int start = _currentToken.Start;`
`352`		`- GraphQLScalarValue? description = null;`
	`352`	`+ GraphQLDescription? description = null;`
`353`	`353`	`if (Peek(TokenKind.STRING))`
`354`	`354`	`{`
`355`		`- description = ParseString();`
	`355`	`+ description = ParseDescription();`
`356`	`356`	`ParseComment();`
`357`	`357`	`}`
`358`	`358`	`var comment = GetComment();`
`@@ -395,10 +395,10 @@ private GraphQLValue ParseEnumValue(Token token)`
`395`	`395`	`private GraphQLEnumValueDefinition ParseEnumValueDefinition()`
`396`	`396`	`{`
`397`	`397`	`int start = _currentToken.Start;`
`398`		`- GraphQLScalarValue? description = null;`
	`398`	`+ GraphQLDescription? description = null;`
`399`	`399`	`if (Peek(TokenKind.STRING))`
`400`	`400`	`{`
`401`		`- description = ParseString();`
	`401`	`+ description = ParseDescription();`
`402`	`402`	`ParseComment();`
`403`	`403`	`}`
`404`	`404`	`var comment = GetComment();`
`@@ -423,10 +423,10 @@ private GraphQLEnumValueDefinition ParseEnumValueDefinition()`
`423`	`423`	`private GraphQLFieldDefinition ParseFieldDefinition()`
`424`	`424`	`{`
`425`	`425`	`int start = _currentToken.Start;`
`426`		`- GraphQLScalarValue? description = null;`
	`426`	`+ GraphQLDescription? description = null;`
`427`	`427`	`if (Peek(TokenKind.STRING))`
`428`	`428`	`{`
`429`		`- description = ParseString();`
	`429`	`+ description = ParseDescription();`
`430`	`430`	`ParseComment();`
`431`	`431`	`}`
`432`	`432`
`@@ -624,10 +624,10 @@ private void Throw_From_ParseFragmentName()`
`624`	`624`	`private GraphQLInputObjectTypeDefinition ParseInputObjectTypeDefinition()`
`625`	`625`	`{`
`626`	`626`	`int start = _currentToken.Start;`
`627`		`- GraphQLScalarValue? description = null;`
	`627`	`+ GraphQLDescription? description = null;`
`628`	`628`	`if (Peek(TokenKind.STRING))`
`629`	`629`	`{`
`630`		`- description = ParseString();`
	`630`	`+ description = ParseDescription();`
`631`	`631`	`ParseComment();`
`632`	`632`	`}`
`633`	`633`	`var comment = GetComment();`
`@@ -655,10 +655,10 @@ private GraphQLInputObjectTypeDefinition ParseInputObjectTypeDefinition()`
`655`	`655`	`private GraphQLInputValueDefinition ParseInputValueDef()`
`656`	`656`	`{`
`657`	`657`	`int start = _currentToken.Start;`
`658`		`- GraphQLScalarValue? description = null;`
	`658`	`+ GraphQLDescription? description = null;`
`659`	`659`	`if (Peek(TokenKind.STRING))`
`660`	`660`	`{`
`661`		`- description = ParseString();`
	`661`	`+ description = ParseDescription();`
`662`	`662`	`ParseComment();`
`663`	`663`	`}`
`664`	`664`	`var comment = GetComment();`
`@@ -706,10 +706,10 @@ private GraphQLValue ParseInt(/bool isConstant/)`
`706`	`706`	`private GraphQLInterfaceTypeDefinition ParseInterfaceTypeDefinition()`
`707`	`707`	`{`
`708`	`708`	`int start = _currentToken.Start;`
`709`		`- GraphQLScalarValue? description = null;`
	`709`	`+ GraphQLDescription? description = null;`
`710`	`710`	`if (Peek(TokenKind.STRING))`
`711`	`711`	`{`
`712`		`- description = ParseString();`
	`712`	`+ description = ParseDescription();`
`713`	`713`	`ParseComment();`
`714`	`714`	`}`
`715`	`715`	`var comment = GetComment();`
`@@ -964,10 +964,10 @@ private List<GraphQLObjectField> ParseObjectFields(bool isConstant)`
`964`	`964`	`private GraphQLObjectTypeDefinition ParseObjectTypeDefinition()`
`965`	`965`	`{`
`966`	`966`	`int start = _currentToken.Start;`
`967`		`- GraphQLScalarValue? description = null;`
	`967`	`+ GraphQLDescription? description = null;`
`968`	`968`	`if (Peek(TokenKind.STRING))`
`969`	`969`	`{`
`970`		`- description = ParseString();`
	`970`	`+ description = ParseDescription();`
`971`	`971`	`ParseComment();`
`972`	`972`	`}`
`973`	`973`	`var comment = GetComment();`
`@@ -1084,10 +1084,10 @@ private GraphQLOperationTypeDefinition ParseOperationTypeDefinition()`
`1084`	`1084`	`private GraphQLScalarTypeDefinition ParseScalarTypeDefinition()`
`1085`	`1085`	`{`
`1086`	`1086`	`int start = _currentToken.Start;`
`1087`		`- GraphQLScalarValue? description = null;`
	`1087`	`+ GraphQLDescription? description = null;`
`1088`	`1088`	`if (Peek(TokenKind.STRING))`
`1089`	`1089`	`{`
`1090`		`- description = ParseString();`
	`1090`	`+ description = ParseDescription();`
`1091`	`1091`	`ParseComment();`
`1092`	`1092`	`}`
`1093`	`1093`	`var comment = GetComment();`
`@@ -1173,6 +1173,22 @@ private GraphQLScalarValue ParseString(/bool isConstant/)`
`1173`	`1173`	`};`
`1174`	`1174`	`}`
`1175`	`1175`
	`1176`	`+ private GraphQLDescription ParseDescription()`
	`1177`	`+ {`
	`1178`	`+ var token = _currentToken;`
	`1179`	`+ Advance();`
	`1180`	`+ return _ignoreOptions == IgnoreOptions.IgnoreCommentsAndLocations`
	`1181`	`+ ? new GraphQLDescription()`
	`1182`	`+ {`
	`1183`	`+ Value = token.Value,`
	`1184`	`+ }`
	`1185`	`+ : new GraphQLDescription()`
	`1186`	`+ {`
	`1187`	`+ Value = token.Value,`
	`1188`	`+ Location = GetLocation(token.Start)`
	`1189`	`+ };`
	`1190`	`+ }`
	`1191`	`+`
`1176`	`1192`	`private GraphQLType ParseType()`
`1177`	`1193`	`{`
`1178`	`1194`	`GraphQLType type;`
`@@ -1253,10 +1269,10 @@ private List<GraphQLNamedType> ParseUnionMembers()`
`1253`	`1269`	`private GraphQLUnionTypeDefinition ParseUnionTypeDefinition()`
`1254`	`1270`	`{`
`1255`	`1271`	`int start = _currentToken.Start;`
`1256`		`- GraphQLScalarValue? description = null;`
	`1272`	`+ GraphQLDescription? description = null;`
`1257`	`1273`	`if (Peek(TokenKind.STRING))`
`1258`	`1274`	`{`
`1259`		`- description = ParseString();`
	`1275`	`+ description = ParseDescription();`
`1260`	`1276`	`ParseComment();`
`1261`	`1277`	`}`
`1262`	`1278`	`var comment = GetComment();`