eslint-plugin-jsdoc 39.3.6 → 39.3.13

package/dist/iterateJsdoc.js

@@ -11,19 +11,16 @@ Object.defineProperty(exports, "parseComment", {
     return _jsdoccomment.parseComment;
   }
 });
-
 var _jsdoccomment = require("@es-joy/jsdoccomment");
-
 var _commentParser = require("comment-parser");
-
 var _jsdocUtils = _interopRequireDefault(require("./jsdocUtils"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const {
   rewireSpecs,
   seedTokens
-} = _commentParser.util; // todo: Change these `any` types once importing types properly.
+} = _commentParser.util;
+
+// todo: Change these `any` types once importing types properly.
 
 /**
  * Should use ESLint rule's typing.
@@ -52,13 +49,11 @@ const {
 */
 
 const globalState = new Map();
-
 const getBasicUtils = (context, {
   tagNamePreference,
   mode
 }) => {
   const utils = {};
-
   utils.reportSettings = message => {
     context.report({
       loc: {
@@ -70,33 +65,25 @@ const getBasicUtils = (context, {
       message
     });
   };
-
   utils.parseClosureTemplateTag = tag => {
     return _jsdocUtils.default.parseClosureTemplateTag(tag);
   };
-
   utils.pathDoesNotBeginWith = _jsdocUtils.default.pathDoesNotBeginWith;
-
   utils.getPreferredTagNameObject = ({
     tagName
   }) => {
     const ret = _jsdocUtils.default.getPreferredTagName(context, mode, tagName, tagNamePreference);
-
     const isObject = ret && typeof ret === 'object';
-
     if (ret === false || isObject && !ret.replacement) {
       return {
         blocked: true,
         tagName
       };
     }
-
     return ret;
   };
-
   return utils;
 };
-
 const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAll, ruleConfig, indent) => {
   const ancestors = context.getAncestors();
   const sourceCode = context.getSourceCode();
@@ -111,19 +98,15 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
     minLines,
     mode
   } = settings;
-
   utils.isIteratingFunction = () => {
     return !iteratingAll || ['MethodDefinition', 'ArrowFunctionExpression', 'FunctionDeclaration', 'FunctionExpression'].includes(node && node.type);
   };
-
   utils.isVirtualFunction = () => {
     return iteratingAll && utils.hasATag(['callback', 'function', 'func', 'method']);
   };
-
   utils.stringify = (tagBlock, specRewire) => {
     return (0, _commentParser.stringify)(specRewire ? rewireSpecs(tagBlock) : tagBlock);
   };
-
   utils.reportJSDoc = (msg, tag, handler, specRewire, data) => {
     report(msg, handler ? fixer => {
       handler();
@@ -131,11 +114,9 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
       return fixer.replaceText(jsdocNode, replacement);
     } : null, tag, data);
   };
-
   utils.getRegexFromString = (str, requiredFlags) => {
     return _jsdocUtils.default.getRegexFromString(str, requiredFlags);
   };
-
   utils.getTagDescription = tg => {
     const descriptions = [];
     tg.source.some(({
@@ -150,23 +131,21 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
         description
       }
     }) => {
-      const desc = (tag && postTag || !tag && !name && !type && postDelimiter || '' // Remove space
-      ).slice(1) + (description || '') + (lineEnd || '');
+      const desc = (tag && postTag || !tag && !name && !type && postDelimiter || ''
 
+      // Remove space
+      ).slice(1) + (description || '') + (lineEnd || '');
       if (end) {
         if (desc) {
           descriptions.push(desc);
         }
-
         return true;
       }
-
       descriptions.push(desc);
       return false;
     });
     return descriptions.join('\n');
   };
-
   utils.getDescription = () => {
     const descriptions = [];
     let lastDescriptionLine = 0;
@@ -181,11 +160,9 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
         lastDescriptionLine = idx - 1;
         return true;
       }
-
       if (idx || description) {
         descriptions.push(description || (descriptions.length ? '' : '\n'));
       }
-
       return false;
     });
     return {
@@ -193,15 +170,14 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
       lastDescriptionLine
     };
   };
