eslint-plugin-jsdoc 57.2.1 → 58.0.0

package/dist/rules/checkTypes.cjs

@@ -4,400 +4,94 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-var _jsdoccomment = require("@es-joy/jsdoccomment");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+var _buildRejectOrPreferRuleDefinition = require("../buildRejectOrPreferRuleDefinition.cjs");
 const strictNativeTypes = ['undefined', 'null', 'boolean', 'number', 'bigint', 'string', 'symbol', 'object', 'Array', 'Function', 'Date', 'RegExp'];
 
 /**
- * Adjusts the parent type node `meta` for generic matches (or type node
- * `type` for `JsdocTypeAny`) and sets the type node `value`.
- * @param {string} type The actual type
- * @param {string} preferred The preferred type
- * @param {boolean} isGenericMatch
+ * @callback CheckNativeTypes
+ * Iterates strict types to see if any should be added to `invalidTypes` (and
+ * the the relevant strict type returned as the new preferred type).
+ * @param {import('../iterateJsdoc.js').PreferredTypes} preferredTypes
  * @param {string} typeNodeName
- * @param {import('jsdoc-type-pratt-parser').NonRootResult} node
+ * @param {string|undefined} preferred
  * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode
- * @returns {void}
+ * @param {(string|false|undefined)[][]} invalidTypes
+ * @returns {string|undefined} The `preferred` type string, optionally changed
  */
