Handle multiline leading comments (#44)

Author: grinstead

examples/commons/comments.cddl

@@ -9,4 +9,16 @@ person = {
 foo = { bar } ; some comment
 ; another comment
 
-som = { g } ; some g
+som = { g } ; some g
+
+sport = {
+    ; Some sports involve kicking a ball,
+    ; this field is self-explanatory but it is
+    ; good to test multiline comments
+    involves-kicking: bool
+
+    ? uses-ball: bool
+
+    ; a simple leading comment
+    ? involves-throwing: bool ; an extra comment
+}

packages/cddl/src/parser.ts

@@ -211,6 +211,13 @@ export default class Parser {
         }
 
         while (!closingTokens.includes(this.curToken.Type)) {
+            const comments: Comment[] = []
+            let leadingComment = this.parseComment(true)
+            while (leadingComment) {
+                comments.push(leadingComment)
+                leadingComment = this.parseComment(true)
+            }
+
             /**
              * check if we have a group choice instead of an assignment
              */
@@ -230,14 +237,10 @@ export default class Parser {
             }
 
             const propertyType: PropertyType[] = []
-            const comments: Comment[] = []
             let isUnwrapped = false
             let hasCut = false
             let propertyName = ''
 
-            const leadingComment = this.parseComment(true)
-            leadingComment && comments.push(leadingComment)
-
             const occurrence = this.parseOccurrences()
 
             /**

packages/cddl/tests/__snapshots__/parser.test.ts.snap

@@ -778,6 +778,78 @@ exports[`parser > can parse comments 1`] = `
     ],
     "Type": "group",
   },
+  {
+    "Comments": [],
+    "IsChoiceAddition": false,
+    "Name": "sport",
+    "Properties": [
+      {
+        "Comments": [
+          {
+            "Content": "Some sports involve kicking a ball,",
+            "Leading": true,
+            "Type": "comment",
+          },
+          {
+            "Content": "this field is self-explanatory but it is",
+            "Leading": true,
+            "Type": "comment",
+          },
+          {
+            "Content": "good to test multiline comments",
+            "Leading": true,
+            "Type": "comment",
+          },
+        ],
+        "HasCut": true,
+        "Name": "involves-kicking",
+        "Occurrence": {
+          "m": 1,
+          "n": 1,
+        },
+        "Type": [
+          "bool",
+        ],
+      },
+      {
+        "Comments": [
+          {
+            "Content": "a simple leading comment",
+            "Leading": false,
+            "Type": "comment",
+          },
+        ],
+        "HasCut": true,
+        "Name": "uses-ball",
+        "Occurrence": {
+          "m": Infinity,
+          "n": 0,
+        },
+        "Type": [
+          "bool",
+        ],
+      },
+      {
+        "Comments": [
+          {
+            "Content": "an extra comment",
+            "Leading": false,
+            "Type": "comment",
+          },
+        ],
+        "HasCut": true,
+        "Name": "involves-throwing",
+        "Occurrence": {
+          "m": Infinity,
+          "n": 0,
+        },
+        "Type": [
+          "bool",
+        ],
+      },
+    ],
+    "Type": "group",
+  },
 ]
 `;