-
   utils.changeTag = (tag, ...tokens) => {
     for (const [idx, src] of tag.source.entries()) {
-      src.tokens = { ...src.tokens,
+      src.tokens = {
+        ...src.tokens,
         ...tokens[idx]
       };
     }
   };
-
   utils.setTag = (tag, tokens) => {
     tag.source = [{
       // Or tag.source[0].number?
@@ -215,11 +191,9 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
       })
     }];
   };
-
   utils.removeTag = idx => {
     return utils.removeTagItem(idx);
   };
-
   utils.removeTagItem = (tagIndex, tagSourceOffset = 0) => {
     const {
       source: tagSource
@@ -236,8 +210,8 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
         }
       }) => {
         return number === srcNumber && !end;
-      }); // istanbul ignore else
-
+      });
+      // istanbul ignore else
       if (sourceIndex > -1) {
         let spliceCount = 1;
         tagSource.slice(tagIdx + 1).some(({
@@ -250,30 +224,28 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
             spliceCount++;
             return false;
           }
-
           return true;
         });
         jsdoc.source.splice(sourceIndex + tagSourceOffset, spliceCount - tagSourceOffset);
         tagSource.splice(tagIdx + tagSourceOffset, spliceCount - tagSourceOffset);
         lastIndex = sourceIndex;
         return true;
-      } // istanbul ignore next
-
+      }
 
+      // istanbul ignore next
       return false;
     });
-
     for (const [idx, src] of jsdoc.source.slice(lastIndex).entries()) {
       src.number = firstNumber + lastIndex + idx;
-    } // Todo: Once rewiring of tags may be fixed in comment-parser to reflect missing tags,
+    }
+
+    // Todo: Once rewiring of tags may be fixed in comment-parser to reflect missing tags,
     //         this step should be added here (so that, e.g., if accessing `jsdoc.tags`,
     //         such as to add a new tag, the correct information will be available)
-
   };
 
   utils.addTag = (targetTagName, number = ((() => {
     var _jsdoc$tags, _jsdoc$tags$source$;
-
     return (_jsdoc$tags = jsdoc.tags[jsdoc.tags.length - 1]) === null || _jsdoc$tags === void 0 ? void 0 : (_jsdoc$tags$source$ = _jsdoc$tags.source[0]) === null || _jsdoc$tags$source$ === void 0 ? void 0 : _jsdoc$tags$source$.number;
   })() ?? jsdoc.source.findIndex(({
     tokens: {
@@ -293,15 +265,12 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
         ...tokens
       })
     });
-
     for (const src of jsdoc.source.slice(number + 1)) {
       src.number++;
     }
   };
-
   utils.getFirstLine = () => {
     let firstLine;
-
     for (const {
       number,
       tokens: {
@@ -313,33 +282,27 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
         break;
       }
     }
-
     return firstLine;
   };
-
   utils.seedTokens = seedTokens;
-
   utils.emptyTokens = tokens => {
     for (const prop of ['start', 'postDelimiter', 'tag', 'type', 'postType', 'postTag', 'name', 'postName', 'description', 'end', 'lineEnd']) {
       tokens[prop] = '';
     }
   };
-
   utils.addLine = (sourceIndex, tokens) => {
     var _jsdoc$source;
-
     const number = (((_jsdoc$source = jsdoc.source[sourceIndex - 1]) === null || _jsdoc$source === void 0 ? void 0 : _jsdoc$source.number) || 0) + 1;
     jsdoc.source.splice(sourceIndex, 0, {
       number,
       source: '',
       tokens: seedTokens(tokens)
     });
-
     for (const src of jsdoc.source.slice(number + 1)) {
       src.number++;
-    } // If necessary, we can rewire the tags (misnamed method)
+    }
+    // If necessary, we can rewire the tags (misnamed method)
     // rewireSource(jsdoc);
-
   };
 
   utils.addLines = (tagIndex, tagSourceOffset, numLines) => {
@@ -361,13 +324,11 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
           })
         };
       };