-const adjustNames = (type, preferred, isGenericMatch, typeNodeName, node, parentNode) => {
-  let ret = preferred;
-  if (isGenericMatch) {
-    const parentMeta = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */parentNode.meta;
-    if (preferred === '[]') {
-      parentMeta.brackets = 'square';
-      parentMeta.dot = false;
-      ret = 'Array';
-    } else {
-      const dotBracketEnd = preferred.match(/\.(?:<>)?$/v);
-      if (dotBracketEnd) {
-        parentMeta.brackets = 'angle';
-        parentMeta.dot = true;
-        ret = preferred.slice(0, -dotBracketEnd[0].length);
-      } else {
-        const bracketEnd = preferred.endsWith('<>');
-        if (bracketEnd) {
-          parentMeta.brackets = 'angle';
-          parentMeta.dot = false;
-          ret = preferred.slice(0, -2);
-        } else if (parentMeta?.brackets === 'square' && (typeNodeName === '[]' || typeNodeName === 'Array')) {
-          parentMeta.brackets = 'angle';
-          parentMeta.dot = false;
-        }
-      }
-    }
-  } else if (type === 'JsdocTypeAny') {
-    node.type = 'JsdocTypeName';
-  }
-
-  /** @type {import('jsdoc-type-pratt-parser').NameResult} */
-  node.value = ret.replace(/(?:\.|<>|\.<>|\[\])$/v, '');
-
-  // For bare pseudo-types like `<>`
-  if (!ret) {
-    /** @type {import('jsdoc-type-pratt-parser').NameResult} */node.value = typeNodeName;
-  }
-};
-
-/**
- * @param {boolean} [upperCase]
- * @returns {string}
- */
-const getMessage = upperCase => {
-  return 'Use object shorthand or index signatures instead of ' + '`' + (upperCase ? 'O' : 'o') + 'bject`, e.g., `{[key: string]: string}`';
-};
-
-/**
- * @type {{
- *   message: string,
- *   replacement: false
- * }}
- */
-const info = {
-  message: getMessage(),
-  replacement: false
-};
-
-/**
- * @type {{
- *   message: string,
- *   replacement: false
- * }}
- */
-const infoUC = {
-  message: getMessage(true),
-  replacement: false
-};
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  context,
-  jsdocNode,
-  report,
-  settings,
-  sourceCode,
-  utils
-}) => {
-  const jsdocTagsWithPossibleType = utils.filterTags(tag => {
-    return Boolean(utils.tagMightHaveTypePosition(tag.tag));
-  });
-  const
-  /**
-   * @type {{
-   *   preferredTypes: import('../iterateJsdoc.js').PreferredTypes,
-   *   structuredTags: import('../iterateJsdoc.js').StructuredTags,
-   *   mode: import('../jsdocUtils.js').ParserMode
-   * }}
-   */
-  {
-    mode,
-    preferredTypes: preferredTypesOriginal,
-    structuredTags
-  } = settings;
-  const injectObjectPreferredTypes = !('Object' in preferredTypesOriginal || 'object' in preferredTypesOriginal || 'object.<>' in preferredTypesOriginal || 'Object.<>' in preferredTypesOriginal || 'object<>' in preferredTypesOriginal);
-
-  /** @type {import('../iterateJsdoc.js').PreferredTypes} */
-  const typeToInject = mode === 'typescript' ? {
-    Object: 'object',
-    'object.<>': info,
-    'Object.<>': infoUC,
-    'object<>': info,
-    'Object<>': infoUC
-  } : {
-    Object: 'object',
-    'object.<>': 'Object<>',
-    'Object.<>': 'Object<>',
-    'object<>': 'Object<>'
-  };
-
-  /** @type {import('../iterateJsdoc.js').PreferredTypes} */
-  const preferredTypes = {
-    ...(injectObjectPreferredTypes ? typeToInject : {}),
-    ...preferredTypesOriginal
-  };
-  const
-  /**
-   * @type {{
-   *   noDefaults: boolean,
-   *   unifyParentAndChildTypeChecks: boolean,
-   *   exemptTagContexts: ({
-   *     tag: string,
-   *     types: true|string[]
-   *   })[]
-   * }}
-   */
-  {
-    exemptTagContexts = [],
-    noDefaults,
-    unifyParentAndChildTypeChecks
-  } = context.options[0] || {};
-
-  /**
-   * Gets information about the preferred type: whether there is a matching
-   * preferred type, what the type is, and whether it is a match to a generic.
-   * @param {string} _type Not currently in use
-   * @param {string} typeNodeName
-   * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode
-   * @param {string|undefined} property
-   * @returns {[hasMatchingPreferredType: boolean, typeName: string, isGenericMatch: boolean]}
-   */
-  const getPreferredTypeInfo = (_type, typeNodeName, parentNode, property) => {
-    let hasMatchingPreferredType = false;
-    let isGenericMatch = false;
-    let typeName = typeNodeName;
-    const isNameOfGeneric = parentNode !== undefined && parentNode.type === 'JsdocTypeGeneric' && property === 'left';
-    const brackets = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */parentNode?.meta?.brackets;
-    const dot = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */parentNode?.meta?.dot;
-    if (brackets === 'angle') {
-      const checkPostFixes = dot ? ['.', '.<>'] : ['<>'];
-      isGenericMatch = checkPostFixes.some(checkPostFix => {
-        const preferredType = preferredTypes?.[typeNodeName + checkPostFix];
 
-        // Does `unifyParentAndChildTypeChecks` need to be checked here?
-        if ((unifyParentAndChildTypeChecks || isNameOfGeneric || (/* c8 ignore next 2 -- If checking `unifyParentAndChildTypeChecks` */
-        typeof preferredType === 'object' && preferredType?.unifyParentAndChildTypeChecks)) && preferredType !== undefined) {
-          typeName += checkPostFix;
-          return true;
-        }
-        return false;
-      });
-    }
-    if (!isGenericMatch && property && /** @type {import('jsdoc-type-pratt-parser').NonRootResult} */parentNode.type === 'JsdocTypeGeneric') {
-      const checkPostFixes = dot ? ['.', '.<>'] : [brackets === 'angle' ? '<>' : '[]'];
-      isGenericMatch = checkPostFixes.some(checkPostFix => {
-        const preferredType = preferredTypes?.[checkPostFix];
-        if (
-        // Does `unifyParentAndChildTypeChecks` need to be checked here?
-        (unifyParentAndChildTypeChecks || isNameOfGeneric || (/* c8 ignore next 2 -- If checking `unifyParentAndChildTypeChecks` */
-        typeof preferredType === 'object' && preferredType?.unifyParentAndChildTypeChecks)) && preferredType !== undefined) {
-          typeName = checkPostFix;
-          return true;
-        }
-        return false;
-      });
-    }
-    const prefType = preferredTypes?.[typeNodeName];
-    const directNameMatch = prefType !== undefined && !Object.values(preferredTypes).includes(typeNodeName);
-    const specificUnify = typeof prefType === 'object' && prefType?.unifyParentAndChildTypeChecks;
-    const unifiedSyntaxParentMatch = property && directNameMatch && (unifyParentAndChildTypeChecks || specificUnify);
-    isGenericMatch = isGenericMatch || Boolean(unifiedSyntaxParentMatch);
-    hasMatchingPreferredType = isGenericMatch || directNameMatch && !property;
-    return [hasMatchingPreferredType, typeName, isGenericMatch];
-  };
-
-  /**
-   * Iterates strict types to see if any should be added to `invalidTypes` (and
-   * the the relevant strict type returned as the new preferred type).
-   * @param {string} typeNodeName
-   * @param {string|undefined} preferred
-   * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode
-   * @param {(string|false|undefined)[][]} invalidTypes
-   * @returns {string|undefined} The `preferred` type string, optionally changed
-   */
-  const checkNativeTypes = (typeNodeName, preferred, parentNode, invalidTypes) => {
-    let changedPreferred = preferred;
-    for (const strictNativeType of strictNativeTypes) {
-      if (strictNativeType === 'object' && (
-      // This is not set to remap with exact type match (e.g.,
-      //   `object: 'Object'`), so can ignore (including if circular)
-      !preferredTypes?.[typeNodeName] ||
-      // Although present on `preferredTypes` for remapping, this is a
-      //   parent object without a parent match (and not
-      //   `unifyParentAndChildTypeChecks`) and we don't want
-      //   `object<>` given TypeScript issue https://github.com/microsoft/TypeScript/issues/20555
-      /**
-       * @type {import('jsdoc-type-pratt-parser').GenericResult}
-       */
-      parentNode?.elements?.length && (
-      /**
-       * @type {import('jsdoc-type-pratt-parser').GenericResult}
-       */
-      parentNode?.left?.type === 'JsdocTypeName' &&
-      /**
-       * @type {import('jsdoc-type-pratt-parser').GenericResult}
-       */
-      parentNode?.left?.value === 'Object'))) {
-        continue;
-      }
-      if (strictNativeType !== typeNodeName && strictNativeType.toLowerCase() === typeNodeName.toLowerCase() && (
-      // Don't report if user has own map for a strict native type
-      !preferredTypes || preferredTypes?.[strictNativeType] === undefined)) {
-        changedPreferred = strictNativeType;
-        invalidTypes.push([typeNodeName, changedPreferred]);
-        break;
-      }
-    }
-    return changedPreferred;
-  };
-
-  /**
-   * Collect invalid type info.
-   * @param {string} type
-   * @param {string} value
-   * @param {string} tagName
-   * @param {string} nameInTag
-   * @param {number} idx
-   * @param {string|undefined} property
-   * @param {import('jsdoc-type-pratt-parser').NonRootResult} node
-   * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode
-   * @param {(string|false|undefined)[][]} invalidTypes
-   * @returns {void}
-   */
-  const getInvalidTypes = (type, value, tagName, nameInTag, idx, property, node, parentNode, invalidTypes) => {
-    let typeNodeName = type === 'JsdocTypeAny' ? '*' : value;
-    const [hasMatchingPreferredType, typeName, isGenericMatch] = getPreferredTypeInfo(type, typeNodeName, parentNode, property);
-    let preferred;
-    let types;
-    if (hasMatchingPreferredType) {
-      const preferredSetting = preferredTypes[typeName];
-      typeNodeName = typeName === '[]' ? typeName : typeNodeName;
-      if (!preferredSetting) {
-        invalidTypes.push([typeNodeName]);
-      } else if (typeof preferredSetting === 'string') {
-        preferred = preferredSetting;
-        invalidTypes.push([typeNodeName, preferred]);
-      } else if (preferredSetting && typeof preferredSetting === 'object') {
-        const nextItem = preferredSetting.skipRootChecking && jsdocTagsWithPossibleType[idx + 1];
-        if (!nextItem || !nextItem.name.startsWith(`${nameInTag}.`)) {
-          preferred = preferredSetting.replacement;
-          invalidTypes.push([typeNodeName, preferred, preferredSetting.message]);
-        }
-      } else {
-        utils.reportSettings('Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.');
-        return;
-      }
-    } else if (Object.entries(structuredTags).some(([tag, {
-      type: typs
-    }]) => {
-      types = typs;
-      return tag === tagName && Array.isArray(types) && !types.includes(typeNodeName);
-    })) {
-      invalidTypes.push([typeNodeName, types]);
-    } else if (!noDefaults && type === 'JsdocTypeName') {
-      preferred = checkNativeTypes(typeNodeName, preferred, parentNode, invalidTypes);
-    }
-
-    // For fixer
-    if (preferred) {
-      adjustNames(type, preferred, isGenericMatch, typeNodeName, node, parentNode);
-    }
-  };
-  for (const [idx, jsdocTag] of jsdocTagsWithPossibleType.entries()) {
-    /** @type {(string|false|undefined)[][]} */
-    const invalidTypes = [];
-    let typeAst;
-    try {
-      typeAst = mode === 'permissive' ? (0, _jsdoccomment.tryParse)(jsdocTag.type) : (0, _jsdoccomment.parse)(jsdocTag.type, mode);
-    } catch {
+/** @type {CheckNativeTypes} */
+const checkNativeTypes = (preferredTypes, typeNodeName, preferred, parentNode, invalidTypes) => {
+  let changedPreferred = preferred;
+  for (const strictNativeType of strictNativeTypes) {
+    if (strictNativeType === 'object' && (
+    // This is not set to remap with exact type match (e.g.,
+    //   `object: 'Object'`), so can ignore (including if circular)
+    !preferredTypes?.[typeNodeName] ||
+    // Although present on `preferredTypes` for remapping, this is a
+    //   parent object without a parent match (and not
+    //   `unifyParentAndChildTypeChecks`) and we don't want
+    //   `object<>` given TypeScript issue https://github.com/microsoft/TypeScript/issues/20555
+    /**
+     * @type {import('jsdoc-type-pratt-parser').GenericResult}
+     */
+    parentNode?.elements?.length && (
+    /**
+     * @type {import('jsdoc-type-pratt-parser').GenericResult}
+     */
+    parentNode?.left?.type === 'JsdocTypeName' &&
+    /**
+     * @type {import('jsdoc-type-pratt-parser').GenericResult}
+     */
+    parentNode?.left?.value === 'Object'))) {
       continue;
     }
-    const {
-      name: nameInTag,
-      tag: tagName
-    } = jsdocTag;
-    (0, _jsdoccomment.traverse)(typeAst, (node, parentNode, property) => {
-      const {
-        type,
-        value
-      } =
-      /**
-       * @type {import('jsdoc-type-pratt-parser').NameResult}
-       */
-      node;
-      if (!['JsdocTypeAny', 'JsdocTypeName'].includes(type)) {
-        return;
-      }
-      getInvalidTypes(type, value, tagName, nameInTag, idx, property, node, parentNode, invalidTypes);
-    });
-    if (invalidTypes.length) {
-      const fixedType = (0, _jsdoccomment.stringify)(typeAst);
-
-      /**
-       * @type {import('eslint').Rule.ReportFixer}
-       */
-      const fix = fixer => {
-        return fixer.replaceText(jsdocNode, sourceCode.getText(jsdocNode).replace(`{${jsdocTag.type}}`, `{${fixedType}}`));
-      };
-      for (const [badType, preferredType = '', msg] of invalidTypes) {
-        const tagValue = jsdocTag.name ? ` "${jsdocTag.name}"` : '';
-        if (exemptTagContexts.some(({
-          tag,
-          types
-        }) => {
-          return tag === tagName && (types === true || types.includes(jsdocTag.type));
-        })) {
-          continue;
-        }
-        report(msg || `Invalid JSDoc @${tagName}${tagValue} type "${badType}"` + (preferredType ? '; ' : '.') + (preferredType ? `prefer: ${JSON.stringify(preferredType)}.` : ''), preferredType ? fix : null, jsdocTag, msg ? {
-          tagName,
-          tagValue
-        } : undefined);
-      }
+    if (strictNativeType !== typeNodeName && strictNativeType.toLowerCase() === typeNodeName.toLowerCase() && (
+    // Don't report if user has own map for a strict native type
+    !preferredTypes || preferredTypes?.[strictNativeType] === undefined)) {
+      changedPreferred = strictNativeType;
+      invalidTypes.push([typeNodeName, changedPreferred]);
+      break;
     }
   }
-}, {
-  iterateAllJsdocs: true,
-  meta: {
-    docs: {
-      description: 'Reports invalid types.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-types.md#repos-sticky-header'
-    },
-    fixable: 'code',
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        exemptTagContexts: {
-          items: {
-            additionalProperties: false,
-            properties: {
-              tag: {
-                type: 'string'
-              },
-              types: {
-                oneOf: [{
-                  type: 'boolean'
-                }, {
-                  items: {
-                    type: 'string'
-                  },
-                  type: 'array'
-                }]
-              }
+  return changedPreferred;
+};
+var _default = exports.default = (0, _buildRejectOrPreferRuleDefinition.buildRejectOrPreferRuleDefinition)({
+  checkNativeTypes,
+  schema: [{
+    additionalProperties: false,
+    properties: {
+      exemptTagContexts: {
+        items: {
+          additionalProperties: false,
+          properties: {
+            tag: {
+              type: 'string'
             },
-            type: 'object'
+            types: {
+              oneOf: [{
+                type: 'boolean'
+              }, {
+                items: {
+                  type: 'string'
+                },
+                type: 'array'
+              }]
+            }
           },
-          type: 'array'
+          type: 'object'
         },
-        noDefaults: {
-          type: 'boolean'
-        },
-        unifyParentAndChildTypeChecks: {
-          description: '@deprecated Use the `preferredTypes[preferredType]` setting of the same name instead',
-          type: 'boolean'
-        }
+        type: 'array'
       },
-      type: 'object'
-    }],
-    type: 'suggestion'
-  }
+      noDefaults: {
+        type: 'boolean'
+      },
+      unifyParentAndChildTypeChecks: {
+        description: '@deprecated Use the `preferredTypes[preferredType]` setting of the same name instead',
+        type: 'boolean'
+      }
+    },
+    type: 'object'
+  }]
 });
 module.exports = exports.default;
 //# sourceMappingURL=checkTypes.cjs.map

package/dist/rules/checkTypes.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"checkTypes.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","_jsdoccomment","e","__esModule","default","strictNativeTypes","adjustNames","type","preferred","isGenericMatch","typeNodeName","node","parentNode","ret","parentMeta","meta","brackets","dot","dotBracketEnd","match","slice","length","bracketEnd","endsWith","value","replace","getMessage","upperCase","info","message","replacement","infoUC","_default","exports","iterateJsdoc","context","jsdocNode","report","settings","sourceCode","utils","jsdocTagsWithPossibleType","filterTags","tag","Boolean","tagMightHaveTypePosition","mode","preferredTypes","preferredTypesOriginal","structuredTags","injectObjectPreferredTypes","typeToInject","Object","exemptTagContexts","noDefaults","unifyParentAndChildTypeChecks","options","getPreferredTypeInfo","_type","property","hasMatchingPreferredType","typeName","isNameOfGeneric","undefined","checkPostFixes","some","checkPostFix","preferredType","prefType","directNameMatch","values","includes","specificUnify","unifiedSyntaxParentMatch","checkNativeTypes","invalidTypes","changedPreferred","strictNativeType","elements","left","toLowerCase","push","getInvalidTypes","tagName","nameInTag","idx","types","preferredSetting","nextItem","skipRootChecking","name","startsWith","reportSettings","entries","typs","Array","isArray","jsdocTag","typeAst","tryParse","parse","traverse","fixedType","stringify","fix","fixer","replaceText","getText","badType","msg","tagValue","JSON","iterateAllJsdocs","docs","description","url","fixable","schema","additionalProperties","properties","items","oneOf","module"],"sources":["../../src/rules/checkTypes.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  parse,\n  stringify,\n  traverse,\n  tryParse,\n} from '@es-joy/jsdoccomment';\n\nconst strictNativeTypes = [\n  'undefined',\n  'null',\n  'boolean',\n  'number',\n  'bigint',\n  'string',\n  'symbol',\n  'object',\n  'Array',\n  'Function',\n  'Date',\n  'RegExp',\n];\n\n/**\n * Adjusts the parent type node `meta` for generic matches (or type node\n * `type` for `JsdocTypeAny`) and sets the type node `value`.\n * @param {string} type The actual type\n * @param {string} preferred The preferred type\n * @param {boolean} isGenericMatch\n * @param {string} typeNodeName\n * @param {import('jsdoc-type-pratt-parser').NonRootResult} node\n * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode\n * @returns {void}\n */\nconst adjustNames = (type, preferred, isGenericMatch, typeNodeName, node, parentNode) => {\n  let ret = preferred;\n  if (isGenericMatch) {\n    const parentMeta = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */ (\n      parentNode\n    ).meta;\n    if (preferred === '[]') {\n      parentMeta.brackets = 'square';\n      parentMeta.dot = false;\n      ret = 'Array';\n    } else {\n      const dotBracketEnd = preferred.match(/\\.(?:<>)?$/v);\n      if (dotBracketEnd) {\n        parentMeta.brackets = 'angle';\n        parentMeta.dot = true;\n        ret = preferred.slice(0, -dotBracketEnd[0].length);\n      } else {\n        const bracketEnd = preferred.endsWith('<>');\n        if (bracketEnd) {\n          parentMeta.brackets = 'angle';\n          parentMeta.dot = false;\n          ret = preferred.slice(0, -2);\n        } else if (\n          parentMeta?.brackets === 'square' &&\n          (typeNodeName === '[]' || typeNodeName === 'Array')\n        ) {\n          parentMeta.brackets = 'angle';\n          parentMeta.dot = false;\n        }\n      }\n    }\n  } else if (type === 'JsdocTypeAny') {\n    node.type = 'JsdocTypeName';\n  }\n\n  /** @type {import('jsdoc-type-pratt-parser').NameResult} */ (\n    node\n  ).value = ret.replace(/(?:\\.|<>|\\.<>|\\[\\])$/v, '');\n\n  // For bare pseudo-types like `<>`\n  if (!ret) {\n    /** @type {import('jsdoc-type-pratt-parser').NameResult} */ (\n      node\n    ).value = typeNodeName;\n  }\n};\n\n/**\n * @param {boolean} [upperCase]\n * @returns {string}\n */\nconst getMessage = (upperCase) => {\n  return 'Use object shorthand or index signatures instead of ' +\n  '`' + (upperCase ? 'O' : 'o') + 'bject`, e.g., `{[key: string]: string}`';\n};\n\n/**\n * @type {{\n *   message: string,\n *   replacement: false\n * }}\n */\nconst info = {\n  message: getMessage(),\n  replacement: false,\n};\n\n/**\n * @type {{\n *   message: string,\n *   replacement: false\n * }}\n */\nconst infoUC = {\n  message: getMessage(true),\n  replacement: false,\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdocNode,\n  report,\n  settings,\n  sourceCode,\n  utils,\n}) => {\n  const jsdocTagsWithPossibleType = utils.filterTags((tag) => {\n    return Boolean(utils.tagMightHaveTypePosition(tag.tag));\n  });\n\n  const\n    /**\n     * @type {{\n     *   preferredTypes: import('../iterateJsdoc.js').PreferredTypes,\n     *   structuredTags: import('../iterateJsdoc.js').StructuredTags,\n     *   mode: import('../jsdocUtils.js').ParserMode\n     * }}\n     */\n    {\n      mode,\n      preferredTypes: preferredTypesOriginal,\n      structuredTags,\n    } = settings;\n\n  const injectObjectPreferredTypes = !('Object' in preferredTypesOriginal ||\n    'object' in preferredTypesOriginal ||\n    'object.<>' in preferredTypesOriginal ||\n    'Object.<>' in preferredTypesOriginal ||\n    'object<>' in preferredTypesOriginal);\n\n  /** @type {import('../iterateJsdoc.js').PreferredTypes} */\n  const typeToInject = mode === 'typescript' ?\n    {\n      Object: 'object',\n      'object.<>': info,\n      'Object.<>': infoUC,\n      'object<>': info,\n      'Object<>': infoUC,\n    } :\n    {\n      Object: 'object',\n      'object.<>': 'Object<>',\n      'Object.<>': 'Object<>',\n      'object<>': 'Object<>',\n    };\n\n  /** @type {import('../iterateJsdoc.js').PreferredTypes} */\n  const preferredTypes = {\n    ...injectObjectPreferredTypes ?\n      typeToInject :\n      {},\n    ...preferredTypesOriginal,\n  };\n\n  const\n    /**\n     * @type {{\n     *   noDefaults: boolean,\n     *   unifyParentAndChildTypeChecks: boolean,\n     *   exemptTagContexts: ({\n     *     tag: string,\n     *     types: true|string[]\n     *   })[]\n     * }}\n     */ {\n      exemptTagContexts = [],\n      noDefaults,\n      unifyParentAndChildTypeChecks,\n    } = context.options[0] || {};\n\n  /**\n   * Gets information about the preferred type: whether there is a matching\n   * preferred type, what the type is, and whether it is a match to a generic.\n   * @param {string} _type Not currently in use\n   * @param {string} typeNodeName\n   * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode\n   * @param {string|undefined} property\n   * @returns {[hasMatchingPreferredType: boolean, typeName: string, isGenericMatch: boolean]}\n   */\n  const getPreferredTypeInfo = (_type, typeNodeName, parentNode, property) => {\n    let hasMatchingPreferredType = false;\n    let isGenericMatch = false;\n    let typeName = typeNodeName;\n\n    const isNameOfGeneric = parentNode !== undefined && parentNode.type === 'JsdocTypeGeneric' && property === 'left';\n\n    const brackets = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */ (\n      parentNode\n    )?.meta?.brackets;\n    const dot = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */ (\n      parentNode\n    )?.meta?.dot;\n\n    if (brackets === 'angle') {\n      const checkPostFixes = dot ? [\n        '.', '.<>',\n      ] : [\n        '<>',\n      ];\n      isGenericMatch = checkPostFixes.some((checkPostFix) => {\n        const preferredType = preferredTypes?.[typeNodeName + checkPostFix];\n\n        // Does `unifyParentAndChildTypeChecks` need to be checked here?\n        if (\n          (unifyParentAndChildTypeChecks || isNameOfGeneric ||\n            /* c8 ignore next 2 -- If checking `unifyParentAndChildTypeChecks` */\n            (typeof preferredType === 'object' &&\n              preferredType?.unifyParentAndChildTypeChecks)\n          ) &&\n          preferredType !== undefined\n        ) {\n          typeName += checkPostFix;\n\n          return true;\n        }\n\n        return false;\n      });\n    }\n\n    if (\n      !isGenericMatch && property &&\n      /** @type {import('jsdoc-type-pratt-parser').NonRootResult} */ (\n        parentNode\n      ).type === 'JsdocTypeGeneric'\n    ) {\n      const checkPostFixes = dot ? [\n        '.', '.<>',\n      ] : [\n        brackets === 'angle' ? '<>' : '[]',\n      ];\n\n      isGenericMatch = checkPostFixes.some((checkPostFix) => {\n        const preferredType = preferredTypes?.[checkPostFix];\n        if (\n          // Does `unifyParentAndChildTypeChecks` need to be checked here?\n          (unifyParentAndChildTypeChecks || isNameOfGeneric ||\n            /* c8 ignore next 2 -- If checking `unifyParentAndChildTypeChecks` */\n            (typeof preferredType === 'object' &&\n            preferredType?.unifyParentAndChildTypeChecks)) &&\n            preferredType !== undefined\n        ) {\n          typeName = checkPostFix;\n\n          return true;\n        }\n\n        return false;\n      });\n    }\n\n    const prefType = preferredTypes?.[typeNodeName];\n    const directNameMatch = prefType !== undefined &&\n      !Object.values(preferredTypes).includes(typeNodeName);\n    const specificUnify = typeof prefType === 'object' &&\n      prefType?.unifyParentAndChildTypeChecks;\n    const unifiedSyntaxParentMatch = property && directNameMatch && (unifyParentAndChildTypeChecks || specificUnify);\n    isGenericMatch = isGenericMatch || Boolean(unifiedSyntaxParentMatch);\n\n    hasMatchingPreferredType = isGenericMatch ||\n      directNameMatch && !property;\n\n    return [\n      hasMatchingPreferredType, typeName, isGenericMatch,\n    ];\n  };\n\n  /**\n   * Iterates strict types to see if any should be added to `invalidTypes` (and\n   * the the relevant strict type returned as the new preferred type).\n   * @param {string} typeNodeName\n   * @param {string|undefined} preferred\n   * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode\n   * @param {(string|false|undefined)[][]} invalidTypes\n   * @returns {string|undefined} The `preferred` type string, optionally changed\n   */\n  const checkNativeTypes = (typeNodeName, preferred, parentNode, invalidTypes) => {\n    let changedPreferred = preferred;\n    for (const strictNativeType of strictNativeTypes) {\n      if (\n        strictNativeType === 'object' &&\n        (\n          // This is not set to remap with exact type match (e.g.,\n          //   `object: 'Object'`), so can ignore (including if circular)\n          !preferredTypes?.[typeNodeName] ||\n          // Although present on `preferredTypes` for remapping, this is a\n          //   parent object without a parent match (and not\n          //   `unifyParentAndChildTypeChecks`) and we don't want\n          //   `object<>` given TypeScript issue https://github.com/microsoft/TypeScript/issues/20555\n          /**\n           * @type {import('jsdoc-type-pratt-parser').GenericResult}\n           */\n          (\n            parentNode\n          )?.elements?.length && (\n          /**\n           * @type {import('jsdoc-type-pratt-parser').GenericResult}\n           */\n            (\n              parentNode\n            )?.left?.type === 'JsdocTypeName' &&\n            /**\n             * @type {import('jsdoc-type-pratt-parser').GenericResult}\n             */\n            (parentNode)?.left?.value === 'Object'\n          )\n        )\n      ) {\n        continue;\n      }\n\n      if (strictNativeType !== typeNodeName &&\n        strictNativeType.toLowerCase() === typeNodeName.toLowerCase() &&\n\n        // Don't report if user has own map for a strict native type\n        (!preferredTypes || preferredTypes?.[strictNativeType] === undefined)\n      ) {\n        changedPreferred = strictNativeType;\n        invalidTypes.push([\n          typeNodeName, changedPreferred,\n        ]);\n        break;\n      }\n    }\n\n    return changedPreferred;\n  };\n\n  /**\n   * Collect invalid type info.\n   * @param {string} type\n   * @param {string} value\n   * @param {string} tagName\n   * @param {string} nameInTag\n   * @param {number} idx\n   * @param {string|undefined} property\n   * @param {import('jsdoc-type-pratt-parser').NonRootResult} node\n   * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode\n   * @param {(string|false|undefined)[][]} invalidTypes\n   * @returns {void}\n   */\n  const getInvalidTypes = (type, value, tagName, nameInTag, idx, property, node, parentNode, invalidTypes) => {\n    let typeNodeName = type === 'JsdocTypeAny' ? '*' : value;\n\n    const [\n      hasMatchingPreferredType,\n      typeName,\n      isGenericMatch,\n    ] = getPreferredTypeInfo(type, typeNodeName, parentNode, property);\n\n    let preferred;\n    let types;\n    if (hasMatchingPreferredType) {\n      const preferredSetting = preferredTypes[typeName];\n      typeNodeName = typeName === '[]' ? typeName : typeNodeName;\n\n      if (!preferredSetting) {\n        invalidTypes.push([\n          typeNodeName,\n        ]);\n      } else if (typeof preferredSetting === 'string') {\n        preferred = preferredSetting;\n        invalidTypes.push([\n          typeNodeName, preferred,\n        ]);\n      } else if (preferredSetting && typeof preferredSetting === 'object') {\n        const nextItem = preferredSetting.skipRootChecking && jsdocTagsWithPossibleType[idx + 1];\n\n        if (!nextItem || !nextItem.name.startsWith(`${nameInTag}.`)) {\n          preferred = preferredSetting.replacement;\n          invalidTypes.push([\n            typeNodeName,\n            preferred,\n            preferredSetting.message,\n          ]);\n        }\n      } else {\n        utils.reportSettings(\n          'Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.',\n        );\n\n        return;\n      }\n    } else if (Object.entries(structuredTags).some(([\n      tag,\n      {\n        type: typs,\n      },\n    ]) => {\n      types = typs;\n\n      return tag === tagName &&\n        Array.isArray(types) &&\n        !types.includes(typeNodeName);\n    })) {\n      invalidTypes.push([\n        typeNodeName, types,\n      ]);\n    } else if (!noDefaults && type === 'JsdocTypeName') {\n      preferred = checkNativeTypes(typeNodeName, preferred, parentNode, invalidTypes);\n    }\n\n    // For fixer\n    if (preferred) {\n      adjustNames(type, preferred, isGenericMatch, typeNodeName, node, parentNode);\n    }\n  };\n\n  for (const [\n    idx,\n    jsdocTag,\n  ] of jsdocTagsWithPossibleType.entries()) {\n    /** @type {(string|false|undefined)[][]} */\n    const invalidTypes = [];\n    let typeAst;\n\n    try {\n      typeAst = mode === 'permissive' ? tryParse(jsdocTag.type) : parse(jsdocTag.type, mode);\n    } catch {\n      continue;\n    }\n\n    const {\n      name: nameInTag,\n      tag: tagName,\n    } = jsdocTag;\n\n    traverse(typeAst, (node, parentNode, property) => {\n      const {\n        type,\n        value,\n      } =\n        /**\n         * @type {import('jsdoc-type-pratt-parser').NameResult}\n         */ (node);\n      if (![\n        'JsdocTypeAny', 'JsdocTypeName',\n      ].includes(type)) {\n        return;\n      }\n\n      getInvalidTypes(type, value, tagName, nameInTag, idx, property, node, parentNode, invalidTypes);\n    });\n\n    if (invalidTypes.length) {\n      const fixedType = stringify(typeAst);\n\n      /**\n       * @type {import('eslint').Rule.ReportFixer}\n       */\n      const fix = (fixer) => {\n        return fixer.replaceText(\n          jsdocNode,\n          sourceCode.getText(jsdocNode).replace(\n            `{${jsdocTag.type}}`,\n            `{${fixedType}}`,\n          ),\n        );\n      };\n\n      for (const [\n        badType,\n        preferredType = '',\n        msg,\n      ] of invalidTypes) {\n        const tagValue = jsdocTag.name ? ` \"${jsdocTag.name}\"` : '';\n        if (exemptTagContexts.some(({\n          tag,\n          types,\n        }) => {\n          return tag === tagName &&\n            (types === true || types.includes(jsdocTag.type));\n        })) {\n          continue;\n        }\n\n        report(\n          msg ||\n            `Invalid JSDoc @${tagName}${tagValue} type \"${badType}\"` +\n            (preferredType ? '; ' : '.') +\n            (preferredType ? `prefer: ${JSON.stringify(preferredType)}.` : ''),\n          preferredType ? fix : null,\n          jsdocTag,\n          msg ? {\n            tagName,\n            tagValue,\n          } : undefined,\n        );\n      }\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Reports invalid types.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-types.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          exemptTagContexts: {\n            items: {\n              additionalProperties: false,\n              properties: {\n                tag: {\n                  type: 'string',\n                },\n                types: {\n                  oneOf: [\n                    {\n                      type: 'boolean',\n                    },\n                    {\n                      items: {\n                        type: 'string',\n                      },\n                      type: 'array',\n                    },\n                  ],\n                },\n              },\n              type: 'object',\n            },\n            type: 'array',\n          },\n          noDefaults: {\n            type: 'boolean',\n          },\n          unifyParentAndChildTypeChecks: {\n            description: '@deprecated Use the `preferredTypes[preferredType]` setting of the same name instead',\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAK8B,SAAAD,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE9B,MAAMG,iBAAiB,GAAG,CACxB,WAAW,EACX,MAAM,EACN,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,UAAU,EACV,MAAM,EACN,QAAQ,CACT;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,WAAW,GAAGA,CAACC,IAAI,EAAEC,SAAS,EAAEC,cAAc,EAAEC,YAAY,EAAEC,IAAI,EAAEC,UAAU,KAAK;EACvF,IAAIC,GAAG,GAAGL,SAAS;EACnB,IAAIC,cAAc,EAAE;IAClB,MAAMK,UAAU,GAAG,8DACjBF,UAAU,CACVG,IAAI;IACN,IAAIP,SAAS,KAAK,IAAI,EAAE;MACtBM,UAAU,CAACE,QAAQ,GAAG,QAAQ;MAC9BF,UAAU,CAACG,GAAG,GAAG,KAAK;MACtBJ,GAAG,GAAG,OAAO;IACf,CAAC,MAAM;MACL,MAAMK,aAAa,GAAGV,SAAS,CAACW,KAAK,CAAC,aAAa,CAAC;MACpD,IAAID,aAAa,EAAE;QACjBJ,UAAU,CAACE,QAAQ,GAAG,OAAO;QAC7BF,UAAU,CAACG,GAAG,GAAG,IAAI;QACrBJ,GAAG,GAAGL,SAAS,CAACY,KAAK,CAAC,CAAC,EAAE,CAACF,aAAa,CAAC,CAAC,CAAC,CAACG,MAAM,CAAC;MACpD,CAAC,MAAM;QACL,MAAMC,UAAU,GAAGd,SAAS,CAACe,QAAQ,CAAC,IAAI,CAAC;QAC3C,IAAID,UAAU,EAAE;UACdR,UAAU,CAACE,QAAQ,GAAG,OAAO;UAC7BF,UAAU,CAACG,GAAG,GAAG,KAAK;UACtBJ,GAAG,GAAGL,SAAS,CAACY,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9B,CAAC,MAAM,IACLN,UAAU,EAAEE,QAAQ,KAAK,QAAQ,KAChCN,YAAY,KAAK,IAAI,IAAIA,YAAY,KAAK,OAAO,CAAC,EACnD;UACAI,UAAU,CAACE,QAAQ,GAAG,OAAO;UAC7BF,UAAU,CAACG,GAAG,GAAG,KAAK;QACxB;MACF;IACF;EACF,CAAC,MAAM,IAAIV,IAAI,KAAK,cAAc,EAAE;IAClCI,IAAI,CAACJ,IAAI,GAAG,eAAe;EAC7B;;EAEA;EACEI,IAAI,CACJa,KAAK,GAAGX,GAAG,CAACY,OAAO,CAAC,uBAAuB,EAAE,EAAE,CAAC;;EAElD;EACA,IAAI,CAACZ,GAAG,EAAE;IACR,2DACEF,IAAI,CACJa,KAAK,GAAGd,YAAY;EACxB;AACF,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAMgB,UAAU,GAAIC,SAAS,IAAK;EAChC,OAAO,sDAAsD,GAC7D,GAAG,IAAIA,SAAS,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,yCAAyC;AAC3E,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,IAAI,GAAG;EACXC,OAAO,EAAEH,UAAU,CAAC,CAAC;EACrBI,WAAW,EAAE;AACf,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,MAAM,GAAG;EACbF,OAAO,EAAEH,UAAU,CAAC,IAAI,CAAC;EACzBI,WAAW,EAAE;AACf,CAAC;AAAC,IAAAE,QAAA,GAAAC,OAAA,CAAA7B,OAAA,GAEa,IAAA8B,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,SAAS;EACTC,MAAM;EACNC,QAAQ;EACRC,UAAU;EACVC;AACF,CAAC,KAAK;EACJ,MAAMC,yBAAyB,GAAGD,KAAK,CAACE,UAAU,CAAEC,GAAG,IAAK;IAC1D,OAAOC,OAAO,CAACJ,KAAK,CAACK,wBAAwB,CAACF,GAAG,CAACA,GAAG,CAAC,CAAC;EACzD,CAAC,CAAC;EAEF;EACE;AACJ;AACA;AACA;AACA;AACA;AACA;EACI;IACEG,IAAI;IACJC,cAAc,EAAEC,sBAAsB;IACtCC;EACF,CAAC,GAAGX,QAAQ;EAEd,MAAMY,0BAA0B,GAAG,EAAE,QAAQ,IAAIF,sBAAsB,IACrE,QAAQ,IAAIA,sBAAsB,IAClC,WAAW,IAAIA,sBAAsB,IACrC,WAAW,IAAIA,sBAAsB,IACrC,UAAU,IAAIA,sBAAsB,CAAC;;EAEvC;EACA,MAAMG,YAAY,GAAGL,IAAI,KAAK,YAAY,GACxC;IACEM,MAAM,EAAE,QAAQ;IAChB,WAAW,EAAExB,IAAI;IACjB,WAAW,EAAEG,MAAM;IACnB,UAAU,EAAEH,IAAI;IAChB,UAAU,EAAEG;EACd,CAAC,GACD;IACEqB,MAAM,EAAE,QAAQ;IAChB,WAAW,EAAE,UAAU;IACvB,WAAW,EAAE,UAAU;IACvB,UAAU,EAAE;EACd,CAAC;;EAEH;EACA,MAAML,cAAc,GAAG;IACrB,IAAGG,0BAA0B,GAC3BC,YAAY,GACZ,CAAC,CAAC;IACJ,GAAGH;EACL,CAAC;EAED;EACE;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EAAQ;IACFK,iBAAiB,GAAG,EAAE;IACtBC,UAAU;IACVC;EACF,CAAC,GAAGpB,OAAO,CAACqB,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;EAE9B;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMC,oBAAoB,GAAGA,CAACC,KAAK,EAAEhD,YAAY,EAAEE,UAAU,EAAE+C,QAAQ,KAAK;IAC1E,IAAIC,wBAAwB,GAAG,KAAK;IACpC,IAAInD,cAAc,GAAG,KAAK;IAC1B,IAAIoD,QAAQ,GAAGnD,YAAY;IAE3B,MAAMoD,eAAe,GAAGlD,UAAU,KAAKmD,SAAS,IAAInD,UAAU,CAACL,IAAI,KAAK,kBAAkB,IAAIoD,QAAQ,KAAK,MAAM;IAEjH,MAAM3C,QAAQ,GAAG,8DACfJ,UAAU,EACTG,IAAI,EAAEC,QAAQ;IACjB,MAAMC,GAAG,GAAG,8DACVL,UAAU,EACTG,IAAI,EAAEE,GAAG;IAEZ,IAAID,QAAQ,KAAK,OAAO,EAAE;MACxB,MAAMgD,cAAc,GAAG/C,GAAG,GAAG,CAC3B,GAAG,EAAE,KAAK,CACX,GAAG,CACF,IAAI,CACL;MACDR,cAAc,GAAGuD,cAAc,CAACC,IAAI,CAAEC,YAAY,IAAK;QACrD,MAAMC,aAAa,GAAGpB,cAAc,GAAGrC,YAAY,GAAGwD,YAAY,CAAC;;QAEnE;QACA,IACE,CAACX,6BAA6B,IAAIO,eAAe,KAC/C;QACC,OAAOK,aAAa,KAAK,QAAQ,IAChCA,aAAa,EAAEZ,6BAA6B,CAAC,KAEjDY,aAAa,KAAKJ,SAAS,EAC3B;UACAF,QAAQ,IAAIK,YAAY;UAExB,OAAO,IAAI;QACb;QAEA,OAAO,KAAK;MACd,CAAC,CAAC;IACJ;IAEA,IACE,CAACzD,cAAc,IAAIkD,QAAQ,IAC3B,8DACE/C,UAAU,CACVL,IAAI,KAAK,kBAAkB,EAC7B;MACA,MAAMyD,cAAc,GAAG/C,GAAG,GAAG,CAC3B,GAAG,EAAE,KAAK,CACX,GAAG,CACFD,QAAQ,KAAK,OAAO,GAAG,IAAI,GAAG,IAAI,CACnC;MAEDP,cAAc,GAAGuD,cAAc,CAACC,IAAI,CAAEC,YAAY,IAAK;QACrD,MAAMC,aAAa,GAAGpB,cAAc,GAAGmB,YAAY,CAAC;QACpD;QACE;QACA,CAACX,6BAA6B,IAAIO,eAAe,KAC/C;QACC,OAAOK,aAAa,KAAK,QAAQ,IAClCA,aAAa,EAAEZ,6BAA6B,CAAC,KAC7CY,aAAa,KAAKJ,SAAS,EAC7B;UACAF,QAAQ,GAAGK,YAAY;UAEvB,OAAO,IAAI;QACb;QAEA,OAAO,KAAK;MACd,CAAC,CAAC;IACJ;IAEA,MAAME,QAAQ,GAAGrB,cAAc,GAAGrC,YAAY,CAAC;IAC/C,MAAM2D,eAAe,GAAGD,QAAQ,KAAKL,SAAS,IAC5C,CAACX,MAAM,CAACkB,MAAM,CAACvB,cAAc,CAAC,CAACwB,QAAQ,CAAC7D,YAAY,CAAC;IACvD,MAAM8D,aAAa,GAAG,OAAOJ,QAAQ,KAAK,QAAQ,IAChDA,QAAQ,EAAEb,6BAA6B;IACzC,MAAMkB,wBAAwB,GAAGd,QAAQ,IAAIU,eAAe,KAAKd,6BAA6B,IAAIiB,aAAa,CAAC;IAChH/D,cAAc,GAAGA,cAAc,IAAImC,OAAO,CAAC6B,wBAAwB,CAAC;IAEpEb,wBAAwB,GAAGnD,cAAc,IACvC4D,eAAe,IAAI,CAACV,QAAQ;IAE9B,OAAO,CACLC,wBAAwB,EAAEC,QAAQ,EAAEpD,cAAc,CACnD;EACH,CAAC;;EAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMiE,gBAAgB,GAAGA,CAAChE,YAAY,EAAEF,SAAS,EAAEI,UAAU,EAAE+D,YAAY,KAAK;IAC9E,IAAIC,gBAAgB,GAAGpE,SAAS;IAChC,KAAK,MAAMqE,gBAAgB,IAAIxE,iBAAiB,EAAE;MAChD,IACEwE,gBAAgB,KAAK,QAAQ;MAE3B;MACA;MACA,CAAC9B,cAAc,GAAGrC,YAAY,CAAC;MAC/B;MACA;MACA;MACA;MACA;AACV;AACA;MAEYE,UAAU,EACTkE,QAAQ,EAAEzD,MAAM;MACnB;AACV;AACA;MAEcT,UAAU,EACTmE,IAAI,EAAExE,IAAI,KAAK,eAAe;MACjC;AACZ;AACA;MACaK,UAAU,EAAGmE,IAAI,EAAEvD,KAAK,KAAK,QAAQ,CACvC,CACF,EACD;QACA;MACF;MAEA,IAAIqD,gBAAgB,KAAKnE,YAAY,IACnCmE,gBAAgB,CAACG,WAAW,CAAC,CAAC,KAAKtE,YAAY,CAACsE,WAAW,CAAC,CAAC;MAE7D;MACC,CAACjC,cAAc,IAAIA,cAAc,GAAG8B,gBAAgB,CAAC,KAAKd,SAAS,CAAC,EACrE;QACAa,gBAAgB,GAAGC,gBAAgB;QACnCF,YAAY,CAACM,IAAI,CAAC,CAChBvE,YAAY,EAAEkE,gBAAgB,CAC/B,CAAC;QACF;MACF;IACF;IAEA,OAAOA,gBAAgB;EACzB,CAAC;;EAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMM,eAAe,GAAGA,CAAC3E,IAAI,EAAEiB,KAAK,EAAE2D,OAAO,EAAEC,SAAS,EAAEC,GAAG,EAAE1B,QAAQ,EAAEhD,IAAI,EAAEC,UAAU,EAAE+D,YAAY,KAAK;IAC1G,IAAIjE,YAAY,GAAGH,IAAI,KAAK,cAAc,GAAG,GAAG,GAAGiB,KAAK;IAExD,MAAM,CACJoC,wBAAwB,EACxBC,QAAQ,EACRpD,cAAc,CACf,GAAGgD,oBAAoB,CAAClD,IAAI,EAAEG,YAAY,EAAEE,UAAU,EAAE+C,QAAQ,CAAC;IAElE,IAAInD,SAAS;IACb,IAAI8E,KAAK;IACT,IAAI1B,wBAAwB,EAAE;MAC5B,MAAM2B,gBAAgB,GAAGxC,cAAc,CAACc,QAAQ,CAAC;MACjDnD,YAAY,GAAGmD,QAAQ,KAAK,IAAI,GAAGA,QAAQ,GAAGnD,YAAY;MAE1D,IAAI,CAAC6E,gBAAgB,EAAE;QACrBZ,YAAY,CAACM,IAAI,CAAC,CAChBvE,YAAY,CACb,CAAC;MACJ,CAAC,MAAM,IAAI,OAAO6E,gBAAgB,KAAK,QAAQ,EAAE;QAC/C/E,SAAS,GAAG+E,gBAAgB;QAC5BZ,YAAY,CAACM,IAAI,CAAC,CAChBvE,YAAY,EAAEF,SAAS,CACxB,CAAC;MACJ,CAAC,MAAM,IAAI+E,gBAAgB,IAAI,OAAOA,gBAAgB,KAAK,QAAQ,EAAE;QACnE,MAAMC,QAAQ,GAAGD,gBAAgB,CAACE,gBAAgB,IAAIhD,yBAAyB,CAAC4C,GAAG,GAAG,CAAC,CAAC;QAExF,IAAI,CAACG,QAAQ,IAAI,CAACA,QAAQ,CAACE,IAAI,CAACC,UAAU,CAAC,GAAGP,SAAS,GAAG,CAAC,EAAE;UAC3D5E,SAAS,GAAG+E,gBAAgB,CAACzD,WAAW;UACxC6C,YAAY,CAACM,IAAI,CAAC,CAChBvE,YAAY,EACZF,SAAS,EACT+E,gBAAgB,CAAC1D,OAAO,CACzB,CAAC;QACJ;MACF,CAAC,MAAM;QACLW,KAAK,CAACoD,cAAc,CAClB,wFACF,CAAC;QAED;MACF;IACF,CAAC,MAAM,IAAIxC,MAAM,CAACyC,OAAO,CAAC5C,cAAc,CAAC,CAACgB,IAAI,CAAC,CAAC,CAC9CtB,GAAG,EACH;MACEpC,IAAI,EAAEuF;IACR,CAAC,CACF,KAAK;MACJR,KAAK,GAAGQ,IAAI;MAEZ,OAAOnD,GAAG,KAAKwC,OAAO,IACpBY,KAAK,CAACC,OAAO,CAACV,KAAK,CAAC,IACpB,CAACA,KAAK,CAACf,QAAQ,CAAC7D,YAAY,CAAC;IACjC,CAAC,CAAC,EAAE;MACFiE,YAAY,CAACM,IAAI,CAAC,CAChBvE,YAAY,EAAE4E,KAAK,CACpB,CAAC;IACJ,CAAC,MAAM,IAAI,CAAChC,UAAU,IAAI/C,IAAI,KAAK,eAAe,EAAE;MAClDC,SAAS,GAAGkE,gBAAgB,CAAChE,YAAY,EAAEF,SAAS,EAAEI,UAAU,EAAE+D,YAAY,CAAC;IACjF;;IAEA;IACA,IAAInE,SAAS,EAAE;MACbF,WAAW,CAACC,IAAI,EAAEC,SAAS,EAAEC,cAAc,EAAEC,YAAY,EAAEC,IAAI,EAAEC,UAAU,CAAC;IAC9E;EACF,CAAC;EAED,KAAK,MAAM,CACTyE,GAAG,EACHY,QAAQ,CACT,IAAIxD,yBAAyB,CAACoD,OAAO,CAAC,CAAC,EAAE;IACxC;IACA,MAAMlB,YAAY,GAAG,EAAE;IACvB,IAAIuB,OAAO;IAEX,IAAI;MACFA,OAAO,GAAGpD,IAAI,KAAK,YAAY,GAAG,IAAAqD,sBAAQ,EAACF,QAAQ,CAAC1F,IAAI,CAAC,GAAG,IAAA6F,mBAAK,EAACH,QAAQ,CAAC1F,IAAI,EAAEuC,IAAI,CAAC;IACxF,CAAC,CAAC,MAAM;MACN;IACF;IAEA,MAAM;MACJ4C,IAAI,EAAEN,SAAS;MACfzC,GAAG,EAAEwC;IACP,CAAC,GAAGc,QAAQ;IAEZ,IAAAI,sBAAQ,EAACH,OAAO,EAAE,CAACvF,IAAI,EAAEC,UAAU,EAAE+C,QAAQ,KAAK;MAChD,MAAM;QACJpD,IAAI;QACJiB;MACF,CAAC;MACC;AACR;AACA;MAAab,IAAK;MACZ,IAAI,CAAC,CACH,cAAc,EAAE,eAAe,CAChC,CAAC4D,QAAQ,CAAChE,IAAI,CAAC,EAAE;QAChB;MACF;MAEA2E,eAAe,CAAC3E,IAAI,EAAEiB,KAAK,EAAE2D,OAAO,EAAEC,SAAS,EAAEC,GAAG,EAAE1B,QAAQ,EAAEhD,IAAI,EAAEC,UAAU,EAAE+D,YAAY,CAAC;IACjG,CAAC,CAAC;IAEF,IAAIA,YAAY,CAACtD,MAAM,EAAE;MACvB,MAAMiF,SAAS,GAAG,IAAAC,uBAAS,EAACL,OAAO,CAAC;;MAEpC;AACN;AACA;MACM,MAAMM,GAAG,GAAIC,KAAK,IAAK;QACrB,OAAOA,KAAK,CAACC,WAAW,CACtBtE,SAAS,EACTG,UAAU,CAACoE,OAAO,CAACvE,SAAS,CAAC,CAACX,OAAO,CACnC,IAAIwE,QAAQ,CAAC1F,IAAI,GAAG,EACpB,IAAI+F,SAAS,GACf,CACF,CAAC;MACH,CAAC;MAED,KAAK,MAAM,CACTM,OAAO,EACPzC,aAAa,GAAG,EAAE,EAClB0C,GAAG,CACJ,IAAIlC,YAAY,EAAE;QACjB,MAAMmC,QAAQ,GAAGb,QAAQ,CAACP,IAAI,GAAG,KAAKO,QAAQ,CAACP,IAAI,GAAG,GAAG,EAAE;QAC3D,IAAIrC,iBAAiB,CAACY,IAAI,CAAC,CAAC;UAC1BtB,GAAG;UACH2C;QACF,CAAC,KAAK;UACJ,OAAO3C,GAAG,KAAKwC,OAAO,KACnBG,KAAK,KAAK,IAAI,IAAIA,KAAK,CAACf,QAAQ,CAAC0B,QAAQ,CAAC1F,IAAI,CAAC,CAAC;QACrD,CAAC,CAAC,EAAE;UACF;QACF;QAEA8B,MAAM,CACJwE,GAAG,IACD,kBAAkB1B,OAAO,GAAG2B,QAAQ,UAAUF,OAAO,GAAG,IACvDzC,aAAa,GAAG,IAAI,GAAG,GAAG,CAAC,IAC3BA,aAAa,GAAG,WAAW4C,IAAI,CAACR,SAAS,CAACpC,aAAa,CAAC,GAAG,GAAG,EAAE,CAAC,EACpEA,aAAa,GAAGqC,GAAG,GAAG,IAAI,EAC1BP,QAAQ,EACRY,GAAG,GAAG;UACJ1B,OAAO;UACP2B;QACF,CAAC,GAAG/C,SACN,CAAC;MACH;IACF;EACF;AACF,CAAC,EAAE;EACDiD,gBAAgB,EAAE,IAAI;EACtBjG,IAAI,EAAE;IACJkG,IAAI,EAAE;MACJC,WAAW,EAAE,wBAAwB;MACrCC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVlE,iBAAiB,EAAE;UACjBmE,KAAK,EAAE;YACLF,oBAAoB,EAAE,KAAK;YAC3BC,UAAU,EAAE;cACV5E,GAAG,EAAE;gBACHpC,IAAI,EAAE;cACR,CAAC;cACD+E,KAAK,EAAE;gBACLmC,KAAK,EAAE,CACL;kBACElH,IAAI,EAAE;gBACR,CAAC,EACD;kBACEiH,KAAK,EAAE;oBACLjH,IAAI,EAAE;kBACR,CAAC;kBACDA,IAAI,EAAE;gBACR,CAAC;cAEL;YACF,CAAC;YACDA,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACD+C,UAAU,EAAE;UACV/C,IAAI,EAAE;QACR,CAAC;QACDgD,6BAA6B,EAAE;UAC7B2D,WAAW,EAAE,sFAAsF;UACnG3G,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAmH,MAAA,CAAAzF,OAAA,GAAAA,OAAA,CAAA7B,OAAA","ignoreList":[]}
+{"version":3,"file":"checkTypes.cjs","names":["_buildRejectOrPreferRuleDefinition","require","strictNativeTypes","checkNativeTypes","preferredTypes","typeNodeName","preferred","parentNode","invalidTypes","changedPreferred","strictNativeType","elements","length","left","type","value","toLowerCase","undefined","push","_default","exports","default","buildRejectOrPreferRuleDefinition","schema","additionalProperties","properties","exemptTagContexts","items","tag","types","oneOf","noDefaults","unifyParentAndChildTypeChecks","description","module"],"sources":["../../src/rules/checkTypes.js"],"sourcesContent":["import {\n  buildRejectOrPreferRuleDefinition,\n} from '../buildRejectOrPreferRuleDefinition.js';\n\nconst strictNativeTypes = [\n  'undefined',\n  'null',\n  'boolean',\n  'number',\n  'bigint',\n  'string',\n  'symbol',\n  'object',\n  'Array',\n  'Function',\n  'Date',\n  'RegExp',\n];\n\n/**\n * @callback CheckNativeTypes\n * Iterates strict types to see if any should be added to `invalidTypes` (and\n * the the relevant strict type returned as the new preferred type).\n * @param {import('../iterateJsdoc.js').PreferredTypes} preferredTypes\n * @param {string} typeNodeName\n * @param {string|undefined} preferred\n * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode\n * @param {(string|false|undefined)[][]} invalidTypes\n * @returns {string|undefined} The `preferred` type string, optionally changed\n */\n\n/** @type {CheckNativeTypes} */\nconst checkNativeTypes = (preferredTypes, typeNodeName, preferred, parentNode, invalidTypes) => {\n  let changedPreferred = preferred;\n  for (const strictNativeType of strictNativeTypes) {\n    if (\n      strictNativeType === 'object' &&\n      (\n        // This is not set to remap with exact type match (e.g.,\n        //   `object: 'Object'`), so can ignore (including if circular)\n        !preferredTypes?.[typeNodeName] ||\n        // Although present on `preferredTypes` for remapping, this is a\n        //   parent object without a parent match (and not\n        //   `unifyParentAndChildTypeChecks`) and we don't want\n        //   `object<>` given TypeScript issue https://github.com/microsoft/TypeScript/issues/20555\n        /**\n         * @type {import('jsdoc-type-pratt-parser').GenericResult}\n         */\n        (\n          parentNode\n        )?.elements?.length && (\n        /**\n         * @type {import('jsdoc-type-pratt-parser').GenericResult}\n         */\n          (\n            parentNode\n          )?.left?.type === 'JsdocTypeName' &&\n          /**\n           * @type {import('jsdoc-type-pratt-parser').GenericResult}\n           */\n          (parentNode)?.left?.value === 'Object'\n        )\n      )\n    ) {\n      continue;\n    }\n\n    if (strictNativeType !== typeNodeName &&\n      strictNativeType.toLowerCase() === typeNodeName.toLowerCase() &&\n\n      // Don't report if user has own map for a strict native type\n      (!preferredTypes || preferredTypes?.[strictNativeType] === undefined)\n    ) {\n      changedPreferred = strictNativeType;\n      invalidTypes.push([\n        typeNodeName, changedPreferred,\n      ]);\n      break;\n    }\n  }\n\n  return changedPreferred;\n};\n\nexport default buildRejectOrPreferRuleDefinition({\n  checkNativeTypes,\n  schema: [\n    {\n      additionalProperties: false,\n      properties: {\n        exemptTagContexts: {\n          items: {\n            additionalProperties: false,\n            properties: {\n              tag: {\n                type: 'string',\n              },\n              types: {\n                oneOf: [\n                  {\n                    type: 'boolean',\n                  },\n                  {\n                    items: {\n                      type: 'string',\n                    },\n                    type: 'array',\n                  },\n                ],\n              },\n            },\n            type: 'object',\n          },\n          type: 'array',\n        },\n        noDefaults: {\n          type: 'boolean',\n        },\n        unifyParentAndChildTypeChecks: {\n          description: '@deprecated Use the `preferredTypes[preferredType]` setting of the same name instead',\n          type: 'boolean',\n        },\n      },\n      type: 'object',\n    },\n  ],\n});\n"],"mappings":";;;;;;AAAA,IAAAA,kCAAA,GAAAC,OAAA;AAIA,MAAMC,iBAAiB,GAAG,CACxB,WAAW,EACX,MAAM,EACN,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,UAAU,EACV,MAAM,EACN,QAAQ,CACT;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA,MAAMC,gBAAgB,GAAGA,CAACC,cAAc,EAAEC,YAAY,EAAEC,SAAS,EAAEC,UAAU,EAAEC,YAAY,KAAK;EAC9F,IAAIC,gBAAgB,GAAGH,SAAS;EAChC,KAAK,MAAMI,gBAAgB,IAAIR,iBAAiB,EAAE;IAChD,IACEQ,gBAAgB,KAAK,QAAQ;IAE3B;IACA;IACA,CAACN,cAAc,GAAGC,YAAY,CAAC;IAC/B;IACA;IACA;IACA;IACA;AACR;AACA;IAEUE,UAAU,EACTI,QAAQ,EAAEC,MAAM;IACnB;AACR;AACA;IAEYL,UAAU,EACTM,IAAI,EAAEC,IAAI,KAAK,eAAe;IACjC;AACV;AACA;IACWP,UAAU,EAAGM,IAAI,EAAEE,KAAK,KAAK,QAAQ,CACvC,CACF,EACD;MACA;IACF;IAEA,IAAIL,gBAAgB,KAAKL,YAAY,IACnCK,gBAAgB,CAACM,WAAW,CAAC,CAAC,KAAKX,YAAY,CAACW,WAAW,CAAC,CAAC;IAE7D;IACC,CAACZ,cAAc,IAAIA,cAAc,GAAGM,gBAAgB,CAAC,KAAKO,SAAS,CAAC,EACrE;MACAR,gBAAgB,GAAGC,gBAAgB;MACnCF,YAAY,CAACU,IAAI,CAAC,CAChBb,YAAY,EAAEI,gBAAgB,CAC/B,CAAC;MACF;IACF;EACF;EAEA,OAAOA,gBAAgB;AACzB,CAAC;AAAC,IAAAU,QAAA,GAAAC,OAAA,CAAAC,OAAA,GAEa,IAAAC,oEAAiC,EAAC;EAC/CnB,gBAAgB;EAChBoB,MAAM,EAAE,CACN;IACEC,oBAAoB,EAAE,KAAK;IAC3BC,UAAU,EAAE;MACVC,iBAAiB,EAAE;QACjBC,KAAK,EAAE;UACLH,oBAAoB,EAAE,KAAK;UAC3BC,UAAU,EAAE;YACVG,GAAG,EAAE;cACHd,IAAI,EAAE;YACR,CAAC;YACDe,KAAK,EAAE;cACLC,KAAK,EAAE,CACL;gBACEhB,IAAI,EAAE;cACR,CAAC,EACD;gBACEa,KAAK,EAAE;kBACLb,IAAI,EAAE;gBACR,CAAC;gBACDA,IAAI,EAAE;cACR,CAAC;YAEL;UACF,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACDA,IAAI,EAAE;MACR,CAAC;MACDiB,UAAU,EAAE;QACVjB,IAAI,EAAE;MACR,CAAC;MACDkB,6BAA6B,EAAE;QAC7BC,WAAW,EAAE,sFAAsF;QACnGnB,IAAI,EAAE;MACR;IACF,CAAC;IACDA,IAAI,EAAE;EACR,CAAC;AAEL,CAAC,CAAC;AAAAoB,MAAA,CAAAd,OAAA,GAAAA,OAAA,CAAAC,OAAA","ignoreList":[]}

package/dist/rules/checkTypes.d.ts

@@ -1,3 +1,8 @@
-declare const _default: import("eslint").Rule.RuleModule;
+declare const _default: import("@eslint/core").RuleDefinition<import("@eslint/core").RuleDefinitionTypeOptions>;
 export default _default;
+/**
+ * Iterates strict types to see if any should be added to `invalidTypes` (and
+ * the the relevant strict type returned as the new preferred type).
+ */
+export type CheckNativeTypes = (preferredTypes: import("../iterateJsdoc.js").PreferredTypes, typeNodeName: string, preferred: string | undefined, parentNode: import("jsdoc-type-pratt-parser").NonRootResult | undefined, invalidTypes: (string | false | undefined)[][]) => string | undefined;
 //# sourceMappingURL=checkTypes.d.ts.map

package/dist/rules.d.ts

@@ -410,6 +410,12 @@ export interface Rules {
         }
       ];
 
+  /** Reports use of `any` or `*` type */
+  "jsdoc/reject-any-type": [];
+
+  /** Reports use of `Function` type */
+  "jsdoc/reject-function-type": [];
+
   /** Requires that each JSDoc line starts with an `*`. */
   "jsdoc/require-asterisk-prefix": 
     | []
@@ -557,7 +563,7 @@ export interface Rules {
         }
       ];
 
-  /** Requires a type for @next tags */
+  /** Requires a type for `@next` tags */
   "jsdoc/require-next-type": [];
 
   /** Requires that all function parameters are documented. */
@@ -748,7 +754,7 @@ export interface Rules {
         }
       ];
 
-  /** Requires a type for @throws tags */
+  /** Requires a type for `@throws` tags */
   "jsdoc/require-throws-type": [];
 
   /** Requires yields are documented. */
@@ -790,7 +796,7 @@ export interface Rules {
         }
       ];
 
-  /** Requires a type for @yields tags */
+  /** Requires a type for `@yields` tags */
   "jsdoc/require-yields-type": [];
 
   /** Sorts tags by a specified sequence according to tag name. */

package/package.json

@@ -172,5 +172,5 @@
     "test-cov": "TIMING=1 c8 --reporter text pnpm run test-no-cov",
     "test-index": "pnpm run test-no-cov test/rules/index.js"
   },
-  "version": "57.2.1"
+  "version": "58.0.0"
 }