eslint-plugin-jsdoc 44.2.3 → 44.2.5

package/dist/exportParser.js

@@ -8,26 +8,64 @@ var _jsdoccomment = require("@es-joy/jsdoccomment");
 var _debug = _interopRequireDefault(require("debug"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const debug = (0, _debug.default)('requireExportJsdoc');
+
+/**
+ * @typedef {{
+ *   value: string
+ * }} ValueObject
+ */
+
+/**
+ * @typedef {{
+ *   type?: string,
+ *   value?: ValueObject|import('eslint').Rule.Node,
+ *   props: {
+ *     [key: string]: CreatedNode|null,
+ *   },
+ *   special?: true,
+ *   globalVars?: CreatedNode,
+ *   exported?: boolean,
+ *   ANONYMOUS_DEFAULT?: import('eslint').Rule.Node
+ * }} CreatedNode
+ */
+
+/**
+ * @returns {CreatedNode}
+ */
 const createNode = function () {
   return {
     props: {}
   };
 };
+
+/**
+ * @param {CreatedNode|null} symbol
+ * @returns {string|null}
+ */
 const getSymbolValue = function (symbol) {
-  /* istanbul ignore next */
+  /* istanbul ignore if */
   if (!symbol) {
-    /* istanbul ignore next */
     return null;
   }
 
-  /* istanbul ignore next */
+  /* istanbul ignore else */
   if (symbol.type === 'literal') {
-    return symbol.value.value;
+    return (/** @type {ValueObject} */symbol.value.value
+    );
   }
 
   /* istanbul ignore next */
   return null;
 };
+
+/**
+ *
+ * @param {import('estree').Identifier} node
+ * @param {CreatedNode} globals
+ * @param {CreatedNode} scope
+ * @param {SymbolOptions} opts
+ * @returns {CreatedNode|null}
+ */
 const getIdentifier = function (node, globals, scope, opts) {
   if (opts.simpleIdentifier) {
     // Type is Identier for noncomputed properties
@@ -54,10 +92,38 @@ const getIdentifier = function (node, globals, scope, opts) {
   }
   return null;
 };
-let createSymbol = null;
 
-// eslint-disable-next-line complexity
+/**
+ * @callback CreateSymbol
+ * @param {import('eslint').Rule.Node|null} node
+ * @param {CreatedNode} globals
+ * @param {import('eslint').Rule.Node|null} value
+ * @param {CreatedNode} [scope]
+ * @param {boolean|SymbolOptions} [isGlobal]
+ * @returns {CreatedNode|null}
+ */
+
+/** @type {CreateSymbol} */
+let createSymbol; // eslint-disable-line prefer-const
+
+/* eslint-disable complexity -- Temporary */
+
+/**
+ * @typedef {{
+ *   simpleIdentifier?: boolean
+ * }} SymbolOptions
+ */
+
+/**
+ *
+ * @param {import('eslint').Rule.Node} node
+ * @param {CreatedNode} globals
+ * @param {CreatedNode} scope
+ * @param {SymbolOptions} [opt]
+ * @returns {CreatedNode|null}
+ */
 const getSymbol = function (node, globals, scope, opt) {
+  /* eslint-enable complexity -- Temporary */
   const opts = opt || {};
   /* istanbul ignore next */
   // eslint-disable-next-line default-case
@@ -68,13 +134,15 @@ const getSymbol = function (node, globals, scope, opt) {
       }
     case 'MemberExpression':
       {
-        const obj = getSymbol(node.object, globals, scope, opts);
-        const propertySymbol = getSymbol(node.property, globals, scope, {
+        const obj = getSymbol( /** @type {import('eslint').Rule.Node} */
+        node.object, globals, scope, opts);
+        const propertySymbol = getSymbol( /** @type {import('eslint').Rule.Node} */
+        node.property, globals, scope, {
           simpleIdentifier: !node.computed
         });
         const propertyValue = getSymbolValue(propertySymbol);
 
-        /* istanbul ignore next */
+        /* istanbul ignore else */
         if (obj && propertyValue && obj.props[propertyValue]) {
           const block = obj.props[propertyValue];
           return block;
@@ -87,16 +155,22 @@ const getSymbol = function (node, globals, scope, opt) {
         }
         */
         /* istanbul ignore next */
-        debug(`MemberExpression: Missing property ${node.property.name}`);
+        debug(`MemberExpression: Missing property ${
+        /** @type {import('estree').PrivateIdentifier} */node.property.name}`);
 
         /* istanbul ignore next */
         return null;
       }
     case 'ClassExpression':
       {
-        return getSymbol(node.body, globals, scope, opts);
+        return getSymbol( /** @type {import('eslint').Rule.Node} */
+        node.body, globals, scope, opts);
       }
+
+    // @ts-expect-error TS OK
     case 'TSTypeAliasDeclaration':
+    // @ts-expect-error TS OK
+    // Fallthrough
     case 'TSEnumDeclaration':
     case 'TSInterfaceDeclaration':
     case 'ClassDeclaration':
@@ -113,15 +187,20 @@ const getSymbol = function (node, globals, scope, opt) {
       }
     case 'AssignmentExpression':
       {
-        return createSymbol(node.left, globals, node.right, scope, opts);
+        return createSymbol( /** @type {import('eslint').Rule.Node} */
+        node.left, globals, /** @type {import('eslint').Rule.Node} */
+        node.right, scope, opts);
       }
     case 'ClassBody':
       {
         const val = createNode();
         for (const method of node.body) {
-          val.props[method.key.name] = createNode();
-          val.props[method.key.name].type = 'object';
-          val.props[method.key.name].value = method.value;
+          val.props[/** @type {import('estree').Identifier} */ /** @type {import('estree').MethodDefinition} */method.key.name] = createNode();
+          /** @type {{[key: string]: CreatedNode}} */
+          val.props[/** @type {import('estree').Identifier} */ /** @type {import('estree').MethodDefinition} */method.key.name].type = 'object';
+          /** @type {{[key: string]: CreatedNode}} */
+          val.props[/** @type {import('estree').Identifier} */ /** @type {import('estree').MethodDefinition} */method.key.name].value = /** @type {import('eslint').Rule.Node} */
+          /** @type {import('estree').MethodDefinition} */method.value;
         }
         val.type = 'object';
         val.value = node.parent;
@@ -139,10 +218,13 @@ const getSymbol = function (node, globals, scope, opt) {
           'ExperimentalSpreadProperty'].includes(prop.type)) {
             continue;
           }
-          const propVal = getSymbol(prop.value, globals, scope, opts);
-          /* istanbul ignore next */
+          const propVal = getSymbol( /** @type {import('eslint').Rule.Node} */
+          /** @type {import('estree').Property} */
+          prop.value, globals, scope, opts);
+          /* istanbul ignore if */
           if (propVal) {
-            val.props[prop.key.name] = propVal;
+            val.props[/** @type {import('estree').PrivateIdentifier} */
+            /** @type {import('estree').Property} */prop.key.name] = propVal;
           }
         }
         return val;
@@ -159,6 +241,16 @@ const getSymbol = function (node, globals, scope, opt) {
   /* istanbul ignore next */
   return null;
 };
+
+/**
+ *
+ * @param {CreatedNode} block
+ * @param {string} name
+ * @param {CreatedNode|null} value
+ * @param {CreatedNode} globals
+ * @param {boolean|SymbolOptions|undefined} isGlobal
+ * @returns {void}
+ */
 const createBlockSymbol = function (block, name, value, globals, isGlobal) {
   block.props[name] = value;
   if (isGlobal && globals.props.window && globals.props.window.special) {
@@ -167,22 +259,29 @@ const createBlockSymbol = function (block, name, value, globals, isGlobal) {
 };
 createSymbol = function (node, globals, value, scope, isGlobal) {
   const block = scope || globals;
+  /* istanbul ignore if */
+  if (!node) {
+    return null;
+  }
   let symbol;
   // eslint-disable-next-line default-case
   switch (node.type) {
     case 'FunctionDeclaration':
     /* istanbul ignore next */
+    // @ts-expect-error TS OK
     // Fall through
     case 'TSEnumDeclaration':
     case 'TSInterfaceDeclaration':
     /* istanbul ignore next */
+    // @ts-expect-error TS OK
     // Fall through
     case 'TSTypeAliasDeclaration':
     case 'ClassDeclaration':
       {
-        /* istanbul ignore next */
-        if (node.id && node.id.type === 'Identifier') {
-          return createSymbol(node.id, globals, node, globals);
+        const nde = /** @type {import('estree').ClassDeclaration} */node;
+        /* istanbul ignore else */
+        if (nde.id && nde.id.type === 'Identifier') {
+          return createSymbol( /** @type {import('eslint').Rule.Node} */nde.id, globals, node, globals);
         }
 
         /* istanbul ignore next */
@@ -190,19 +289,20 @@ createSymbol = function (node, globals, value, scope, isGlobal) {
       }
     case 'Identifier':
       {
+        const nde = /** @type {import('estree').Identifier} */node;
         if (value) {
           const valueSymbol = getSymbol(value, globals, block);
-          /* istanbul ignore next */
+          /* istanbul ignore else */
           if (valueSymbol) {
-            createBlockSymbol(block, node.name, valueSymbol, globals, isGlobal);
-            return block.props[node.name];
+            createBlockSymbol(block, nde.name, valueSymbol, globals, isGlobal);
+            return block.props[nde.name];
           }
 
           /* istanbul ignore next */
-          debug('Identifier: Missing value symbol for %s', node.name);
+          debug('Identifier: Missing value symbol for %s', nde.name);
         } else {
-          createBlockSymbol(block, node.name, createNode(), globals, isGlobal);
-          return block.props[node.name];
+          createBlockSymbol(block, nde.name, createNode(), globals, isGlobal);
+          return block.props[nde.name];
         }
 
         /* istanbul ignore next */
@@ -210,48 +310,58 @@ createSymbol = function (node, globals, value, scope, isGlobal) {
       }
     case 'MemberExpression':
       {
-        symbol = getSymbol(node.object, globals, block);
-        const propertySymbol = getSymbol(node.property, globals, block, {
-          simpleIdentifier: !node.computed
+        const nde = /** @type {import('estree').MemberExpression} */node;
+        symbol = getSymbol( /** @type {import('eslint').Rule.Node} */nde.object, globals, block);
+        const propertySymbol = getSymbol( /** @type {import('eslint').Rule.Node} */nde.property, globals, block, {
+          simpleIdentifier: !nde.computed
         });
         const propertyValue = getSymbolValue(propertySymbol);
         if (symbol && propertyValue) {
-          createBlockSymbol(symbol, propertyValue, getSymbol(value, globals, block), globals, isGlobal);
+          createBlockSymbol(symbol, propertyValue, getSymbol( /** @type {import('eslint').Rule.Node} */
+          value, globals, block), globals, isGlobal);
           return symbol.props[propertyValue];
         }
-
-        /* istanbul ignore next */
-        debug('MemberExpression: Missing symbol: %s', node.property.name);
+        debug('MemberExpression: Missing symbol: %s', /** @type {import('estree').Identifier} */nde.property.name);
         break;
       }
   }
   return null;
 };
 
-// Creates variables from variable definitions
+/**
+ * Creates variables from variable definitions
+ * @param {import('eslint').Rule.Node} node
+ * @param {CreatedNode} globals
+ * @param {import('./rules/requireJsdoc.js').RequireJsdocOpts} opts
+ * @returns {void}
+ */
 const initVariables = function (node, globals, opts) {
   // eslint-disable-next-line default-case
   switch (node.type) {
     case 'Program':
       {
         for (const childNode of node.body) {
-          initVariables(childNode, globals, opts);
+          initVariables( /** @type {import('eslint').Rule.Node} */
+          childNode, globals, opts);
         }
         break;
       }
     case 'ExpressionStatement':
       {
-        initVariables(node.expression, globals, opts);
+        initVariables( /** @type {import('eslint').Rule.Node} */
+        node.expression, globals, opts);
         break;
       }
     case 'VariableDeclaration':
       {
         for (const declaration of node.declarations) {
           // let and const
-          const symbol = createSymbol(declaration.id, globals, null, globals);
+          const symbol = createSymbol( /** @type {import('eslint').Rule.Node} */
+          declaration.id, globals, null, globals);
           if (opts.initWindow && node.kind === 'var' && globals.props.window) {
             // If var, also add to window
-            globals.props.window.props[declaration.id.name] = symbol;
+            globals.props.window.props[/** @type {import('estree').Identifier} */
+            declaration.id.name] = symbol;
           }
         }
         break;
@@ -259,16 +369,26 @@ const initVariables = function (node, globals, opts) {
     case 'ExportNamedDeclaration':
       {
         if (node.declaration) {
-          initVariables(node.declaration, globals, opts);
+          initVariables( /** @type {import('eslint').Rule.Node} */
+          node.declaration, globals, opts);
         }
         break;
       }
   }
 };
 
-// Populates variable maps using AST
-// eslint-disable-next-line complexity
+/* eslint-disable complexity -- Temporary */
+
+/**
+ * Populates variable maps using AST
+ * @param {import('eslint').Rule.Node} node
+ * @param {CreatedNode} globals
+ * @param {import('./rules/requireJsdoc.js').RequireJsdocOpts} opt
+ * @param {true} [isExport]
+ * @returns {boolean}
+ */
 const mapVariables = function (node, globals, opt, isExport) {
+  /* eslint-enable complexity -- Temporary */
   /* istanbul ignore next */
   const opts = opt || {};
   /* istanbul ignore next */
@@ -279,25 +399,31 @@ const mapVariables = function (node, globals, opt, isExport) {
           return false;
         }
         for (const childNode of node.body) {
-          mapVariables(childNode, globals, opts);
+          mapVariables( /** @type {import('eslint').Rule.Node} */
+          childNode, globals, opts);
         }
         break;
       }
     case 'ExpressionStatement':
       {
-        mapVariables(node.expression, globals, opts);
+        mapVariables( /** @type {import('eslint').Rule.Node} */
+        node.expression, globals, opts);
         break;
       }
     case 'AssignmentExpression':
       {
-        createSymbol(node.left, globals, node.right);
+        createSymbol( /** @type {import('eslint').Rule.Node} */
+        node.left, globals, /** @type {import('eslint').Rule.Node} */
+        node.right);
         break;
       }
     case 'VariableDeclaration':
       {
         for (const declaration of node.declarations) {
-          const isGlobal = opts.initWindow && node.kind === 'var' && globals.props.window;
-          const symbol = createSymbol(declaration.id, globals, declaration.init, globals, isGlobal);
+          const isGlobal = Boolean(opts.initWindow && node.kind === 'var' && globals.props.window);
+          const symbol = createSymbol( /** @type {import('eslint').Rule.Node} */
+          declaration.id, globals, /** @type {import('eslint').Rule.Node} */
+          declaration.init, globals, isGlobal);
           if (symbol && isExport) {
             symbol.exported = true;
           }
@@ -306,19 +432,24 @@ const mapVariables = function (node, globals, opt, isExport) {
       }
     case 'FunctionDeclaration':
       {
-        /* istanbul ignore next */
-        if (node.id.type === 'Identifier') {
-          createSymbol(node.id, globals, node, globals, true);
+        /* istanbul ignore if */
+        if ( /** @type {import('estree').Identifier} */node.id.type === 'Identifier') {
+          createSymbol( /** @type {import('eslint').Rule.Node} */
+          node.id, globals, node, globals, true);
         }
         break;
       }
     case 'ExportDefaultDeclaration':
       {
-        const symbol = createSymbol(node.declaration, globals, node.declaration);
+        const symbol = createSymbol( /** @type {import('eslint').Rule.Node} */
+        node.declaration, globals, /** @type {import('eslint').Rule.Node} */
+        node.declaration);
         if (symbol) {
           symbol.exported = true;
-        } else if (!node.id) {
-          globals.ANONYMOUS_DEFAULT = node.declaration;
+        } else {
+          // if (!node.id) {
+          globals.ANONYMOUS_DEFAULT = /** @type {import('eslint').Rule.Node} */
+          node.declaration;
         }
         break;
       }
@@ -326,24 +457,29 @@ const mapVariables = function (node, globals, opt, isExport) {
       {
         if (node.declaration) {
           if (node.declaration.type === 'VariableDeclaration') {
-            mapVariables(node.declaration, globals, opts, true);
+            mapVariables( /** @type {import('eslint').Rule.Node} */
+            node.declaration, globals, opts, true);
           } else {
-            const symbol = createSymbol(node.declaration, globals, node.declaration);
-            /* istanbul ignore next */
+            const symbol = createSymbol( /** @type {import('eslint').Rule.Node} */
+            node.declaration, globals, /** @type {import('eslint').Rule.Node} */
+            node.declaration);
+            /* istanbul ignore if */
             if (symbol) {
               symbol.exported = true;
             }
           }
         }
         for (const specifier of node.specifiers) {
-          mapVariables(specifier, globals, opts);
+          mapVariables( /** @type {import('eslint').Rule.Node} */
+          specifier, globals, opts);
         }
         break;
       }
     case 'ExportSpecifier':
       {
-        const symbol = getSymbol(node.local, globals, globals);
-        /* istanbul ignore next */
+        const symbol = getSymbol( /** @type {import('eslint').Rule.Node} */
+        node.local, globals, globals);
+        /* istanbul ignore if */
         if (symbol) {
           symbol.exported = true;
         }
@@ -351,7 +487,7 @@ const mapVariables = function (node, globals, opt, isExport) {
       }
     case 'ClassDeclaration':
       {
-        createSymbol(node.id, globals, node.body, globals);
+        createSymbol( /** @type {import('eslint').Rule.Node|null} */node.id, globals, /** @type {import('eslint').Rule.Node} */node.body, globals);
         break;
       }
     default:
@@ -362,20 +498,30 @@ const mapVariables = function (node, globals, opt, isExport) {
   }
   return true;
 };
+
+/**
+ *
+ * @param {import('eslint').Rule.Node} node
+ * @param {CreatedNode|ValueObject|string|undefined|
+ *   import('eslint').Rule.Node} block
+ * @param {(CreatedNode|ValueObject|string|
+ *   import('eslint').Rule.Node)[]} [cache]
+ * @returns {boolean}
+ */
 const findNode = function (node, block, cache) {
   let blockCache = cache || [];
-  /* istanbul ignore next */
   if (!block || blockCache.includes(block)) {
     return false;
   }
   blockCache = blockCache.slice();
   blockCache.push(block);
-  if ((block.type === 'object' || block.type === 'MethodDefinition') && block.value === node) {
+  if (typeof block === 'object' && 'type' in block && (block.type === 'object' || block.type === 'MethodDefinition') && block.value === node) {
     return true;
   }
-  const {
-    props = block.body
-  } = block;
+  if (typeof block !== 'object') {
+    return false;
+  }
+  const props = 'props' in block && block.props || 'body' in block && block.body;
   for (const propval of Object.values(props || {})) {
     if (Array.isArray(propval)) {
       /* istanbul ignore if */
@@ -392,6 +538,11 @@ const findNode = function (node, block, cache) {
 };
 const exportTypes = new Set(['ExportNamedDeclaration', 'ExportDefaultDeclaration']);
 const ignorableNestedTypes = new Set(['FunctionDeclaration', 'ArrowFunctionExpression', 'FunctionExpression']);
+
+/**
+ * @param {import('eslint').Rule.Node} nde
+ * @returns {import('eslint').Rule.Node|false}
+ */
 const getExportAncestor = function (nde) {
   let node = nde;
   let idx = 0;
@@ -411,6 +562,11 @@ const getExportAncestor = function (nde) {
 };
 const canBeExportedByAncestorType = new Set(['TSPropertySignature', 'TSMethodSignature', 'ClassProperty', 'PropertyDefinition', 'Method']);
 const canExportChildrenType = new Set(['TSInterfaceBody', 'TSInterfaceDeclaration', 'TSTypeLiteral', 'TSTypeAliasDeclaration', 'ClassDeclaration', 'ClassBody', 'ClassDefinition', 'ClassExpression', 'Program']);
+
+/**
+ * @param {import('eslint').Rule.Node} nde
+ * @returns {false|import('eslint').Rule.Node}
+ */
 const isExportByAncestor = function (nde) {
   if (!canBeExportedByAncestorType.has(nde.type)) {
     return false;
@@ -427,8 +583,16 @@ const isExportByAncestor = function (nde) {
   }
   return false;
 };
+
+/**
+ *
+ * @param {CreatedNode} block
+ * @param {import('eslint').Rule.Node} node
+ * @param {CreatedNode[]} [cache] Currently unused
+ * @returns {boolean}
+ */
 const findExportedNode = function (block, node, cache) {
-  /* istanbul ignore next */
+  /* istanbul ignore if */
   if (block === null) {
     return false;
   }
@@ -437,8 +601,9 @@ const findExportedNode = function (block, node, cache) {
     props
   } = block;
   for (const propval of Object.values(props)) {
-    blockCache.push(propval);
-    if (propval.exported && (node === propval.value || findNode(node, propval.value))) {
+    const pval = /** @type {CreatedNode} */propval;
+    blockCache.push(pval);
+    if (pval.exported && (node === pval.value || findNode(node, pval.value))) {
       return true;
     }
 
@@ -448,6 +613,14 @@ const findExportedNode = function (block, node, cache) {
 
   return false;
 };
+
+/**
+ *
+ * @param {import('eslint').Rule.Node} node
+ * @param {CreatedNode} globals
+ * @param {import('./rules/requireJsdoc.js').RequireJsdocOpts} opt
+ * @returns {boolean}
+ */
 const isNodeExported = function (node, globals, opt) {
   var _globals$props$module, _globals$props$module2;
   const moduleExports = (_globals$props$module = globals.props.module) === null || _globals$props$module === void 0 ? void 0 : (_globals$props$module2 = _globals$props$module.props) === null || _globals$props$module2 === void 0 ? void 0 : _globals$props$module2.exports;
@@ -462,6 +635,14 @@ const isNodeExported = function (node, globals, opt) {
   }
   return false;
 };
+
+/**
+ *
+ * @param {import('eslint').Rule.Node} node
+ * @param {CreatedNode} globalVars
+ * @param {import('./rules/requireJsdoc.js').RequireJsdocOpts} opts
+ * @returns {boolean}
+ */
 const parseRecursive = function (node, globalVars, opts) {
   // Iterate from top using recursion - stop at first processed node from top
   if (node.parent && parseRecursive(node.parent, globalVars, opts)) {
@@ -469,6 +650,14 @@ const parseRecursive = function (node, globalVars, opts) {
   }
   return mapVariables(node, globalVars, opts);
 };
+
+/**
+ *
+ * @param {import('eslint').Rule.Node} ast
+ * @param {import('eslint').Rule.Node} node
+ * @param {import('./rules/requireJsdoc.js').RequireJsdocOpts} opt
+ * @returns {CreatedNode}
+ */
 const parse = function (ast, node, opt) {
   /* istanbul ignore next */
   const opts = opt || {
@@ -494,9 +683,19 @@ const parse = function (ast, node, opt) {
     mapVariables(ast, globalVars, opts);
   }
   return {
-    globalVars
+    globalVars,
+    props: {}
   };
 };
+
+/**
+ *
+ * @param {import('eslint').Rule.Node} node
+ * @param {import('eslint').SourceCode} sourceCode
+ * @param {import('./rules/requireJsdoc.js').RequireJsdocOpts} opt
+ * @param {import('./iterateJsdoc.js').Settings} settings
+ * @returns {boolean}
+ */
 const isUncommentedExport = function (node, sourceCode, opt, settings) {
   // console.log({node});
   // Optimize with ancestor check for esm
@@ -515,8 +714,10 @@ const isUncommentedExport = function (node, sourceCode, opt, settings) {
       return true;
     }
   }
-  const parseResult = parse(sourceCode.ast, node, opt);
-  return isNodeExported(node, parseResult.globalVars, opt);
+  const ast = /** @type {unknown} */sourceCode.ast;
+  const parseResult = parse( /** @type {import('eslint').Rule.Node} */
+  ast, node, opt);
+  return isNodeExported(node, /** @type {CreatedNode} */parseResult.globalVars, opt);
 };
 var _default = {
   isUncommentedExport,