-
       const makeLines = () => {
         return Array.from({
           length: numLines
         }, makeLine);
       };
-
       const sourceIndex = jsdoc.source.findIndex(({
         number: srcNumber,
         tokens: {
@@ -375,25 +336,24 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
         }
       }) => {
         return number === srcNumber && !end;
-      }); // istanbul ignore else
-
+      });
+      // istanbul ignore else
       if (sourceIndex > -1) {
         const lines = makeLines();
-        jsdoc.source.splice(sourceIndex + tagSourceOffset, 0, ...lines); // tagSource.splice(tagIdx + 1, 0, ...makeLines());
+        jsdoc.source.splice(sourceIndex + tagSourceOffset, 0, ...lines);
 
+        // tagSource.splice(tagIdx + 1, 0, ...makeLines());
         lastIndex = sourceIndex;
         return true;
-      } // istanbul ignore next
-
+      }
 
+      // istanbul ignore next
       return false;
     });
-
     for (const [idx, src] of jsdoc.source.slice(lastIndex).entries()) {
       src.number = firstNumber + lastIndex + idx;
     }
   };
-
   utils.makeMultiline = () => {
     const {
       source: [{
@@ -414,20 +374,19 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
         postTag,
         postType
       }
-    } = jsdoc.source[0]; // Strip trailing leftovers from single line ending
+    } = jsdoc.source[0];
 
+    // Strip trailing leftovers from single line ending
     if (!description) {
       if (postName) {
         postName = '';
       } else if (postType) {
-        postType = ''; // eslint-disable-next-line no-inline-comments
-      } else
-        /* istanbul ignore else -- `comment-parser` prevents empty blocks currently per https://github.com/syavorsky/comment-parser/issues/128 */
-        if (postTag) {
+        postType = '';
+        // eslint-disable-next-line no-inline-comments
+      } else /* istanbul ignore else -- `comment-parser` prevents empty blocks currently per https://github.com/syavorsky/comment-parser/issues/128 */if (postTag) {
           postTag = '';
         }
     }
-
     utils.emptyTokens(tokens);
     utils.addLine(1, {
       delimiter: '*',
@@ -449,39 +408,30 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
       start: indent + ' '
     });
   };
-
   utils.flattenRoots = params => {
     return _jsdocUtils.default.flattenRoots(params);
   };
-
   utils.getFunctionParameterNames = useDefaultObjectProperties => {
     return _jsdocUtils.default.getFunctionParameterNames(node, useDefaultObjectProperties);
   };
-
   utils.hasParams = () => {
     return _jsdocUtils.default.hasParams(node);
   };
-
   utils.isGenerator = () => {
     return node && (node.generator || node.type === 'MethodDefinition' && node.value.generator || ['ExportNamedDeclaration', 'ExportDefaultDeclaration'].includes(node.type) && node.declaration.generator);
   };
-
   utils.isConstructor = () => {
     return _jsdocUtils.default.isConstructor(node);
   };
-
   utils.getJsdocTagsDeep = tagName => {
     const name = utils.getPreferredTagName({
       tagName
     });
-
     if (!name) {
       return false;
     }
-
     return _jsdocUtils.default.getJsdocTagsDeep(jsdoc, name);
   };
-
   utils.getPreferredTagName = ({
     tagName,
     skipReportingBlockedTag = false,
@@ -489,9 +439,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
     defaultMessage = `Unexpected tag \`@${tagName}\``
   }) => {
     const ret = _jsdocUtils.default.getPreferredTagName(context, mode, tagName, tagNamePreference);
-
     const isObject = ret && typeof ret === 'object';
-
     if (utils.hasTag(tagName) && (ret === false || isObject && !ret.replacement)) {
       if (skipReportingBlockedTag) {
         return {
@@ -499,67 +447,50 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
           tagName
         };
       }
-
       const message = isObject && ret.message || defaultMessage;
       report(message, null, utils.getTags(tagName)[0]);
       return false;
     }
-
     return isObject && !allowObjectReturn ? ret.replacement : ret;
   };
