eslint-plugin-jsdoc 61.5.0 → 61.7.1

package/src/rules/checkPropertyNames.js

@@ -12,34 +12,50 @@ const validatePropertyNames = (
   enableFixer,
   jsdoc, utils,
 ) => {
-  const propertyTags = Object.entries(jsdoc.tags).filter(([
-    , tag,
-  ]) => {
-    return tag.tag === targetTagName;
-  });
+  const jsdocTypedefs = utils.getJsdocTagsDeep('typedef');
+  let propertyTagGroups;
+  if (jsdocTypedefs && jsdocTypedefs.length > 1) {
+    propertyTagGroups = jsdocTypedefs.map(({
+      idx,
+    }, index) => {
+      return Object.entries(jsdoc.tags).slice(idx, jsdocTypedefs[index + 1]?.idx);
+    });
+  } else {
+    propertyTagGroups = [
+      Object.entries(jsdoc.tags),
+    ];
+  }
 
-  return propertyTags.some(([
-    , tag,
-  ], index) => {
-    /** @type {import('../iterateJsdoc.js').Integer} */
-    let tagsIndex;
-    const dupeTagInfo = propertyTags.find(([
-      tgsIndex,
-      tg,
-    ], idx) => {
-      tagsIndex = Number(tgsIndex);
-
-      return tg.name === tag.name && idx !== index;
+  return propertyTagGroups.some((propertyTagGroup) => {
+    const propertyTags = propertyTagGroup.filter(([
+      , tag,
+    ]) => {
+      return tag.tag === targetTagName;
     });
-    if (dupeTagInfo) {
-      utils.reportJSDoc(`Duplicate @${targetTagName} "${tag.name}"`, dupeTagInfo[1], enableFixer ? () => {
-        utils.removeTag(tagsIndex);
-      } : null);
 
-      return true;
-    }
+    return propertyTags.some(([
+      , tag,
+    ], index) => {
+      /** @type {import('../iterateJsdoc.js').Integer} */
+      let tagsIndex;
+      const dupeTagInfo = propertyTags.find(([
+        tgsIndex,
+        tg,
+      ], idx) => {
+        tagsIndex = Number(tgsIndex);
+
+        return tg.name === tag.name && idx !== index;
+      });
+      if (dupeTagInfo) {
+        utils.reportJSDoc(`Duplicate @${targetTagName} "${tag.name}"`, dupeTagInfo[1], enableFixer ? () => {
+          utils.removeTag(tagsIndex);
+        } : null);
 
-    return false;
+        return true;
+      }
+
+      return false;
+    });
   });
 };
 

package/src/rules/convertToJsdocComments.js

@@ -111,7 +111,6 @@ export default {
 
         const decorator = getDecorator(
           /** @type {import('eslint').Rule.Node} */
-          // @ts-expect-error Bug?
           (baseNode),
         );
         if (decorator) {
@@ -204,7 +203,6 @@ export default {
       reportingNonJsdoc = true;
 
       /** @type {AddComment} */
-      // eslint-disable-next-line unicorn/consistent-function-scoping -- Avoid conflicts
       const addComment = (inlineCommentBlock, commentToAdd, indent, lines, fixer) => {
         const insertion = (
           inlineCommentBlock || enforceJsdocLineStyle === 'single' ?

package/src/rules/requireJsdoc.js

@@ -36,6 +36,13 @@ const OPTIONS_SCHEMA = {
   additionalProperties: false,
   description: 'Has the following optional keys.\n',
   properties: {
+    checkAllFunctionExpressions: {
+      default: false,
+      description: `Normally, when \`FunctionExpression\` is checked, additional checks are
+added to check the parent contexts where reporting is likely to be desired. If you really
+want to check *all* function expressions, then set this to \`true\`.`,
+      type: 'boolean',
+    },
     checkConstructors: {
       default: true,
       description: `A value indicating whether \`constructor\`s should be checked. Defaults to
@@ -378,6 +385,7 @@ const getOption = (context, baseObject, option, key) => {
  * @param {import('eslint').Rule.RuleContext} context
  * @param {import('../iterateJsdoc.js').Settings} settings
  * @returns {{
+ *   checkAllFunctionExpressions: boolean,
  *   contexts: (string|{
  *     context: string,
  *     inlineCommentBlock: boolean,
@@ -396,6 +404,7 @@ const getOption = (context, baseObject, option, key) => {
  */
 const getOptions = (context, settings) => {
   const {
+    checkAllFunctionExpressions = false,
     contexts = settings.contexts || [],
     enableFixer = true,
     exemptEmptyConstructors = true,
@@ -408,6 +417,7 @@ const getOptions = (context, settings) => {
   } = context.options[0] || {};
 
   return {
+    checkAllFunctionExpressions,
     contexts,
     enableFixer,
     exemptEmptyConstructors,
@@ -503,7 +513,7 @@ const isFunctionWithOverload = (node) => {
     return false;
   }
 
-  const functionName = node.id.name;
+  const functionName = node.id?.name;
 
   const idx = parent.body.indexOf(child);
   const prevSibling = parent.body[idx - 1];
@@ -536,6 +546,7 @@ export default {
     const opts = getOptions(context, settings);
 
     const {
+      checkAllFunctionExpressions,
       contexts,
       enableFixer,
       exemptEmptyConstructors,
@@ -670,7 +681,6 @@ export default {
 
         const decorator = getDecorator(
           /** @type {import('eslint').Rule.Node} */
-          // @ts-expect-error Bug?
           (baseNode),
         );
         if (decorator) {
@@ -831,7 +841,7 @@ export default {
           return;
         }
 
-        if (
+        if (checkAllFunctionExpressions ||
           [
             'AssignmentExpression', 'ExportDefaultDeclaration', 'VariableDeclarator',
           ].includes(node.parent.type) ||

package/src/rules.d.ts

@@ -1639,6 +1639,12 @@ export interface Rules {
     | []
     | [
         {
+          /**
+           * Normally, when `FunctionExpression` is checked, additional checks are
+           * added to check the parent contexts where reporting is likely to be desired. If you really
+           * want to check *all* function expressions, then set this to `true`.
+           */
+          checkAllFunctionExpressions?: boolean;
           /**
            * A value indicating whether `constructor`s should be checked. Defaults to
            * `true`. When `true`, `exemptEmptyConstructors` may still avoid reporting when