Merge pull request #36 from soft-decay/master

fix(jsdoc): Object literals not supported in type annotation (#35)
KatChaotic · Nov 28, 2020 · bda24da · bda24da
2 parents 66e6b89 + 3078d9a
commit bda24da
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 1 deletion.
diff --git a/examples/Button.json b/examples/Button.json
@@ -105,6 +105,25 @@
                 ]
             },
             "defaultValue": "normal"
+        },
+        {
+            "keywords": [
+                {
+                    "name": "type",
+                    "description": "{{ rtl: boolean, lang: string }}"
+                }
+            ],
+            "visibility": "public",
+            "description": "Additional options for the button.",
+            "name": "options",
+            "kind": "let",
+            "static": false,
+            "readonly": false,
+            "type": {
+                "kind": "type",
+                "text": "{ rtl: boolean, lang: string }",
+                "type": "{ rtl: boolean, lang: string }"
+            }
         }
     ],
     "computed": [],

diff --git a/examples/Button.svelte b/examples/Button.svelte
@@ -24,6 +24,12 @@
      * @type {'small'|'normal'|'big'}
      */
     export let size = 'normal';
+
+    /**
+     * Additional options for the button.
+     * @type {{ rtl: boolean, lang: string }}
+     */
+     export let options = { rtl: false, lang: 'en-us' };
 </script>
 
 <button type="button" on:click>

diff --git a/lib/jsdoc.js b/lib/jsdoc.js
@@ -1,7 +1,7 @@
 
 const PARAM_NAME = '[a-z0-9$\\.\\[\\]_]+';
 
-const TYPE = '\\{([^\\}]*)\\}';
+const TYPE = '\\{(.*)\\}';
 const PARAM_TYPE = '\\{((?:\\.\\.\\.)?[^\\}]*)=?\\}';
 
 const TYPE_RE = new RegExp(`^\\s*${TYPE}`, 'i');

diff --git a/test/unit/jsdoc/jsdoc.spec.js b/test/unit/jsdoc/jsdoc.spec.js
@@ -29,6 +29,22 @@ describe('JSDoc parser module tests', () => {
             expect(type.type).is.equal('string');
         });
 
+        it('Object literal', () => {
+            const type = jsdoc.parseTypeKeyword('{{ prop: string }}');
+
+            expect(type).is.exist;
+            expect(type.kind).is.equal('type');
+            expect(type.type).is.equal('{ prop: string }');
+        });
+
+        it('Nested object literals', () => {
+            const type = jsdoc.parseTypeKeyword('{{ prop: { internal: string } }}');
+
+            expect(type).is.exist;
+            expect(type.kind).is.equal('type');
+            expect(type.type).is.equal('{ prop: { internal: string } }');
+        });
+
         it('Array with generic declaration', () => {
             const type = jsdoc.parseTypeKeyword('{Array<string>}');
 
@@ -64,6 +80,17 @@ describe('JSDoc parser module tests', () => {
             expect(type.type.some(t => t.type === 'MouseEvent')).to.be.true;
         });
 
+        it('Union of object literals', () => {
+            const type = jsdoc.parseTypeKeyword('{{ some: string }|{ other: boolean }}');
+
+            expect(type).is.exist;
+            expect(type.kind).is.equal('union');
+            expect(type.type.length).is.equal(2);
+
+            expect(type.type.some(t => t.type === '{ some: string }')).to.be.true;
+            expect(type.type.some(t => t.type === '{ other: boolean }')).to.be.true;
+        });
+
         it('Union of classes with spacings', () => {
             const type = jsdoc.parseTypeKeyword('{KeyboardEvent | MouseEvent}');