-
   utils.isValidTag = (name, definedTags) => {
     return _jsdocUtils.default.isValidTag(context, mode, name, definedTags);
   };
-
   utils.hasATag = names => {
     return _jsdocUtils.default.hasATag(jsdoc, names);
   };
-
   utils.hasTag = name => {
     return _jsdocUtils.default.hasTag(jsdoc, name);
   };
-
   utils.comparePaths = name => {
     return _jsdocUtils.default.comparePaths(name);
   };
-
   utils.dropPathSegmentQuotes = name => {
     return _jsdocUtils.default.dropPathSegmentQuotes(name);
   };
-
   utils.avoidDocs = () => {
     var _context$options$;
-
     if (ignoreReplacesDocs !== false && (utils.hasTag('ignore') || utils.classHasTag('ignore')) || overrideReplacesDocs !== false && (utils.hasTag('override') || utils.classHasTag('override')) || implementsReplacesDocs !== false && (utils.hasTag('implements') || utils.classHasTag('implements')) || augmentsExtendsReplacesDocs && (utils.hasATag(['augments', 'extends']) || utils.classHasTag('augments') || utils.classHasTag('extends'))) {
       return true;
     }
-
     if (_jsdocUtils.default.exemptSpeciaMethods(jsdoc, node, context, ruleConfig.meta.schema)) {
       return true;
     }
-
     const exemptedBy = ((_context$options$ = context.options[0]) === null || _context$options$ === void 0 ? void 0 : _context$options$.exemptedBy) ?? ['inheritDoc', ...(mode === 'closure' ? [] : ['inheritdoc'])];
-
     if (exemptedBy.length && utils.getPresentTags(exemptedBy).length) {
       return true;
     }
-
     return false;
   };
-
   for (const method of ['tagMightHaveNamePosition', 'tagMightHaveTypePosition']) {
     utils[method] = (tagName, otherModeMaps) => {
       const result = _jsdocUtils.default[method](tagName);
-
       if (result) {
         return true;
       }
-
       if (!otherModeMaps) {
         return false;
       }
-
       const otherResult = otherModeMaps.some(otherModeMap => {
         return _jsdocUtils.default[method](tagName, otherModeMap);
       });
@@ -568,15 +499,14 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
       } : false;
     };
   }
-
   for (const method of ['tagMustHaveNamePosition', 'tagMustHaveTypePosition', 'tagMissingRequiredTypeOrNamepath']) {
     utils[method] = (tagName, otherModeMaps) => {
       const result = _jsdocUtils.default[method](tagName);
-
       if (!result) {
         return false;
-      } // if (!otherModeMaps) { return true; }
+      }
 
+      // if (!otherModeMaps) { return true; }
 
       const otherResult = otherModeMaps.every(otherModeMap => {
         return _jsdocUtils.default[method](tagName, otherModeMap);
@@ -586,129 +516,101 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
       };
     };
   }
-
   for (const method of ['isNamepathDefiningTag', 'tagMightHaveNamepath']) {
     utils[method] = tagName => {
       return _jsdocUtils.default[method](tagName);
     };
   }
-
   utils.getTagStructureForMode = mde => {
     return _jsdocUtils.default.getTagStructureForMode(mde, settings.structuredTags);
   };
-
   utils.hasDefinedTypeTag = tag => {
     return _jsdocUtils.default.hasDefinedTypeTag(tag);
   };
-
   utils.hasValueOrExecutorHasNonEmptyResolveValue = anyPromiseAsReturn => {
     return _jsdocUtils.default.hasValueOrExecutorHasNonEmptyResolveValue(node, anyPromiseAsReturn);
   };
-
   utils.hasYieldValue = () => {
     if (['ExportNamedDeclaration', 'ExportDefaultDeclaration'].includes(node.type)) {
       return _jsdocUtils.default.hasYieldValue(node.declaration);
     }
-
     return _jsdocUtils.default.hasYieldValue(node);
   };
