eslint-plugin-jsdoc 46.8.2 → 46.9.1

package/dist/iterateJsdoc.js

@@ -128,7 +128,6 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  *   [key: string]: string
  * }} [data]
  */
-/* eslint-enable jsdoc/valid-types -- Old version */
 
 /**
  * @callback GetRegexFromString
@@ -176,7 +175,6 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * ) => import('comment-parser').Line[]} setter
  * @returns {void}
  */
-/* eslint-enable jsdoc/no-undefined-types -- Bug */
 
 /**
  * @callback SetDescriptionLines
@@ -191,7 +189,6 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @param {...Partial<import('comment-parser').Tokens>} tokens
  * @returns {void}
  */
-/* eslint-enable jsdoc/no-undefined-types -- TS */
 
 /**
  * @callback SetTag
@@ -201,7 +198,6 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @param {Partial<import('comment-parser').Tokens>} [tokens]
  * @returns {void}
  */
-/* eslint-enable jsdoc/no-undefined-types -- TS */
 
 /**
  * @callback RemoveTag
@@ -231,7 +227,6 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  *   tokens?: Partial<import('comment-parser').Tokens> | undefined
  * ) => import('comment-parser').Tokens} SeedTokens
  */
-/* eslint-enable jsdoc/no-undefined-types -- TS */
 
 /**
  * Sets tokens to empty string.
@@ -246,7 +241,6 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @param {Partial<import('comment-parser').Tokens>} tokens
  * @returns {void}
  */
-/* eslint-enable jsdoc/no-undefined-types -- TS */
 
 /**
  * @callback AddLines
@@ -484,6 +478,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  *   contextStr: string
  * }}
  */
+
 /**
  * @typedef {BasicUtils & {
  *   isIteratingFunction: IsIteratingFunction,
@@ -547,6 +542,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  *   findContext: FindContext
  * }} Utils
  */
+
 const {
   rewireSpecs,
   seedTokens
@@ -580,7 +576,6 @@ const {
  *   }
  * }} StateObject
  */
-/* eslint-enable jsdoc/valid-types -- Old version */
 
 /**
  * The Node AST as supplied by the parser.
@@ -664,7 +659,6 @@ const getBasicUtils = (context, {
  * }} [data]
  * @returns {void}
  */
-/* eslint-enable jsdoc/valid-types -- Old version of pratt */
 
 /**
  * @param {Node|null} node
@@ -673,13 +667,15 @@ const getBasicUtils = (context, {
  * @param {Settings} settings
  * @param {Report} report
  * @param {import('eslint').Rule.RuleContext} context
+ * @param {import('eslint').SourceCode} sc
  * @param {boolean|undefined} iteratingAll
  * @param {RuleConfig} ruleConfig
  * @param {string} indent
  * @returns {Utils}
  */
-const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAll, ruleConfig, indent) => {
-  const ancestors = /** @type {import('eslint').Rule.Node[]} */context.getAncestors();
+const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iteratingAll, ruleConfig, indent) => {
+  /* istanbul ignore next */
+  const ancestors = /** @type {import('eslint').Rule.Node[]} */node ? sc.getAncestors ? sc.getAncestors(node) : context.getAncestors() : [];
 
   // istanbul ignore next -- Fallback to deprecated method
   const {
@@ -878,7 +874,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
 
     /* istanbul 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,
@@ -986,12 +982,12 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
             tokens
           } = jsdoc.source[spliceIdx];
           for (const item of ['postDelimiter', 'tag', 'postTag', 'type', 'postType', 'name', 'postName', 'description']) {
-            tokens[
+            tokens[(
             /**
              * @type {"postDelimiter"|"tag"|"type"|"postType"|
              *   "postTag"|"name"|"postName"|"description"}
              */
-            item] = '';
+            item)] = '';
           }
         } else {
           jsdoc.source.splice(spliceIdx, spliceCount - tagSourceOffset + (spliceIdx ? 0 : jsdoc.source.length));
@@ -1005,7 +1001,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
       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
@@ -1061,12 +1057,12 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
   /** @type {EmptyTokens} */
   utils.emptyTokens = tokens => {
     for (const prop of ['start', 'postDelimiter', 'tag', 'type', 'postType', 'postTag', 'name', 'postName', 'description', 'end', 'lineEnd']) {
-      tokens[
+      tokens[(
       /**
        * @type {"start"|"postDelimiter"|"tag"|"type"|"postType"|
        *   "postTag"|"name"|"postName"|"description"|"end"|"lineEnd"}
        */
-      prop] = '';
+      prop)] = '';
     }
   };
 
@@ -1134,7 +1130,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
       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;
     }
   };
 
