add tests for @attr / @Attribute

open-wc · May 6, 2024 · 0110361 · 0110361
1 parent d072db1
commit 0110361
Show file tree

Hide file tree

Showing 3 changed files with 184 additions and 0 deletions.
diff --git a/packages/analyzer/fixtures/06-jsdoc/default/fixture/custom-elements.json b/packages/analyzer/fixtures/06-jsdoc/default/fixture/custom-elements.json
@@ -27,6 +27,84 @@
             {
               "kind": "field",
               "name": "withoutDefault"
+            },
+            {
+              "kind": "field",
+              "name": "foo",
+              "type": {
+                "text": "string"
+              },
+              "description": "Should work with \"@attribute\" and no name",
+              "default": "\"bar\"",
+              "attribute": "foo"
+            },
+            {
+              "kind": "field",
+              "name": "myFoo",
+              "type": {
+                "text": "string"
+              },
+              "description": "Should work with \"@attribute\" and a name",
+              "default": "\"bar\"",
+              "attribute": "my-foo"
+            },
+            {
+              "kind": "field",
+              "name": "bar",
+              "type": {
+                "text": "string"
+              },
+              "description": "Should work with \"@attr\" and no name",
+              "default": "\"bar\"",
+              "attribute": "bar"
+            },
+            {
+              "kind": "field",
+              "name": "myBar",
+              "type": {
+                "text": "string"
+              },
+              "description": "Should work with \"@attr\" and a name",
+              "default": "\"bar\"",
+              "attribute": "my-bar"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "foo",
+              "type": {
+                "text": "string"
+              },
+              "description": "Should work with \"@attribute\" and no name",
+              "default": "\"bar\"",
+              "fieldName": "foo"
+            },
+            {
+              "name": "my-foo",
+              "type": {
+                "text": "string"
+              },
+              "description": "Should work with \"@attribute\" and a name",
+              "default": "\"bar\"",
+              "fieldName": "myFoo"
+            },
+            {
+              "name": "bar",
+              "type": {
+                "text": "string"
+              },
+              "description": "Should work with \"@attr\" and no name",
+              "default": "\"bar\"",
+              "fieldName": "bar"
+            },
+            {
+              "name": "my-bar",
+              "type": {
+                "text": "string"
+              },
+              "description": "Should work with \"@attr\" and a name",
+              "default": "\"bar\"",
+              "fieldName": "myBar"
             }
           ],
           "superclass": {

diff --git a/packages/analyzer/fixtures/06-jsdoc/default/output.json b/packages/analyzer/fixtures/06-jsdoc/default/output.json
@@ -27,6 +27,84 @@
             {
               "kind": "field",
               "name": "withoutDefault"
+            },
+            {
+              "kind": "field",
+              "name": "foo",
+              "type": {
+                "text": "string"
+              },
+              "description": "Should work with \"@attribute\" and no name",
+              "default": "\"bar\"",
+              "attribute": "foo"
+            },
+            {
+              "kind": "field",
+              "name": "myFoo",
+              "type": {
+                "text": "string"
+              },
+              "description": "Should work with \"@attribute\" and a name",
+              "default": "\"bar\"",
+              "attribute": "my-foo"
+            },
+            {
+              "kind": "field",
+              "name": "bar",
+              "type": {
+                "text": "string"
+              },
+              "description": "Should work with \"@attr\" and no name",
+              "default": "\"bar\"",
+              "attribute": "bar"
+            },
+            {
+              "kind": "field",
+              "name": "myBar",
+              "type": {
+                "text": "string"
+              },
+              "description": "Should work with \"@attr\" and a name",
+              "default": "\"bar\"",
+              "attribute": "my-bar"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "foo",
+              "type": {
+                "text": "string"
+              },
+              "description": "Should work with \"@attribute\" and no name",
+              "default": "\"bar\"",
+              "fieldName": "foo"
+            },
+            {
+              "name": "my-foo",
+              "type": {
+                "text": "string"
+              },
+              "description": "Should work with \"@attribute\" and a name",
+              "default": "\"bar\"",
+              "fieldName": "myFoo"
+            },
+            {
+              "name": "bar",
+              "type": {
+                "text": "string"
+              },
+              "description": "Should work with \"@attr\" and no name",
+              "default": "\"bar\"",
+              "fieldName": "bar"
+            },
+            {
+              "name": "my-bar",
+              "type": {
+                "text": "string"
+              },
+              "description": "Should work with \"@attr\" and a name",
+              "default": "\"bar\"",
+              "fieldName": "myBar"
             }
           ],
           "superclass": {

diff --git a/packages/analyzer/fixtures/06-jsdoc/default/package/my-element.js b/packages/analyzer/fixtures/06-jsdoc/default/package/my-element.js
@@ -9,6 +9,34 @@ export class DefaultValues extends HTMLElement {
   defaultWhereCodeTakesPrecedence = 'default from code';
 
   withoutDefault;
+
+  constructor () {
+    super()
+
+    /**
+     * Should work with "@attribute" and no name
+     * @attribute
+     */
+    this.foo = "bar"
+
+    /**
+     * Should work with "@attribute" and a name
+     * @attribute my-foo
+     */
+    this.myFoo = "bar"
+
+    /**
+     * Should work with "@attr" and no name
+     * @attr
+     */
+    this.bar = "bar"
+
+    /**
+     * Should work with "@attr" and a name
+     * @attr my-bar
+     */
+    this.myBar = "bar"
+  }
 }
 
 customElements.define('default-values', DefaultValues);