-
   utils.hasYieldReturnValue = () => {
     return _jsdocUtils.default.hasYieldValue(node, true);
   };
-
   utils.hasThrowValue = () => {
     return _jsdocUtils.default.hasThrowValue(node);
   };
-
   utils.isAsync = () => {
     return node.async;
   };
-
   utils.getTags = tagName => {
     return utils.filterTags(item => {
       return item.tag === tagName;
     });
   };
-
   utils.getPresentTags = tagList => {
     return utils.filterTags(tag => {
       return tagList.includes(tag.tag);
     });
   };
-
   utils.filterTags = filter => {
     return _jsdocUtils.default.filterTags(jsdoc.tags, filter);
   };
-
   utils.getTagsByType = tags => {
     return _jsdocUtils.default.getTagsByType(context, mode, tags, tagNamePreference);
   };
-
   utils.hasOptionTag = tagName => {
     const {
       tags
     } = context.options[0] ?? {};
     return Boolean(tags && tags.includes(tagName));
   };
-
   utils.getClassNode = () => {
     return [...ancestors, node].reverse().find(parent => {
       return parent && ['ClassDeclaration', 'ClassExpression'].includes(parent.type);
     }) || null;
   };
-
   utils.getClassJsdoc = () => {
     const classNode = utils.getClassNode();
-
     if (!classNode) {
       return null;
     }
-
     const classJsdocNode = (0, _jsdoccomment.getJSDocComment)(sourceCode, classNode, {
       maxLines,
       minLines
     });
-
     if (classJsdocNode) {
       return (0, _jsdoccomment.parseComment)(classJsdocNode, '');
     }
-
     return null;
   };
-
   utils.classHasTag = tagName => {
     const classJsdoc = utils.getClassJsdoc();
     return Boolean(classJsdoc) && _jsdocUtils.default.hasTag(classJsdoc, tagName);
   };
-
   utils.forEachPreferredTag = (tagName, arrayHandler, skipReportingBlockedTag = false) => {
     const targetTagName = utils.getPreferredTagName({
       skipReportingBlockedTag,
       tagName
     });
-
     if (!targetTagName || skipReportingBlockedTag && targetTagName && typeof targetTagName === 'object') {
       return;
     }
-
     const matchingJsdocTags = jsdoc.tags.filter(({
       tag
     }) => {
       return tag === targetTagName;
     });
-
     for (const matchingJsdocTag of matchingJsdocTags) {
       arrayHandler(matchingJsdocTag, targetTagName);
     }
   };
-
   return utils;
 };
