bug: avoid trying to get properties of HTMLElement types

josemarluedke · Mar 9, 2024 · 127f9f8 · 127f9f8
1 parent cd14340
commit 127f9f8
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 7 deletions.
diff --git a/package.json b/package.json
@@ -15,7 +15,8 @@
     "compile": "tsc",
     "prepare": "tsc",
     "test": "jest",
-    "lint:js": "eslint . --ext .js,.ts"
+    "lint:js": "eslint . --ext .js,.ts",
+    "lint:js:fix": "eslint . --ext .js,.ts --fix"
   },
   "dependencies": {
     "debug": "^4.3.4",

diff --git a/src/parser.ts b/src/parser.ts
@@ -219,10 +219,18 @@ export default class Parser {
       };
     }
 
+    // check if one element has string ending with Element
+    let isElement = false;
+    [symbol?.getName(), typeAsString].forEach((v) => {
+      if (v && v.endsWith('Element')) {
+        isElement = true;
+      }
+    });
+
     if (
       symbol &&
-      this.isInterfaceOrObjectWithOptionalProperties(symbol, type) &&
-      !/Element$/.test(symbol.getName())
+      !isElement &&
+      this.isInterfaceOrObjectWithOptionalProperties(symbol, type)
     ) {
       const props = type.getApparentProperties();
       return {

diff --git a/tests/__fixtures__/button-args-only.ts b/tests/__fixtures__/button-args-only.ts
@@ -35,4 +35,4 @@ interface ButtonArgs {
  * The button component
  * @since 1.0.0
  */
-export default class Button extends Component<ButtonArgs> { }
+export default class Button extends Component<ButtonArgs> {}
diff --git a/tests/__fixtures__/button-with-extended-args.ts b/tests/__fixtures__/button-with-extended-args.ts
@@ -14,4 +14,4 @@ interface Signature {
   Args: ButtonArgs;
 }
 
-export default class ButtonWithExtendedArgs extends Component<Signature> { }
+export default class ButtonWithExtendedArgs extends Component<Signature> {}
diff --git a/tests/__fixtures__/dropdown.d.ts b/tests/__fixtures__/dropdown.d.ts
@@ -8,6 +8,8 @@ interface DropdownArgs {
    * @defaultValue true
    */
   closeOnItemSelect?: boolean;
+
+  someRandomElement?: HTMLElement;
 }
 
 interface Transition {

diff --git a/tests/__fixtures__/multiple-components.ts b/tests/__fixtures__/multiple-components.ts
@@ -16,5 +16,5 @@ interface Signature {
 // eslint-disable-next-line
 class NotExportedButton extends Component<Signature> { }
 
-export class ButtonNotDefault extends Component<Signature> { }
-export default class ButtonDefault extends Component<Signature> { }
+export class ButtonNotDefault extends Component<Signature> {}
+export default class ButtonDefault extends Component<Signature> {}
diff --git a/tests/__snapshots__/index.test.ts.snap b/tests/__snapshots__/index.test.ts.snap
@@ -440,6 +440,17 @@ option allows to choose where it appears from.",
           "type": "boolean",
         },
       },
+      {
+        "defaultValue": undefined,
+        "description": "",
+        "identifier": "someRandomElement",
+        "isInternal": false,
+        "isRequired": false,
+        "tags": {},
+        "type": {
+          "type": "HTMLElement",
+        },
+      },
     ],
     "Blocks": [
       {