eslint-plugin-jsdoc 50.6.17 → 50.7.0

package/dist/iterateJsdoc.cjs

@@ -16,8 +16,7 @@ var _jsdoccomment = require("@es-joy/jsdoccomment");
 var _commentParser = require("comment-parser");
 var _esquery = _interopRequireDefault(require("esquery"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
 /**
  * @typedef {number} Integer
  */
@@ -602,8 +601,8 @@ const globalState = new Map();
  * @returns {BasicUtils}
  */
 const getBasicUtils = (context, {
-  tagNamePreference,
-  mode
+  mode,
+  tagNamePreference
 }) => {
   /** @type {BasicUtils} */
   const utils = {};
@@ -685,19 +684,19 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
   } = context;
   const utils = /** @type {Utils} */getBasicUtils(context, settings);
   const {
-    tagNamePreference,
-    overrideReplacesDocs,
+    augmentsExtendsReplacesDocs,
     ignoreReplacesDocs,
     implementsReplacesDocs,
-    augmentsExtendsReplacesDocs,
     maxLines,
     minLines,
-    mode
+    mode,
+    overrideReplacesDocs,
+    tagNamePreference
   } = settings;
 
   /** @type {IsIteratingFunction} */
   utils.isIteratingFunction = () => {
-    return !iteratingAll || ['MethodDefinition', 'ArrowFunctionExpression', 'FunctionDeclaration', 'FunctionExpression'].includes(String(node && node.type));
+    return !iteratingAll || ['ArrowFunctionExpression', 'FunctionDeclaration', 'FunctionExpression', 'MethodDefinition'].includes(String(node && node.type));
   };
 
   /** @type {IsVirtualFunction} */
@@ -711,7 +710,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
     if (specRewire) {
       block = rewireSpecs(tagBlock);
     }
-    return (0, _commentParser.stringify)( /** @type {import('comment-parser').Block} */
+    return (0, _commentParser.stringify)(/** @type {import('comment-parser').Block} */
     specRewire ? block : tagBlock);
   };
 
@@ -769,8 +768,8 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
     jsdoc.source.some(({
       tokens: {
         description,
-        tag,
-        end
+        end,
+        tag
       }
     }, idx) => {
       if (tag) {
@@ -818,12 +817,12 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
     let info;
     jsdoc.source.some(({
       tokens: {
-        description,
-        start,
         delimiter,
+        description,
+        end,
         postDelimiter,
-        tag,
-        end
+        start,
+        tag
       }
     }, idx) => {
       if (delimiter === '/**') {
@@ -847,7 +846,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
 
     /* c8 ignore else -- Won't be called if missing */
     if (descLines.length) {
-      jsdoc.source.splice( /** @type {Integer} */startIdx, /** @type {Integer} */endIdx - ( /** @type {Integer} */startIdx), ...setter(
+      jsdoc.source.splice(/** @type {Integer} */startIdx, /** @type {Integer} */endIdx - (/** @type {Integer} */startIdx), ...setter(
       /**
        * @type {{
        *   delimiter: string,
@@ -865,8 +864,8 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
     jsdoc.source.some(({
       tokens: {
         description,
-        tag,
-        end
+        end,
+        tag
       }
     }, idx) => {
       /* c8 ignore next 3 -- Already checked */
@@ -933,8 +932,8 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
         let spliceCount = 1;
         tagSource.slice(tagIdx + 1).some(({
           tokens: {
-            tag,
-            end: ending
+            end: ending,
+            tag
           }
         }) => {
           if (!tag && !ending) {
@@ -967,11 +966,12 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
         lastIndex = sourceIndex;
         return true;
       }
-      /* c8 ignore next */
+      /* c8 ignore next 2 */
+      // eslint-disable-next-line @stylistic/padding-line-between-statements -- c8
       return false;
     });
     for (const [idx, src] of jsdoc.source.slice(lastIndex).entries()) {
-      src.number = firstNumber + ( /** @type {Integer} */lastIndex) + idx;
+      src.number = firstNumber + (/** @type {Integer} */lastIndex) + idx;
     }
 
     // Todo: Once rewiring of tags may be fixed in comment-parser to reflect
@@ -1095,11 +1095,12 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
         lastIndex = sourceIndex;
         return true;
       }
-      /* c8 ignore next */
+      /* c8 ignore next 2 */
+      // eslint-disable-next-line @stylistic/padding-line-between-statements -- c8
       return false;
     });
     for (const [idx, src] of jsdoc.source.slice(lastIndex).entries()) {
-      src.number = firstNumber + ( /** @type {Integer} */lastIndex) + idx;
+      src.number = firstNumber + (/** @type {Integer} */lastIndex) + idx;
     }
   };
 
@@ -1111,11 +1112,11 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
       }]
     } = jsdoc;
     const {
-      postDelimiter,
       description,
       lineEnd,
-      tag,
       name,
+      postDelimiter,
+      tag,
       type
     } = tokens;
     let {
@@ -1170,7 +1171,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
 
   /** @type {HasParams} */
   utils.hasParams = () => {
-    return jsdocUtils.hasParams( /** @type {Node} */node);
+    return jsdocUtils.hasParams(/** @type {Node} */node);
   };
 
   /** @type {IsGenerator} */
@@ -1181,7 +1182,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
      * @type {import('estree').FunctionDeclaration|
      *   import('estree').FunctionExpression}
      */
-    node.generator || node.type === 'MethodDefinition' && node.value.generator || ['ExportNamedDeclaration', 'ExportDefaultDeclaration'].includes(node.type) && ( /** @type {import('estree').FunctionDeclaration} */(_node$declaration =
+    node.generator || node.type === 'MethodDefinition' && node.value.generator || ['ExportDefaultDeclaration', 'ExportNamedDeclaration'].includes(node.type) && (/** @type {import('estree').FunctionDeclaration} */(_node$declaration =
     /**
      * @type {import('estree').ExportNamedDeclaration|
      *   import('estree').ExportDefaultDeclaration}
@@ -1191,7 +1192,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
 
   /** @type {IsConstructor} */
   utils.isConstructor = () => {
-    return jsdocUtils.isConstructor( /** @type {Node} */node);
+    return jsdocUtils.isConstructor(/** @type {Node} */node);
   };
 
   /** @type {GetJsdocTagsDeep} */
@@ -1259,9 +1260,9 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
   };
   for (const method of ['tagMightHaveNamePosition', 'tagMightHaveTypePosition']) {
     /** @type {TagMightHaveNamePositionTypePosition} */
-    utils[( /** @type {"tagMightHaveNamePosition"|"tagMightHaveTypePosition"} */
+    utils[(/** @type {"tagMightHaveNamePosition"|"tagMightHaveTypePosition"} */
     method)] = (tagName, otherModeMaps) => {
-      const result = jsdocUtils[( /** @type {"tagMightHaveNamePosition"|"tagMightHaveTypePosition"} */
+      const result = jsdocUtils[(/** @type {"tagMightHaveNamePosition"|"tagMightHaveTypePosition"} */
       method)](tagName);
       if (result) {
         return true;
@@ -1270,7 +1271,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
         return false;
       }
       const otherResult = otherModeMaps.some(otherModeMap => {
-        return jsdocUtils[( /** @type {"tagMightHaveNamePosition"|"tagMightHaveTypePosition"} */
+        return jsdocUtils[(/** @type {"tagMightHaveNamePosition"|"tagMightHaveTypePosition"} */
         method)](tagName, otherModeMap);
       });
       return otherResult ? {
@@ -1294,9 +1295,9 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
   };
   for (const method of ['tagMustHaveNamePosition', 'tagMustHaveTypePosition']) {
     /** @type {TagMustHave} */
-    utils[( /** @type {"tagMustHaveNamePosition"|"tagMustHaveTypePosition"} */
+    utils[(/** @type {"tagMustHaveNamePosition"|"tagMustHaveTypePosition"} */
     method)] = (tagName, otherModeMaps) => {
-      const result = jsdocUtils[( /** @type {"tagMustHaveNamePosition"|"tagMustHaveTypePosition"} */
+      const result = jsdocUtils[(/** @type {"tagMustHaveNamePosition"|"tagMustHaveTypePosition"} */
       method)](tagName);
       if (!result) {
         return false;
@@ -1305,7 +1306,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
       // if (!otherModeMaps) { return true; }
 
       const otherResult = otherModeMaps.every(otherModeMap => {
-        return jsdocUtils[( /** @type {"tagMustHaveNamePosition"|"tagMustHaveTypePosition"} */
+        return jsdocUtils[(/** @type {"tagMustHaveNamePosition"|"tagMustHaveTypePosition"} */
         method)](tagName, otherModeMap);
       });
       return otherResult ? true : {
@@ -1315,9 +1316,9 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
   }
   for (const method of ['isNamepathDefiningTag', 'isNamepathReferencingTag', 'isNamepathOrUrlReferencingTag', 'tagMightHaveNamepath']) {
     /** @type {IsNamepathX} */
-    utils[( /** @type {"isNamepathDefiningTag"|"isNamepathReferencingTag"|"isNamepathOrUrlReferencingTag"|"tagMightHaveNamepath"} */
+    utils[(/** @type {"isNamepathDefiningTag"|"isNamepathReferencingTag"|"isNamepathOrUrlReferencingTag"|"tagMightHaveNamepath"} */
     method)] = tagName => {
-      return jsdocUtils[( /** @type {"isNamepathDefiningTag"|"isNamepathReferencingTag"|"isNamepathOrUrlReferencingTag"|"tagMightHaveNamepath"} */
+      return jsdocUtils[(/** @type {"isNamepathDefiningTag"|"isNamepathReferencingTag"|"isNamepathOrUrlReferencingTag"|"tagMightHaveNamepath"} */
       method)](tagName);
     };
   }
@@ -1334,22 +1335,22 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
 
   /** @type {HasValueOrExecutorHasNonEmptyResolveValue} */
   utils.hasValueOrExecutorHasNonEmptyResolveValue = (anyPromiseAsReturn, allBranches) => {
-    return jsdocUtils.hasValueOrExecutorHasNonEmptyResolveValue( /** @type {Node} */node, anyPromiseAsReturn, allBranches);
+    return jsdocUtils.hasValueOrExecutorHasNonEmptyResolveValue(/** @type {Node} */node, anyPromiseAsReturn, allBranches);
   };
 
   /** @type {HasYieldValue} */
   utils.hasYieldValue = () => {
-    if (['ExportNamedDeclaration', 'ExportDefaultDeclaration'].includes( /** @type {Node} */node.type)) {
-      return jsdocUtils.hasYieldValue( /** @type {import('estree').Declaration|import('estree').Expression} */
+    if (['ExportDefaultDeclaration', 'ExportNamedDeclaration'].includes(/** @type {Node} */node.type)) {
+      return jsdocUtils.hasYieldValue(/** @type {import('estree').Declaration|import('estree').Expression} */
       /** @type {import('estree').ExportNamedDeclaration|import('estree').ExportDefaultDeclaration} */
       node.declaration);
     }
-    return jsdocUtils.hasYieldValue( /** @type {Node} */node);
+    return jsdocUtils.hasYieldValue(/** @type {Node} */node);
   };
 
   /** @type {HasYieldReturnValue} */
   utils.hasYieldReturnValue = () => {
-    return jsdocUtils.hasYieldValue( /** @type {Node} */node, true);
+    return jsdocUtils.hasYieldValue(/** @type {Node} */node, true);
   };
 
   /** @type {HasThrowValue} */
@@ -1434,10 +1435,10 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
   /** @type {ForEachPreferredTag} */
   utils.forEachPreferredTag = (tagName, arrayHandler, skipReportingBlockedTag) => {
     return jsdocUtils.forEachPreferredTag(jsdoc, tagName, arrayHandler, {
-      skipReportingBlockedTag,
       context,
       mode,
       report,
+      skipReportingBlockedTag,
       tagNamePreference
     });
   };
@@ -1445,9 +1446,9 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
   /** @type {FindContext} */
   utils.findContext = (contexts, comment) => {
     const foundContext = contexts.find(cntxt => {
-      return typeof cntxt === 'string' ? _esquery.default.matches( /** @type {Node} */node, _esquery.default.parse(cntxt), undefined, {
+      return typeof cntxt === 'string' ? _esquery.default.matches(/** @type {Node} */node, _esquery.default.parse(cntxt), undefined, {
         visitorKeys: sourceCode.visitorKeys
-      }) : (!cntxt.context || cntxt.context === 'any' || _esquery.default.matches( /** @type {Node} */node, _esquery.default.parse(cntxt.context), undefined, {
+      }) : (!cntxt.context || cntxt.context === 'any' || _esquery.default.matches(/** @type {Node} */node, _esquery.default.parse(cntxt.context), undefined, {
         visitorKeys: sourceCode.visitorKeys
       })) && comment === cntxt.comment;
     });
@@ -1493,12 +1494,35 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
  */
 
 /**
- * @param {import('eslint').Rule.RuleContext} context
+ * @typedef {{
+ *   settings?: {
+ *     jsdoc?: {
+ *       ignorePrivate: boolean,
+ *       ignoreInternal: boolean,
+ *       maxLines: Integer,
+ *       minLines: Integer,
+ *       tagNamePreference: import('./jsdocUtils.js').TagNamePreference,
+ *       preferredTypes: PreferredTypes,
+ *       structuredTags: StructuredTags,
+ *       overrideReplacesDocs: boolean,
+ *       ignoreReplacesDocs: boolean,
+ *       implementsReplacesDocs: boolean,
+ *       augmentsExtendsReplacesDocs: boolean,
+ *       exemptDestructuredRootsFromChecks: boolean,
+ *       mode: import('./jsdocUtils.js').ParserMode,
+ *       contexts: Context[],
+ *     }
+ *   }
+ * }} JSDocSettings
+ */
+
+/**
+ * @param {import('eslint').Rule.RuleContext & JSDocSettings} context
  * @returns {Settings|false}
  */
 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, _context$settings$jsd13, _context$settings$jsd14;
-  /* dslint-disable canonical/sort-keys */
+  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$jsd0, _context$settings$jsd1, _context$settings$jsd10, _context$settings$jsd11, _context$settings$jsd12;
+  /* eslint-disable perfectionist/sort-objects */
   const settings = {
     // All rules
     ignorePrivate: Boolean((_context$settings$jsd = context.settings.jsdoc) === null || _context$settings$jsd === void 0 ? void 0 : _context$settings$jsd.ignorePrivate),
@@ -1515,16 +1539,16 @@ const getSettings = context => {
     // `require-returns`, `require-throw`, `require-yields`
     overrideReplacesDocs: (_context$settings$jsd8 = context.settings.jsdoc) === null || _context$settings$jsd8 === void 0 ? void 0 : _context$settings$jsd8.overrideReplacesDocs,
     ignoreReplacesDocs: (_context$settings$jsd9 = context.settings.jsdoc) === null || _context$settings$jsd9 === void 0 ? void 0 : _context$settings$jsd9.ignoreReplacesDocs,
-    implementsReplacesDocs: (_context$settings$jsd10 = context.settings.jsdoc) === null || _context$settings$jsd10 === void 0 ? void 0 : _context$settings$jsd10.implementsReplacesDocs,
-    augmentsExtendsReplacesDocs: (_context$settings$jsd11 = context.settings.jsdoc) === null || _context$settings$jsd11 === void 0 ? void 0 : _context$settings$jsd11.augmentsExtendsReplacesDocs,
+    implementsReplacesDocs: (_context$settings$jsd0 = context.settings.jsdoc) === null || _context$settings$jsd0 === void 0 ? void 0 : _context$settings$jsd0.implementsReplacesDocs,
+    augmentsExtendsReplacesDocs: (_context$settings$jsd1 = context.settings.jsdoc) === null || _context$settings$jsd1 === void 0 ? void 0 : _context$settings$jsd1.augmentsExtendsReplacesDocs,
     // `require-param-type`, `require-param-description`
-    exemptDestructuredRootsFromChecks: (_context$settings$jsd12 = context.settings.jsdoc) === null || _context$settings$jsd12 === void 0 ? void 0 : _context$settings$jsd12.exemptDestructuredRootsFromChecks,
+    exemptDestructuredRootsFromChecks: (_context$settings$jsd10 = context.settings.jsdoc) === null || _context$settings$jsd10 === void 0 ? void 0 : _context$settings$jsd10.exemptDestructuredRootsFromChecks,
     // Many rules, e.g., `check-tag-names`
-    mode: ((_context$settings$jsd13 = context.settings.jsdoc) === null || _context$settings$jsd13 === void 0 ? void 0 : _context$settings$jsd13.mode) ?? 'typescript',
+    mode: ((_context$settings$jsd11 = context.settings.jsdoc) === null || _context$settings$jsd11 === void 0 ? void 0 : _context$settings$jsd11.mode) ?? 'typescript',
     // Many rules
-    contexts: (_context$settings$jsd14 = context.settings.jsdoc) === null || _context$settings$jsd14 === void 0 ? void 0 : _context$settings$jsd14.contexts
+    contexts: (_context$settings$jsd12 = context.settings.jsdoc) === null || _context$settings$jsd12 === void 0 ? void 0 : _context$settings$jsd12.contexts
   };
-  /* dslint-enable canonical/sort-keys */
+  /* eslint-enable perfectionist/sort-objects */
 
   jsdocUtils.setTagStructure(settings.mode);
   try {
@@ -1566,7 +1590,7 @@ const makeReport = (context, commentNode) => {
       if (!('line' in jsdocLoc)) {
         jsdocLoc.line = /** @type {import('comment-parser').Spec & {line?: Integer}} */jsdocLoc.source[0].number;
       }
-      const lineNumber = /** @type {import('eslint').AST.SourceLocation} */commentNode.loc.start.line + ( /** @type {Integer} */jsdocLoc.line);
+      const lineNumber = /** @type {import('eslint').AST.SourceLocation} */commentNode.loc.start.line + (/** @type {Integer} */jsdocLoc.line);
       loc = {
         end: {
           column: 0,
@@ -1577,8 +1601,6 @@ const makeReport = (context, commentNode) => {
           line: lineNumber
         }
       };
-
-      // Todo: Remove ignore once `check-examples` can be restored for ESLint 8+
       if ('column' in jsdocLoc && typeof jsdocLoc.column === 'number') {
         const colNumber = /** @type {import('eslint').AST.SourceLocation} */commentNode.loc.start.column + jsdocLoc.column;
         loc.end.column = colNumber;
@@ -1720,7 +1742,7 @@ const getIndentAndJSDoc = function (lines, jsdocNode) {
   if (indentChar !== ' ' && indentChar !== '\t') {
     indentChar = ' ';
   }
-  const indnt = indentChar.repeat( /** @type {import('estree').SourceLocation} */
+  const indnt = indentChar.repeat(/** @type {import('estree').SourceLocation} */
   jsdocNode.loc.start.column);
   const jsdc = (0, _jsdoccomment.parseComment)(jsdocNode, '');
   return [indnt, jsdc];
@@ -1796,7 +1818,7 @@ const iterateAllJsdocs = (iterator, ruleConfig, contexts, additiveCommentContext
     const utils = getBasicUtils(context, /** @type {Settings} */settings);
     for (const jsdocNode of jsdocNodes) {
       const jsdocNde = /** @type {unknown} */jsdocNode;
-      if (!/^\/\*\*\s/u.test(sourceCode.getText( /** @type {import('estree').Node} */
+      if (!/^\/\*\*\s/u.test(sourceCode.getText(/** @type {import('estree').Node} */
       jsdocNde))) {
         continue;
       }
@@ -1851,7 +1873,6 @@ const iterateAllJsdocs = (iterator, ruleConfig, contexts, additiveCommentContext
     }
   };
   return {
-    // @ts-expect-error ESLint accepts
     create(context) {
       /* c8 ignore next -- Fallback to deprecated method */
       const {
@@ -1888,7 +1909,7 @@ const iterateAllJsdocs = (iterator, ruleConfig, contexts, additiveCommentContext
             return;
           }
           trackedJsdocs.add(commentNode);
-          callIterator(context, node, [( /** @type {import('estree').Comment} */
+          callIterator(context, node, [(/** @type {import('estree').Comment} */
           commentNode)], /** @type {StateObject} */state);
         },
         'Program:exit'() {
@@ -1928,7 +1949,7 @@ const checkFile = (iterator, ruleConfig) => {
           const allComms = /** @type {unknown} */sourceCode.getAllComments();
           const utils = getBasicUtils(context, settings);
           iterator({
-            allComments: ( /** @type {import('estree').Node[]} */allComms),
+            allComments: (/** @type {import('estree').Node[]} */allComms),
             context,
             makeReport,
             settings,
@@ -1949,14 +1970,14 @@ const checkFile = (iterator, ruleConfig) => {
 function iterateJsdoc(iterator, ruleConfig) {
   var _ruleConfig$meta;
   const metaType = ruleConfig === null || ruleConfig === void 0 || (_ruleConfig$meta = ruleConfig.meta) === null || _ruleConfig$meta === void 0 ? void 0 : _ruleConfig$meta.type;
-  if (!metaType || !['problem', 'suggestion', 'layout'].includes(metaType)) {
+  if (!metaType || !['layout', 'problem', 'suggestion'].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( /** @type {JsdocVisitorBasic} */iterator, ruleConfig);
+    return checkFile(/** @type {JsdocVisitorBasic} */iterator, ruleConfig);
   }
   if (ruleConfig.iterateAllJsdocs) {
     return iterateAllJsdocs(iterator, ruleConfig);
@@ -2004,7 +2025,7 @@ function iterateJsdoc(iterator, ruleConfig) {
           return (ctxt === null || ctxt === void 0 ? void 0 : ctxt.context) === 'any';
         }));
         if (hasPlainAny || hasObjectAny) {
-          return iterateAllJsdocs(iterator, ruleConfig, hasObjectAny ? ( /** @type {ContextObject[]} */contexts) : null, ruleConfig.matchContext).create(context);
+          return iterateAllJsdocs(iterator, ruleConfig, hasObjectAny ? (/** @type {ContextObject[]} */contexts) : null, ruleConfig.matchContext).create(context);
         }
       }