fix: Allow semicolon as object entry separator.

jsdoc-type-pratt-parser · Jul 19, 2021 · d5a3df4 · d5a3df4
1 parent 5c89f97
commit d5a3df4
Show file tree

Hide file tree

Showing 11 changed files with 219 additions and 4 deletions.
diff --git a/src/errors.ts b/src/errors.ts
@@ -49,6 +49,14 @@ export class UnexpectedTypeError extends Error {
   }
 }
 
+export class InvalidSyntax extends Error {
+  constructor (message: string) {
+    super(`Invalid syntax: ${message}`)
+
+    Object.setPrototypeOf(this, InvalidSyntax.prototype)
+  }
+}
+
 // export class UnexpectedTokenError extends Error {
 //   private expected: Token
 //   private found: Token

diff --git a/src/lexer/Lexer.ts b/src/lexer/Lexer.ts
@@ -150,6 +150,7 @@ const rules = [
   makePunctuationRule('<'),
   makePunctuationRule('>'),
   makePunctuationRule(','),
+  makePunctuationRule(';'),
   makePunctuationRule('*'),
   makePunctuationRule('?'),
   makePunctuationRule('!'),

diff --git a/src/lexer/Token.ts b/src/lexer/Token.ts
@@ -9,6 +9,7 @@ export type TokenType =
   | '&'
   | '<'
   | '>'
+  | ';'
   | ','
   | '*'
   | '?'

diff --git a/src/parslets/ObjectParslet.ts b/src/parslets/ObjectParslet.ts
@@ -2,7 +2,7 @@ import { PrefixParslet } from './Parslet'
 import { TokenType } from '../lexer/Token'
 import { Parser } from '../Parser'
 import { Precedence } from '../Precedence'
-import { UnexpectedTypeError } from '../errors'
+import { InvalidSyntax, UnexpectedTypeError } from '../errors'
 import { ObjectResult, TerminalResult } from '../result/TerminalResult'
 
 interface ObjectParsletOptions {
@@ -28,11 +28,16 @@ export class ObjectParslet implements PrefixParslet {
     parser.consume('{')
     const result: ObjectResult = {
       type: 'JsdocTypeObject',
+      meta: {
+        separator: 'comma'
+      },
       elements: []
     }
 
     if (!parser.consume('}')) {
-      do {
+      let separator: 'comma' | 'semicolon' | undefined
+
+      while (true) {
         let field = parser.parseIntermediateType(Precedence.OBJECT)
 
         let optional = false
@@ -61,7 +66,23 @@ export class ObjectParslet implements PrefixParslet {
         } else {
           throw new UnexpectedTypeError(field)
         }
-      } while (parser.consume(','))
+        if (parser.consume(',')) {
+          if (separator === 'semicolon') {
+            throw new InvalidSyntax('Object should use either comma or semicolon, not both.')
+          }
+          separator = 'comma'
+        } else if (parser.consume(';')) {
+          if (separator === 'comma') {
+            throw new InvalidSyntax('Object should use either comma or semicolon, not both.')
+          }
+          separator = 'semicolon'
+        } else {
+          break
+        }
+      }
+
+      result.meta.separator = separator ?? 'comma'
+
       if (!parser.consume('}')) {
         throw new Error('Unterminated record type. Missing \'}\'')
       }

diff --git a/src/result/TerminalResult.ts b/src/result/TerminalResult.ts
@@ -171,6 +171,9 @@ export interface FunctionResult {
 export interface ObjectResult {
   type: 'JsdocTypeObject'
   elements: Array<KeyValueResult | JsdocObjectKeyValueResult>
+  meta: {
+    separator: 'comma' | 'semicolon'
+  }
 }
 
 export type SpecialNamePathType = 'module' | 'event' | 'external'

diff --git a/src/transforms/identityTransformRules.ts b/src/transforms/identityTransformRules.ts
@@ -68,6 +68,9 @@ export function identityTransformRules (): TransformRules<NonTerminalResult> {
 
     JsdocTypeObject: (result, transform) => ({
       type: 'JsdocTypeObject',
+      meta: {
+        separator: 'comma'
+      },
       elements: result.elements.map(transform) as Array<KeyValueResult | JsdocObjectKeyValueResult>
     }),
 

diff --git a/src/transforms/stringify.ts b/src/transforms/stringify.ts
@@ -98,7 +98,7 @@ export function stringifyRules (): TransformRules<string> {
 
     JsdocTypeNumber: result => result.value.toString(),
 
-    JsdocTypeObject: (result, transform) => `{${result.elements.map(transform).join(', ')}}`,
+    JsdocTypeObject: (result, transform) => `{${result.elements.map(transform).join((result.meta.separator === 'comma' ? ',' : ';') + ' ')}}`,
 
     JsdocTypeOptional: (result, transform) => applyPosition(result.meta.position, transform(result.element), '='),
 

diff --git a/test/fixtures/catharsis/jsdoc.spec.ts b/test/fixtures/catharsis/jsdoc.spec.ts
@@ -774,6 +774,9 @@ describe('catharsis jsdoc tests', () => {
       input: '{Array.<string>: number}',
       expected: {
         type: 'JsdocTypeObject',
+        meta: {
+          separator: 'comma'
+        },
         elements: [
           {
             type: 'JsdocTypeKeyValue',
@@ -823,6 +826,9 @@ describe('catharsis jsdoc tests', () => {
       stringified: '{(number | boolean | string): number}',
       expected: {
         type: 'JsdocTypeObject',
+        meta: {
+          separator: 'comma'
+        },
         elements: [
           {
             type: 'JsdocTypeKeyValue',
@@ -875,6 +881,9 @@ describe('catharsis jsdoc tests', () => {
       stringified: '{undefinedHTML: (string | undefined)}',
       expected: {
         type: 'JsdocTypeObject',
+        meta: {
+          separator: 'comma'
+        },
         elements: [
           {
             type: 'JsdocTypeKeyValue',
@@ -925,6 +934,9 @@ describe('catharsis jsdoc tests', () => {
       stringified: '{foo: function()}',
       expected: {
         type: 'JsdocTypeObject',
+        meta: {
+          separator: 'comma'
+        },
         elements: [
           {
             type: 'JsdocTypeKeyValue',
@@ -965,6 +977,9 @@ describe('catharsis jsdoc tests', () => {
       stringified: '{foo: function(): void}',
       expected: {
         type: 'JsdocTypeObject',
+        meta: {
+          separator: 'comma'
+        },
         elements: [
           {
             type: 'JsdocTypeKeyValue',