eslint-plugin-jsdoc - npm Package Compare versions

Comparing version 48.8.2 to 48.8.3

package.json

@@ -147,3 +147,3 @@ {
   },
-  "version": "48.8.2"
+  "version": "48.8.3"
 }

src/rules/checkTemplateNames.js

@@ -67,24 +67,37 @@ import {
 
-  const potentialType = typedefTags[0].type;
+  /**
+   * @param {string} potentialType
+   */
+  const checkForUsedTypes = (potentialType) => {
+    let parsedType;
+    try {
+      parsedType = mode === 'permissive' ?
+        tryParseType(/** @type {string} */ (potentialType)) :
+        parseType(/** @type {string} */ (potentialType), mode);
+    } catch {
+      return;
+    }
 
-  let parsedType;
-  try {
-    parsedType = mode === 'permissive' ?
-      tryParseType(/** @type {string} */ (potentialType)) :
-      parseType(/** @type {string} */ (potentialType), mode)
-  } catch {
-    // Todo: Should handle types in @prop/erty
-    return;
+    traverse(parsedType, (nde) => {
+      const {
+        type,
+        value,
+      } = /** @type {import('jsdoc-type-pratt-parser').NameResult} */ (nde);
+      if (type === 'JsdocTypeName' && (/^[A-Z]$/).test(value)) {
+        usedNames.add(value);
+      }
+    });
+  };
+
+  const potentialTypedefType = typedefTags[0].type;
+  checkForUsedTypes(potentialTypedefType);
+
+  const tagName = /** @type {string} */ (utils.getPreferredTagName({
+    tagName: 'property',
+  }));
+  const propertyTags = utils.getTags(tagName);
+  for (const propertyTag of propertyTags) {
+    checkForUsedTypes(propertyTag.type);
   }
 
-  traverse(parsedType, (nde) => {
-    const {
-      type,
-      value,
-    } = /** @type {import('jsdoc-type-pratt-parser').NameResult} */ (nde);
-    if (type === 'JsdocTypeName' && (/^[A-Z]$/).test(value)) {
-      usedNames.add(value);
-    }
-  });
-
   for (const tag of templateTags) {
@@ -91,0 +104,0 @@ const {name} = tag;

src/rules/requireTemplate.js

@@ -78,28 +78,46 @@ import {
 
-  const potentialType = typedefTags[0].type;
+  const usedNameToTag = new Map();
 
-  let parsedType;
-  try {
-    parsedType = mode === 'permissive' ?
-      tryParseType(/** @type {string} */ (potentialType)) :
-      parseType(/** @type {string} */ (potentialType), mode)
-  } catch {
-    // Todo: Should handle types in @prop/erty
-    return;
+  /**
+   * @param {import('comment-parser').Spec} potentialTag
+   */
+  const checkForUsedTypes = (potentialTag) => {
+    let parsedType;
+    try {
+      parsedType = mode === 'permissive' ?
+        tryParseType(/** @type {string} */ (potentialTag.type)) :
+        parseType(/** @type {string} */ (potentialTag.type), mode)
+    } catch {
+      return;
+    }
+
+    traverse(parsedType, (nde) => {
+      const {
+        type,
+        value,
+      } = /** @type {import('jsdoc-type-pratt-parser').NameResult} */ (nde);
+      if (type === 'JsdocTypeName' && (/^[A-Z]$/).test(value)) {
+        usedNames.add(value);
+        if (!usedNameToTag.has(value)) {
+          usedNameToTag.set(value, potentialTag);
+        }
+      }
+    });
+  };
+
+  const potentialTypedef = typedefTags[0];
+  checkForUsedTypes(potentialTypedef);
+
+  const tagName = /** @type {string} */ (utils.getPreferredTagName({
+    tagName: 'property',
+  }));
+  const propertyTags = utils.getTags(tagName);
+  for (const propertyTag of propertyTags) {
+    checkForUsedTypes(propertyTag);
   }
 
-  traverse(parsedType, (nde) => {
-    const {
-      type,
-      value,
-    } = /** @type {import('jsdoc-type-pratt-parser').NameResult} */ (nde);
-    if (type === 'JsdocTypeName' && (/^[A-Z]$/).test(value)) {
-      usedNames.add(value);
-    }
-  });
-
   // Could check against whitelist/blacklist
   for (const usedName of usedNames) {
     if (!templateNames.includes(usedName)) {
-      report(`Missing @template ${usedName}`, null, typedefTags[0]);
+      report(`Missing @template ${usedName}`, null, usedNameToTag.get(usedName));
     }
@@ -106,0 +124,0 @@ }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1938940

increased by0.2%

Lines of code

31831

increased by0.18%

No dependency changes