Fix comment parsing with unattached comments (#104)

Author: Shane32

src/GraphQLParser.ApiTests/GraphQL-Parser.approved.txt

@@ -82,6 +82,7 @@ namespace GraphQLParser.AST
         public GraphQLDocument() { }
         public System.Collections.Generic.List<GraphQLParser.AST.ASTNode>? Definitions { get; set; }
         public override GraphQLParser.AST.ASTNodeKind Kind { get; }
+        public System.Collections.Generic.List<GraphQLParser.AST.GraphQLComment>? UnattachedComments { get; set; }
     }
     public class GraphQLEnumTypeDefinition : GraphQLParser.AST.GraphQLTypeDefinition, GraphQLParser.AST.IHasDirectivesNode
     {

src/GraphQLParser.Tests/ParserTests.cs

@@ -12,6 +12,50 @@ public class ParserTests
     {
         private static readonly string _nl = Environment.NewLine;
 
+        [Fact]
+        public void Extra_Comments_Should_Read_Correclty()
+        {
+            const string query = @"
+query _ {
+    person {
+        name
+        #comment1
+    }
+    #comment2
+    test {
+        alt
+    }
+    #comment3
+}
+#comment4
+";
+
+            var parser = new Parser(new Lexer());
+            var document = parser.Parse(new Source(query));
+            document.Definitions.Count().ShouldBe(1);
+            // query
+            var def = document.Definitions.First() as GraphQLOperationDefinition;
+            def.SelectionSet.Selections.Count().ShouldBe(2);
+            // person
+            var field = def.SelectionSet.Selections.First() as GraphQLFieldSelection;
+            field.SelectionSet.Selections.Count().ShouldBe(1);
+            // name
+            var subField = field.SelectionSet.Selections.First() as GraphQLFieldSelection;
+            subField.Comment.ShouldBeNull();
+            // test
+            field = def.SelectionSet.Selections.Last() as GraphQLFieldSelection;
+            field.SelectionSet.Selections.Count().ShouldBe(1);
+            field.Comment.Text.ShouldBe("comment2");
+            // alt
+            subField = field.SelectionSet.Selections.First() as GraphQLFieldSelection;
+            subField.Comment.ShouldBeNull();
+            // extra document comments
+            document.UnattachedComments.Count().ShouldBe(3);
+            document.UnattachedComments[0].Text.ShouldBe("comment1");
+            document.UnattachedComments[1].Text.ShouldBe("comment3");
+            document.UnattachedComments[2].Text.ShouldBe("comment4");
+        }
+
         [Fact]
         public void Comments_on_FragmentSpread_Should_Read_Correclty()
         {

src/GraphQLParser/AST/GraphQLDocument.cs

@@ -1,4 +1,4 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 
 namespace GraphQLParser.AST
 {
@@ -7,5 +7,6 @@ public class GraphQLDocument : ASTNode
         public List<ASTNode>? Definitions { get; set; }
 
         public override ASTNodeKind Kind => ASTNodeKind.Document;
+        public List<GraphQLComment>? UnattachedComments { get; set; }
     }
-}
+}

src/GraphQLParser/Parser.cs

@@ -13,7 +13,7 @@ public Parser(ILexer lexer)
 
         public GraphQLDocument Parse(ISource source)
         {
-            using var context = new ParserContext(source, _lexer);
+            var context = new ParserContext(source, _lexer);
             return context.Parse();
         }
     }