fix: better @Attribute jsdoc support

open-wc · May 7, 2024 · 5e7a9f4 · 5e7a9f4
1 parent 7029066
commit 5e7a9f4
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 4 deletions.
diff --git a/packages/analyzer/CHANGELOG.md b/packages/analyzer/CHANGELOG.md
@@ -1,3 +1,6 @@
+## Release 0.9.9
+- Support `@attribute` jsdoc better
+
 ## Release 0.9.8
 - Skip `...super.properties` in lit's `static properties`
 

diff --git a/packages/analyzer/browser/index.js b/packages/analyzer/browser/index.js
@@ -203107,7 +203107,7 @@ var isDispatchEvent = (node) => node.expression?.name?.getText() === "dispatchEv
 var isReturnStatement = (statement) => statement?.kind === import_typescript2.default.SyntaxKind.ReturnStatement;
 var isCustomElementsDefineCall = (node) => (node?.expression?.getText() === "customElements" || node?.expression?.getText() === "window.customElements" || node?.expression?.getText() === "globalThis.customElements") && node?.name?.getText() === "define" && node?.parent?.kind === import_typescript2.default.SyntaxKind.CallExpression;
 function hasAttrAnnotation(member) {
-  return member?.jsDoc?.some((jsDoc) => jsDoc?.tags?.some((tag) => safe(() => tag?.tagName?.getText()) === "attr"));
+  return member?.jsDoc?.some((jsDoc) => jsDoc?.tags?.some((tag) => safe(() => ["attribute", "attr"].includes(tag?.tagName?.getText()))));
 }
 function hasInitializer(node) {
   return node?.declarationList?.declarations?.some((declaration) => declaration?.initializer);
@@ -203852,8 +203852,8 @@ function handleHeritage(classTemplate, moduleDoc, context, node) {
 }
 function handleAttrJsDoc(node, doc) {
   node?.jsDoc?.forEach((jsDoc) => {
-    const docs = parse(jsDoc?.getFullText())?.find((doc2) => doc2?.tags?.some(({ tag }) => tag === "attr"));
-    const attrTag = docs?.tags?.find(({ tag }) => tag === "attr");
+    const docs = parse(jsDoc?.getFullText())?.find((doc2) => doc2?.tags?.some(({ tag }) => ["attribute", "attr"].includes(tag)));
+    const attrTag = docs?.tags?.find(({ tag }) => ["attribute", "attr"].includes(tag));
     if (attrTag?.name) {
       doc.name = attrTag.name;
     }
@@ -204195,6 +204195,20 @@ function mapClassMember(source, classTemplate, context, node, statement, express
         ...resolveModuleOrPackageSpecifier({ path: source.getSourceFile().fileName }, context, expression?.right?.getText())
       };
     }
+    if (hasAttrAnnotation(statement)) {
+      const field = existingMember;
+      let attribute = createAttributeFromField(field);
+      attribute = handleAttrJsDoc(statement, attribute);
+      field.attribute = attribute.name;
+      let attrAlreadyExists = classTemplate.attributes.find((attr) => attr.name === attribute.name);
+      if (attrAlreadyExists) {
+        classTemplate.attributes = classTemplate.attributes.map((attr) => {
+          return attr.name === attribute.name ? { ...attrAlreadyExists, ...attribute } : attr;
+        });
+      } else {
+        classTemplate.attributes.push(attribute);
+      }
+    }
   }
 }
 

diff --git a/packages/analyzer/package.json b/packages/analyzer/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@custom-elements-manifest/analyzer",
-  "version": "0.9.8",
+  "version": "0.9.9",
   "description": "",
   "license": "MIT",
   "type": "module",