@@ -1216,11 +1212,12 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
      *   import('estree').FunctionExpression}
      */
     node.generator || node.type === 'MethodDefinition' && node.value.generator || ['ExportNamedDeclaration', 'ExportDefaultDeclaration'].includes(node.type) && /** @type {import('estree').FunctionDeclaration} */
+    (
     /**
      * @type {import('estree').ExportNamedDeclaration|
      *   import('estree').ExportDefaultDeclaration}
      */
-    node.declaration.generator);
+    node.declaration).generator);
   };
 
   /** @type {IsConstructor} */
@@ -1305,10 +1302,10 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
   };
   for (const method of ['tagMightHaveNamePosition', 'tagMightHaveTypePosition']) {
     /** @type {TagMightHaveNamePositionTypePosition} */
-    utils[/** @type {"tagMightHaveNamePosition"|"tagMightHaveTypePosition"} */
-    method] = (tagName, otherModeMaps) => {
-      const result = _jsdocUtils.default[/** @type {"tagMightHaveNamePosition"|"tagMightHaveTypePosition"} */
-      method](tagName);
+    utils[( /** @type {"tagMightHaveNamePosition"|"tagMightHaveTypePosition"} */
+    method)] = (tagName, otherModeMaps) => {
+      const result = _jsdocUtils.default[( /** @type {"tagMightHaveNamePosition"|"tagMightHaveTypePosition"} */
+      method)](tagName);
       if (result) {
         return true;
       }
@@ -1316,8 +1313,8 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
         return false;
       }
       const otherResult = otherModeMaps.some(otherModeMap => {
-        return _jsdocUtils.default[/** @type {"tagMightHaveNamePosition"|"tagMightHaveTypePosition"} */
-        method](tagName, otherModeMap);
+        return _jsdocUtils.default[( /** @type {"tagMightHaveNamePosition"|"tagMightHaveTypePosition"} */
+        method)](tagName, otherModeMap);
       });
       return otherResult ? {
         otherMode: true
@@ -1340,10 +1337,10 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
   };
   for (const method of ['tagMustHaveNamePosition', 'tagMustHaveTypePosition']) {
     /** @type {TagMustHave} */
-    utils[/** @type {"tagMustHaveNamePosition"|"tagMustHaveTypePosition"} */
-    method] = (tagName, otherModeMaps) => {
-      const result = _jsdocUtils.default[/** @type {"tagMustHaveNamePosition"|"tagMustHaveTypePosition"} */
-      method](tagName);
+    utils[( /** @type {"tagMustHaveNamePosition"|"tagMustHaveTypePosition"} */
+    method)] = (tagName, otherModeMaps) => {
+      const result = _jsdocUtils.default[( /** @type {"tagMustHaveNamePosition"|"tagMustHaveTypePosition"} */
+      method)](tagName);
       if (!result) {
         return false;
       }
@@ -1351,8 +1348,8 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
       // if (!otherModeMaps) { return true; }
 
       const otherResult = otherModeMaps.every(otherModeMap => {
-        return _jsdocUtils.default[/** @type {"tagMustHaveNamePosition"|"tagMustHaveTypePosition"} */
-        method](tagName, otherModeMap);
+        return _jsdocUtils.default[( /** @type {"tagMustHaveNamePosition"|"tagMustHaveTypePosition"} */
+        method)](tagName, otherModeMap);
       });
       return otherResult ? true : {
         otherMode: false
@@ -1361,10 +1358,10 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
   }
   for (const method of ['isNamepathDefiningTag', 'isNamepathReferencingTag', 'isNamepathOrUrlReferencingTag', 'tagMightHaveNamepath']) {
     /** @type {IsNamepathX} */
-    utils[/** @type {"isNamepathDefiningTag"|"isNamepathReferencingTag"|"isNamepathOrUrlReferencingTag"|"tagMightHaveNamepath"} */
-    method] = tagName => {
-      return _jsdocUtils.default[/** @type {"isNamepathDefiningTag"|"isNamepathReferencingTag"|"isNamepathOrUrlReferencingTag"|"tagMightHaveNamepath"} */
-      method](tagName);
+    utils[( /** @type {"isNamepathDefiningTag"|"isNamepathReferencingTag"|"isNamepathOrUrlReferencingTag"|"tagMightHaveNamepath"} */
+    method)] = tagName => {
+      return _jsdocUtils.default[( /** @type {"isNamepathDefiningTag"|"isNamepathReferencingTag"|"isNamepathOrUrlReferencingTag"|"tagMightHaveNamepath"} */
+      method)](tagName);
     };
   }
 
@@ -1405,7 +1402,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
 
   /** @type {IsAsync} */
   utils.isAsync = () => {
-    return 'async' in /** @type {Node} */node && node.async;
+    return 'async' in ( /** @type {Node} */node) && node.async;
   };
 
   /** @type {GetTags} */
@@ -1552,7 +1549,6 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, iteratingAl
  *   contexts?: Context[]
  * }} Settings
  */
-/* eslint-enable jsdoc/valid-types -- Old version */
 
 /**
  * @param {import('eslint').Rule.RuleContext} context
@@ -1623,13 +1619,12 @@ exports.getSettings = getSettings;
 const makeReport = (context, commentNode) => {
   /** @type {Report} */
   const report = (message, fix = null, jsdocLoc = null, data = undefined) => {
-    /* eslint-enable jsdoc/valid-types -- Old version */
     let loc;
     if (jsdocLoc) {
       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,
@@ -1710,8 +1705,6 @@ const makeReport = (context, commentNode) => {
  *   }
  * ) => any } JsdocVisitor
  */
-/* eslint-enable jsdoc/valid-types -- Old version */
-/* eslint-enable jsdoc/no-undefined-types -- canonical still using an older version where not defined */
 
 /**
  * @param {{
@@ -1738,7 +1731,7 @@ const iterate = (info, indent, jsdoc, ruleConfig, context, jsdocNode, node, sett
   const report = makeReport(context, /** @type {import('estree').Node} */
   jsdocNde);
   const utils = getUtils(node, jsdoc, /** @type {import('eslint').AST.Token} */
-  jsdocNode, settings, report, context, iteratingAll, ruleConfig, indent);
+  jsdocNode, settings, report, context, sourceCode, iteratingAll, ruleConfig, indent);
   if (!ruleConfig.checkInternal && settings.ignoreInternal && utils.hasTag('internal')) {
     return;
   }
@@ -1759,12 +1752,12 @@ const iterate = (info, indent, jsdoc, ruleConfig, context, jsdocNode, node, sett
     indent,
     info,
     jsdoc,
-    jsdocNode:
+    jsdocNode: (
     /**
      * @type {import('eslint').Rule.Node & {
      *  range: [number, number];}}
      */
-    jsdocNde,
+    jsdocNde),
     node,
     report,
     settings,
@@ -1950,8 +1943,8 @@ const iterateAllJsdocs = (iterator, ruleConfig, contexts, additiveCommentContext
             return;
           }
           trackedJsdocs.add(commentNode);
-          callIterator(context, node, [/** @type {import('estree').Comment} */
-          commentNode], /** @type {StateObject} */state);
+          callIterator(context, node, [( /** @type {import('estree').Comment} */
+          commentNode)], /** @type {StateObject} */state);
         },
         'Program:exit'() {
           const allComments = sourceCode.getAllComments();
@@ -1990,7 +1983,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,
@@ -2044,7 +2037,6 @@ function iterateJsdoc(iterator, ruleConfig) {
        * @type {Context[]|undefined}
        */
       let contexts;
-      /* eslint-enable jsdoc/valid-types -- Old version */
       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, ruleConfig.nonGlobalSettings ? {} : settings);
@@ -2067,7 +2059,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);
         }
       }
 
@@ -2081,7 +2073,6 @@ function iterateJsdoc(iterator, ruleConfig) {
 
       /** @type {Partial<StateObject>} */
       const state = {};
-      /* eslint-enable jsdoc/no-undefined-types -- TS */
 
       /** @type {CheckJsdoc} */
       const checkJsdoc = (info, handler, node) => {
@@ -2124,10 +2115,8 @@ function iterateJsdoc(iterator, ruleConfig) {
             settings,
             state: ste
           });
-          /* eslint-enable jsdoc/no-undefined-types -- Bug */
         };
       }
-
       return contextObject;
     },
     meta: ruleConfig.meta