cddl 0.15.0 → 0.16.0

package/build/parser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../src/parser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,MAAM,YAAY,CAAA;AAE9B,OAAO,EAAE,KAAK,EAAU,MAAM,aAAa,CAAC;AAG5C,OAAO,EAE2C,UAAU,EAE3D,MAAM,UAAU,CAAA;AAoBjB,MAAM,CAAC,OAAO,OAAO,MAAM;;IAEvB,CAAC,EAAE,KAAK,CAAC;IAET,QAAQ,EAAE,KAAK,CAAa;IAC5B,SAAS,EAAE,KAAK,CAAa;IAC7B,cAAc,EAAE,KAAK,CAAa;gBAErB,QAAQ,EAAE,MAAM;IAS7B,OAAO,CAAC,SAAS;IAOjB,OAAO,CAAC,gBAAgB;IA2CxB,OAAO,CAAC,oBAAoB;IAue5B,OAAO,CAAC,wBAAwB;IAahC;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAenB,OAAO,CAAC,iBAAiB;IAazB,OAAO,CAAC,iBAAiB;IAqKzB,OAAO,CAAC,aAAa;IAgBrB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,kBAAkB;IAuD1B,OAAO,CAAC,gBAAgB;IA4DxB;;OAEG;IACH,OAAO,CAAC,YAAY;IAcpB,KAAK;IAaL,OAAO,CAAC,WAAW;CAKtB"}
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../src/parser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,MAAM,YAAY,CAAA;AAE9B,OAAO,EAAE,KAAK,EAAU,MAAM,aAAa,CAAC;AAG5C,OAAO,EAE2C,UAAU,EAE3D,MAAM,UAAU,CAAA;AAoBjB,MAAM,CAAC,OAAO,OAAO,MAAM;;IAEvB,CAAC,EAAE,KAAK,CAAC;IAET,QAAQ,EAAE,KAAK,CAAa;IAC5B,SAAS,EAAE,KAAK,CAAa;IAC7B,cAAc,EAAE,KAAK,CAAa;gBAErB,QAAQ,EAAE,MAAM;IAS7B,OAAO,CAAC,SAAS;IAOjB,OAAO,CAAC,gBAAgB;IA8CxB,OAAO,CAAC,oBAAoB;IAue5B,OAAO,CAAC,wBAAwB;IAahC;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAenB,OAAO,CAAC,iBAAiB;IAazB,OAAO,CAAC,iBAAiB;IAqKzB,OAAO,CAAC,aAAa;IAgBrB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,kBAAkB;IA8E1B,OAAO,CAAC,gBAAgB;IA4DxB;;OAEG;IACH,OAAO,CAAC,YAAY;IAcpB,KAAK;IAaL,OAAO,CAAC,WAAW;CAKtB"}

package/build/parser.js