-
 const getSettings = context => {
   var _context$settings$jsd, _context$settings$jsd2, _context$settings$jsd3, _context$settings$jsd4, _context$settings$jsd5, _context$settings$jsd6, _context$settings$jsd7, _context$settings$jsd8, _context$settings$jsd9, _context$settings$jsd10, _context$settings$jsd11, _context$settings$jsd12;
-
   /* eslint-disable canonical/sort-keys */
   const settings = {
     // All rules
@@ -734,7 +636,6 @@ const getSettings = context => {
   /* eslint-enable canonical/sort-keys */
 
   _jsdocUtils.default.setTagStructure(settings.mode);
-
   try {
     _jsdocUtils.default.overrideTagStructure(settings.structuredTags);
   } catch (error) {
@@ -749,28 +650,23 @@ const getSettings = context => {
     });
     return false;
   }
-
   return settings;
 };
+
 /**
  * Create the report function
  *
  * @param {object} context
  * @param {object} commentNode
  */
-
-
 exports.getSettings = getSettings;
-
 const makeReport = (context, commentNode) => {
   const report = (message, fix = null, jsdocLoc = null, data = null) => {
     let loc;
-
     if (jsdocLoc) {
       if (!('line' in jsdocLoc)) {
         jsdocLoc.line = jsdocLoc.source[0].number;
       }
-
       const lineNumber = commentNode.loc.start.line + jsdocLoc.line;
       loc = {
         end: {
@@ -781,16 +677,16 @@ const makeReport = (context, commentNode) => {
           column: 0,
           line: lineNumber
         }
-      }; // Todo: Remove ignore once `check-examples` can be restored for ESLint 8+
-      // istanbul ignore if
+      };
 
+      // Todo: Remove ignore once `check-examples` can be restored for ESLint 8+
+      // istanbul ignore if
       if (jsdocLoc.column) {
         const colNumber = commentNode.loc.start.column + jsdocLoc.column;
         loc.end.column = colNumber;
         loc.start.column = colNumber;
       }
     }
-
     context.report({
       data,
       fix,
@@ -799,11 +695,10 @@ const makeReport = (context, commentNode) => {
       node: commentNode
     });
   };
-
   return report;
 };
-/* eslint-disable jsdoc/no-undefined-types -- canonical still using an older version where not defined */
 
+/* eslint-disable jsdoc/no-undefined-types -- canonical still using an older version where not defined */
 /**
  * @typedef {ReturnType<typeof getUtils>} Utils
  * @typedef {ReturnType<typeof getSettings>} Settings
@@ -821,18 +716,14 @@ const makeReport = (context, commentNode) => {
  *   }
  * ) => any } JsdocVisitor
  */
-
 /* eslint-enable jsdoc/no-undefined-types -- canonical still using an older version where not defined */
 
-
 const iterate = (info, indent, jsdoc, ruleConfig, context, lines, jsdocNode, node, settings, sourceCode, iterator, state, iteratingAll) => {
   const report = makeReport(context, jsdocNode);
   const utils = getUtils(node, jsdoc, jsdocNode, settings, report, context, iteratingAll, ruleConfig, indent);
-
   if (!ruleConfig.checkInternal && settings.ignoreInternal && utils.hasTag('internal')) {
     return;
   }
-
   if (!ruleConfig.checkPrivate && settings.ignorePrivate && (utils.hasTag('private') || jsdoc.tags.filter(({
     tag
   }) => {
@@ -844,7 +735,6 @@ const iterate = (info, indent, jsdoc, ruleConfig, context, lines, jsdocNode, nod
   }))) {
     return;
   }
-
   iterator({
     context,
     globalState,
@@ -861,13 +751,13 @@ const iterate = (info, indent, jsdoc, ruleConfig, context, lines, jsdocNode, nod
     utils
   });
 };
-
 const getIndentAndJSDoc = function (lines, jsdocNode) {
   const sourceLine = lines[jsdocNode.loc.start.line - 1];
   const indnt = sourceLine.charAt(0).repeat(jsdocNode.loc.start.column);
   const jsdc = (0, _jsdoccomment.parseComment)(jsdocNode, '');
   return [indnt, jsdc];
 };
+
 /**
  *
  * @typedef {{node: Node, state: StateObject}} NonCommentArgs
@@ -904,27 +794,21 @@ const getIndentAndJSDoc = function (lines, jsdocNode) {
  *   iteration for each matching comment context. Otherwise, will iterate
  *   once if there is a single matching comment context.
  */
-
-
 const iterateAllJsdocs = (iterator, ruleConfig, contexts, additiveCommentContexts) => {
   const trackedJsdocs = new Set();
   let handler;
   let settings;
-
   const callIterator = (context, node, jsdocNodes, state, lastCall) => {
     const sourceCode = context.getSourceCode();
     const {
       lines
     } = sourceCode;
     const utils = getBasicUtils(context, settings);
-
     for (const jsdocNode of jsdocNodes) {
       if (!/^\/\*\*\s/u.test(sourceCode.getText(jsdocNode))) {
         continue;
       }
-
       const [indent, jsdoc] = getIndentAndJSDoc(lines, jsdocNode);
-
       if (additiveCommentContexts) {
         for (const [idx, {
           comment
@@ -932,20 +816,17 @@ const iterateAllJsdocs = (iterator, ruleConfig, contexts, additiveCommentContext
           if (comment && handler(comment, jsdoc) === false) {
             continue;
           }
-
           iterate({
             comment,
             lastIndex: idx,
             selector: node === null || node === void 0 ? void 0 : node.type
           }, indent, jsdoc, ruleConfig, context, lines, jsdocNode, node, settings, sourceCode, iterator, state, true);
         }
-
         continue;
       }
-
       let lastComment;
-      let lastIndex; // eslint-disable-next-line no-loop-func
-
+      let lastIndex;
+      // eslint-disable-next-line no-loop-func
       if (contexts && contexts.every(({
         comment
       }, idx) => {
@@ -955,7 +836,6 @@ const iterateAllJsdocs = (iterator, ruleConfig, contexts, additiveCommentContext
       })) {
         continue;
       }
-
       iterate(lastComment ? {
         comment: lastComment,
         lastIndex,
@@ -965,7 +845,6 @@ const iterateAllJsdocs = (iterator, ruleConfig, contexts, additiveCommentContext
         selector: node === null || node === void 0 ? void 0 : node.type
       }, indent, jsdoc, ruleConfig, context, lines, jsdocNode, node, settings, sourceCode, iterator, state, true);
     }
-
     if (lastCall && ruleConfig.exit) {
       ruleConfig.exit({
         context,
@@ -974,35 +853,27 @@ const iterateAllJsdocs = (iterator, ruleConfig, contexts, additiveCommentContext
       });
     }
   };
-
   return {
     create(context) {
       const sourceCode = context.getSourceCode();
       settings = getSettings(context);
-
       if (!settings) {
         return {};
       }
-
       if (contexts) {
         handler = (0, _jsdoccomment.commentHandler)(settings);
       }
-
       const state = {};
       return {
         '*:not(Program)'(node) {
           const reducedNode = (0, _jsdoccomment.getReducedASTNode)(node, sourceCode);
-
           if (node !== reducedNode) {
             return;
           }
-
           const commentNode = (0, _jsdoccomment.getJSDocComment)(sourceCode, node, settings);
-
           if (trackedJsdocs.has(commentNode)) {
             return;
           }
-
           if (!commentNode) {
             if (ruleConfig.nonComment) {
               ruleConfig.nonComment({
@@ -1010,14 +881,11 @@ const iterateAllJsdocs = (iterator, ruleConfig, contexts, additiveCommentContext
                 state
               });
             }
-
             return;
           }
-
           trackedJsdocs.add(commentNode);
           callIterator(context, node, [commentNode], state);
         },
-
         'Program:exit'() {
           const allComments = sourceCode.getAllComments();
           const untrackedJSdoc = allComments.filter(node => {
@@ -1025,13 +893,12 @@ const iterateAllJsdocs = (iterator, ruleConfig, contexts, additiveCommentContext
           });
           callIterator(context, null, untrackedJSdoc, state, true);
         }
-
       };
     },
-
     meta: ruleConfig.meta
   };
 };
+
 /**
  * Create an eslint rule that iterates over all JSDocs, regardless of whether
  * they are attached to a function-like node.
@@ -1039,18 +906,14 @@ const iterateAllJsdocs = (iterator, ruleConfig, contexts, additiveCommentContext
  * @param {JsdocVisitor} iterator
  * @param {RuleConfig} ruleConfig
  */
-
-
 const checkFile = (iterator, ruleConfig) => {
   return {
     create(context) {
       const sourceCode = context.getSourceCode();
       const settings = getSettings(context);
-
       if (!settings) {
         return {};
       }
-
       return {
         'Program:exit'() {
           const allComments = sourceCode.getAllComments();
@@ -1068,39 +931,30 @@ const checkFile = (iterator, ruleConfig) => {
             utils
           });
         }
-
       };
     },
-
     meta: ruleConfig.meta
   };
 };
-
 /**
  * @param {JsdocVisitor} iterator
  * @param {RuleConfig} ruleConfig
  */
 function iterateJsdoc(iterator, ruleConfig) {
   var _ruleConfig$meta;
-
   const metaType = ruleConfig === null || ruleConfig === void 0 ? void 0 : (_ruleConfig$meta = ruleConfig.meta) === null || _ruleConfig$meta === void 0 ? void 0 : _ruleConfig$meta.type;
-
   if (!metaType || !['problem', 'suggestion', 'layout'].includes(metaType)) {
     throw new TypeError('Rule must include `meta.type` option (with value "problem", "suggestion", or "layout")');
   }
-
   if (typeof iterator !== 'function') {
     throw new TypeError('The iterator argument must be a function.');
   }
-
   if (ruleConfig.checkFile) {
     return checkFile(iterator, ruleConfig);
   }
-
   if (ruleConfig.iterateAllJsdocs) {
     return iterateAllJsdocs(iterator, ruleConfig);
   }
-
   return {
     /**
      * The entrypoint for the JSDoc rule.
@@ -1113,67 +967,53 @@ function iterateJsdoc(iterator, ruleConfig) {
      */
     create(context) {
       const settings = getSettings(context);
-
       if (!settings) {
         return {};
       }
-
       let contexts;
-
       if (ruleConfig.contextDefaults || ruleConfig.contextSelected || ruleConfig.matchContext) {
         var _context$options$2, _contexts, _contexts2;
-
         contexts = ruleConfig.matchContext && (_context$options$2 = context.options[0]) !== null && _context$options$2 !== void 0 && _context$options$2.match ? context.options[0].match : _jsdocUtils.default.enforcedContexts(context, ruleConfig.contextDefaults);
-
         if (contexts) {
           contexts = contexts.map(obj => {
             if (typeof obj === 'object' && !obj.context) {
-              return { ...obj,
+              return {
+                ...obj,
                 context: 'any'
               };
             }
-
             return obj;
           });
         }
-
         const hasPlainAny = (_contexts = contexts) === null || _contexts === void 0 ? void 0 : _contexts.includes('any');
         const hasObjectAny = !hasPlainAny && ((_contexts2 = contexts) === null || _contexts2 === void 0 ? void 0 : _contexts2.find(ctxt => {
           return (ctxt === null || ctxt === void 0 ? void 0 : ctxt.context) === 'any';
         }));
-
         if (hasPlainAny || hasObjectAny) {
           return iterateAllJsdocs(iterator, ruleConfig, hasObjectAny ? contexts : null, ruleConfig.matchContext).create(context);
         }
       }
-
       const sourceCode = context.getSourceCode();
       const {
         lines
       } = sourceCode;
       const state = {};
-
       const checkJsdoc = (info, handler, node) => {
         const jsdocNode = (0, _jsdoccomment.getJSDocComment)(sourceCode, node, settings);
-
         if (!jsdocNode) {
           return;
         }
-
         const [indent, jsdoc] = getIndentAndJSDoc(lines, jsdocNode);
-
-        if ( // Note, `handler` should already be bound in its first argument
+        if (
+        // Note, `handler` should already be bound in its first argument
         //  with these only to be called after the value of
         //  `comment`
         handler && handler(jsdoc) === false) {
           return;
         }
-
         iterate(info, indent, jsdoc, ruleConfig, context, lines, jsdocNode, node, settings, sourceCode, iterator, state);
       };
-
       let contextObject = {};
-
       if (contexts && (ruleConfig.contextDefaults || ruleConfig.contextSelected || ruleConfig.matchContext)) {
         contextObject = _jsdocUtils.default.getContextObject(contexts, checkJsdoc, (0, _jsdoccomment.commentHandler)(settings));
       } else {
@@ -1183,7 +1023,6 @@ function iterateJsdoc(iterator, ruleConfig) {
           }, null);
         }
       }
-
       if (ruleConfig.exit) {
         contextObject['Program:exit'] = () => {
           ruleConfig.exit({
@@ -1192,10 +1031,8 @@ function iterateJsdoc(iterator, ruleConfig) {
           });
         };
       }
-
       return contextObject;
     },
-
     meta: ruleConfig.meta
   };
 }