@@ -43,7 +43,10 @@ export default class Parser {
     parseAssignments() {
         const comments = [];
         while (this.curToken.Type === Tokens.COMMENT) {
-            comments.push(this.parseComment());
+            const comment = this.parseComment();
+            if (comment) {
+                comments.push(comment);
+            }
         }
         /**
          * expect group identifier, e.g.
@@ -588,7 +591,7 @@ export default class Parser {
                         Unwrapped: isUnwrapped
                     };
                 }
-                else if (this.curToken.Literal === Tokens.LBRACE) {
+                else if (this.curToken.Literal === Tokens.LBRACE || this.curToken.Literal === Tokens.LBRACK) {
                     const val = this.parseAssignmentValue();
                     if (Array.isArray(val)) {
                         throw new Error('Unexpected array in property type parsing');
@@ -739,6 +742,21 @@ export default class Parser {
             this.nextToken(); // eat Property if not already consumed (e.g. by Group parsing)
         }
         propertyTypes.push(prop);
+        /**
+         * ignore comments between type choice members, e.g.
+         * ```
+         * Foo = int ; comment
+         *     / text
+         * ```
+         * or
+         * ```
+         * Foo = int / ; comment
+         *     text
+         * ```
+         */
+        while (this.curToken.Type === Tokens.COMMENT && this.peekToken.Type === Tokens.SLASH) {
+            this.parseComment();
+        }
         /**
          * ensure we don't go into the next choice, e.g.:
          * ```
@@ -754,6 +772,9 @@ export default class Parser {
          */
         while (this.curToken.Type === Tokens.SLASH) {
             this.nextToken(); // eat `/`
+            while ([Tokens.COMMENT].includes(this.curToken.Type)) {
+                this.parseComment();
+            }
             propertyTypes.push(this.parsePropertyType());
             if (!this.isOperator() && this.curToken.Type !== Tokens.SLASH) {
                 /**
@@ -762,6 +783,9 @@ export default class Parser {
                  */
                 this.nextToken();
             }
+            while ([Tokens.COMMENT].includes(this.curToken.Type) && this.peekToken.Type === Tokens.SLASH) {
+                this.parseComment();
+            }
             /**
              * ensure we don't go into the next choice, e.g.:
              * ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cddl",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "Concise data definition language (RFC 8610) implementation and JSON validator in Node.js",
   "author": "Christian Bromann <mail@bromann.dev>",
   "license": "MIT",

package/src/parser.ts

@@ -56,7 +56,10 @@ export default class Parser {
     private parseAssignments (): Assignment {
         const comments: Comment[] = []
         while (this.curToken.Type === Tokens.COMMENT) {
-            comments.push(this.parseComment()!)
+            const comment = this.parseComment()
+            if (comment) {
+                comments.push(comment)
+            }
         }
 
         /**
@@ -667,12 +670,12 @@ export default class Parser {
                         Value: this.curToken.Literal === 'true',
                         Unwrapped: isUnwrapped
                     }
-                } else if (this.curToken.Literal === Tokens.LBRACE) {
-                   const val = this.parseAssignmentValue();
-                   if (Array.isArray(val)) {
-                     throw new Error('Unexpected array in property type parsing');
-                   }
-                   type = val
+                } else if (this.curToken.Literal === Tokens.LBRACE || this.curToken.Literal === Tokens.LBRACK) {
+                    const val = this.parseAssignmentValue()
+                    if (Array.isArray(val)) {
+                        throw new Error('Unexpected array in property type parsing')
+                    }
+                    type = val
                 } else if (this.curToken.Type === Tokens.IDENT) {
                     type = {
                         Type: 'group' as PropertyReferenceType,
@@ -829,6 +832,22 @@ export default class Parser {
 
         propertyTypes.push(prop)
 
+        /**
+         * ignore comments between type choice members, e.g.
+         * ```
+         * Foo = int ; comment
+         *     / text
+         * ```
+         * or
+         * ```
+         * Foo = int / ; comment
+         *     text
+         * ```
+         */
+        while (this.curToken.Type === Tokens.COMMENT && this.peekToken.Type === Tokens.SLASH) {
+            this.parseComment()
+        }
+
         /**
          * ensure we don't go into the next choice, e.g.:
          * ```
@@ -845,6 +864,9 @@ export default class Parser {
          */
         while (this.curToken.Type === Tokens.SLASH) {
             this.nextToken() // eat `/`
+            while ([Tokens.COMMENT].includes(this.curToken.Type)) {
+                this.parseComment()
+            }
             propertyTypes.push(this.parsePropertyType())
             if (!this.isOperator() && this.curToken.Type !== Tokens.SLASH) {
                 /**
@@ -854,6 +876,10 @@ export default class Parser {
                 this.nextToken()
             }
 
+            while ([Tokens.COMMENT].includes(this.curToken.Type) && this.peekToken.Type === Tokens.SLASH) {
+                this.parseComment()
+            }
+
             /**
              * ensure we don't go into the next choice, e.g.:
              * ```

package/tests/__snapshots__/group-choices.test.ts.snap

@@ -262,6 +262,131 @@ exports[`Group Choice Parsing > Type Choice (/) > should correctly handle slash
 ]
 `;
 
+exports[`Group Choice Parsing > Type Choice (/) > should parse inline array alternatives inside map properties 1`] = `
+[
+  {
+    "Comments": [],
+    "IsChoiceAddition": false,
+    "Name": "StorePutParams",
+    "Properties": [
+      {
+        "Comments": [],
+        "HasCut": true,
+        "Name": "storeNamespace",
+        "Occurrence": {
+          "m": 1,
+          "n": 1,
+        },
+        "Type": [
+          {
+            "Comments": [],
+            "Name": "",
+            "Type": "array",
+            "Values": [
+              {
+                "Comments": [],
+                "HasCut": false,
+                "Name": "",
+                "Occurrence": {
+                  "m": Infinity,
+                  "n": 0,
+                },
+                "Type": "text",
+              },
+            ],
+          },
+        ],
+      },
+      {
+        "Comments": [],
+        "HasCut": true,
+        "Name": "key",
+        "Occurrence": {
+          "m": 1,
+          "n": 1,
+        },
+        "Type": [
+          "text",
+        ],
+      },
+      {
+        "Comments": [],
+        "HasCut": true,
+        "Name": "value",
+        "Occurrence": {
+          "m": 1,
+          "n": 1,
+        },
+        "Type": [
+          {
+            "Comments": [],
+            "IsChoiceAddition": false,
+            "Name": "",
+            "Properties": [
+              {
+                "Comments": [],
+                "HasCut": false,
+                "Name": "text",
+                "Occurrence": {
+                  "m": Infinity,
+                  "n": 0,
+                },
+                "Type": [
+                  "any",
+                ],
+              },
+            ],
+            "Type": "group",
+          },
+        ],
+      },
+      {
+        "Comments": [],
+        "HasCut": true,
+        "Name": "index",
+        "Occurrence": {
+          "m": Infinity,
+          "n": 0,
+        },
+        "Type": [
+          "bool",
+          {
+            "Comments": [],
+            "Name": "",
+            "Type": "array",
+            "Values": [
+              {
+                "Comments": [],
+                "HasCut": false,
+                "Name": "",
+                "Occurrence": {
+                  "m": Infinity,
+                  "n": 0,
+                },
+                "Type": "text",
+              },
+            ],
+          },
+        ],
+      },
+      {
+        "Comments": [],
+        "HasCut": true,
+        "Name": "ttl",
+        "Occurrence": {
+          "m": Infinity,
+          "n": 0,
+        },
+        "Type": [
+          "uint",
+        ],
+      },
+    ],
+    "Type": "group",
+  },
+]
+`;
+
 exports[`Group Choice Parsing > Type Choice (/) > should parse type choice inside group 1`] = `
 [
   {

package/tests/group-choices.test.ts

@@ -70,6 +70,21 @@ describe('Group Choice Parsing', () => {
             expect(ast).toMatchSnapshot()
         })
 
+        it('should treat comments around type choice separators the same', () => {
+            const slashAfterComment = `
+                FlowStrategy = "drop-oldest"            ; Discard oldest when buffer is full
+                             / "pause-producer"          ; Apply backpressure to slow production
+                             / "sample"                  ; Deliver every Nth event under pressure
+            `
+            const slashBeforeComment = `
+                FlowStrategy = "drop-oldest" /           ; Discard oldest when buffer is full
+                               "pause-producer" /        ; Apply backpressure to slow production
+                               "sample"                  ; Deliver every Nth event under pressure
+            `
+
+            expect(parse(slashAfterComment)).toEqual(parse(slashBeforeComment))
+        })
+
         // This tests the change: closingTokens.includes(Tokens.RPAREN) && this.peekToken.Type === Tokens.SLASH
         it('should correctly handle slash in mixed context', () => {
             const cddl = `
@@ -78,6 +93,20 @@ describe('Group Choice Parsing', () => {
             const ast = parse(cddl)
             expect(ast).toMatchSnapshot()
         })
+
+        it('should parse inline array alternatives inside map properties', () => {
+            const cddl = `
+                StorePutParams = {
+                    storeNamespace: [* text],
+                    key: text,
+                    value: {* text => any},
+                    ? index: bool / [* text],
+                    ? ttl: uint,
+                }
+            `
+            const ast = parse(cddl)
+            expect(ast).toMatchSnapshot()
+        })
     })
 
     describe('Blocks with Braces', () => {

package/tests/parser.test.ts

@@ -41,4 +41,23 @@ describe('parser', () => {
         expect(() => p.parse()).toThrow('group identifier expected')
         vi.restoreAllMocks()
     })
+
+    it('skips blank comment lines in assignment comments', () => {
+        vi.spyOn(fs, 'readFileSync').mockReturnValue('; heading\n;\nfoo = int\n')
+        const p = new Parser('foo.cddl')
+
+        expect(p.parse()).toEqual([{
+            Type: 'variable',
+            Name: 'foo',
+            IsChoiceAddition: false,
+            PropertyType: ['int'],
+            Comments: [{
+                Type: 'comment',
+                Content: 'heading',
+                Leading: false
+            }]
+        }])
+
+        vi.restoreAllMocks()
+    })
 })