eslint-plugin-jsdoc 63.3.2 → 64.0.0

package/dist/rules/checkTagNames.cjs

@@ -1,312 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-var _escapeStringRegexp = _interopRequireDefault(require("escape-string-regexp"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-// https://babeljs.io/docs/en/babel-plugin-transform-react-jsx/
-const jsxTagNames = new Set(['jsx', 'jsxFrag', 'jsxImportSource', 'jsxRuntime']);
-const typedTagsAlwaysUnnecessary = new Set(['augments', 'callback', 'class', 'enum', 'implements', 'private', 'property', 'protected', 'public', 'readonly', 'this', 'type', 'typedef']);
-const typedTagsNeedingName = new Set(['template']);
-const typedTagsUnnecessaryOutsideDeclare = new Set(['abstract', 'access', 'class', 'constant', 'constructs', 'default', 'enum', 'export', 'exports', 'function', 'global', 'inherits', 'instance', 'interface', 'member', 'memberof', 'memberOf', 'method', 'mixes', 'mixin', 'module', 'name', 'namespace', 'override', 'property', 'requires', 'static', 'this']);
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  context,
-  jsdoc,
-  jsdocNode,
-  node,
-  report,
-  settings,
-  sourceCode,
-  utils
-}) => {
-  const
-  /**
-   * @type {{
-   *   definedTags: string[],
-   *   enableFixer: boolean,
-   *   inlineTags: string[],
-   *   jsxTags: boolean,
-   *   typed: boolean
-   }} */
-  {
-    definedTags = [],
-    enableFixer = true,
-    inlineTags = [
-    // jsdoc
-    'link', 'linkcode', 'linkplain', 'tutorial',
-    // https://tsdoc.org/pages/spec/tag_kinds/#inline-tags
-    'inheritDoc', 'label',
-    // https://typedoc.org/documents/Tags.html#inline-tags
-    'include', 'includeCode'],
-    jsxTags,
-    typed
-  } = context.options[0] || {};
-
-  /** @type {(string|undefined)[]} */
-  let definedPreferredTags = [];
-  const {
-    structuredTags,
-    tagNamePreference
-  } = settings;
-  const definedStructuredTags = Object.keys(structuredTags);
-  const definedNonPreferredTags = Object.keys(tagNamePreference);
-  if (definedNonPreferredTags.length) {
-    definedPreferredTags = Object.values(tagNamePreference).map(preferredTag => {
-      if (typeof preferredTag === 'string') {
-        // May become an empty string but will be filtered out below
-        return preferredTag;
-      }
-      if (!preferredTag) {
-        return undefined;
-      }
-      if (typeof preferredTag !== 'object') {
-        utils.reportSettings('Invalid `settings.jsdoc.tagNamePreference`. Values must be falsy, a string, or an object.');
-      }
-      return preferredTag.replacement;
-    }).filter(Boolean);
-  }
-
-  /**
-   * @param {import('eslint').Rule.Node} subNode
-   * @returns {boolean}
-   */
-  const isInAmbientContext = subNode => {
-    return subNode.type === 'Program' ? /* c8 ignore next 2 -- Support old ESLint */
-    // @ts-expect-error ESLint < 10
-    (context.filename ?? context.getFilename()).endsWith('.d.ts') : Boolean(/** @type {import('@typescript-eslint/types').TSESTree.VariableDeclaration} */subNode.declare) || isInAmbientContext(subNode.parent);
-  };
-
-  /**
-   * @param {import('comment-parser').Spec} jsdocTag
-   * @returns {boolean}
-   */
-  const tagIsRedundantWhenTyped = jsdocTag => {
-    if (!typedTagsUnnecessaryOutsideDeclare.has(jsdocTag.tag)) {
-      return false;
-    }
-    if (jsdocTag.tag === 'default') {
-      return false;
-    }
-    if (node === null) {
-      return false;
-    }
-
-    /* c8 ignore next 2 -- Support old ESLint */
-    // @ts-expect-error ESLint < 10
-    if ((context.filename ?? context.getFilename()).endsWith('.d.ts') && [null, 'Program', undefined].includes(node?.parent?.type)) {
-      return false;
-    }
-    if (isInAmbientContext(/** @type {import('eslint').Rule.Node} */node)) {
-      return false;
-    }
-    return true;
-  };
-
-  /**
-   * @param {string} message
-   * @param {import('comment-parser').Spec} jsdocTag
-   * @param {import('../iterateJsdoc.js').Integer} tagIndex
-   * @param {Partial<import('comment-parser').Tokens>} [additionalTagChanges]
-   * @returns {void}
-   */
-  const reportWithTagRemovalFixer = (message, jsdocTag, tagIndex, additionalTagChanges) => {
-    utils.reportJSDoc(message, jsdocTag, enableFixer ? () => {
-      if (jsdocTag.description.trim()) {
-        utils.changeTag(jsdocTag, {
-          postType: '',
-          type: '',
-          ...additionalTagChanges
-        });
-      } else {
-        utils.removeTag(tagIndex, {
-          removeEmptyBlock: true
-        });
-      }
-    } : null, true);
-  };
-
-  /**
-   * @param {import('comment-parser').Spec} jsdocTag
-   * @param {import('../iterateJsdoc.js').Integer} tagIndex
-   * @returns {boolean}
-   */
-  const checkTagForTypedValidity = (jsdocTag, tagIndex) => {
-    if (typedTagsAlwaysUnnecessary.has(jsdocTag.tag)) {
-      reportWithTagRemovalFixer(`'@${jsdocTag.tag}' is redundant when using a type system.`, jsdocTag, tagIndex, {
-        postTag: '',
-        tag: ''
-      });
-      return true;
-    }
-    if (tagIsRedundantWhenTyped(jsdocTag)) {
-      reportWithTagRemovalFixer(`'@${jsdocTag.tag}' is redundant outside of ambient (\`declare\`/\`.d.ts\`) contexts when using a type system.`, jsdocTag, tagIndex);
-      return true;
-    }
-    if (typedTagsNeedingName.has(jsdocTag.tag) && !jsdocTag.name) {
-      reportWithTagRemovalFixer(`'@${jsdocTag.tag}' without a name is redundant when using a type system.`, jsdocTag, tagIndex);
-      return true;
-    }
-    return false;
-  };
-  for (let tagIndex = 0; tagIndex < jsdoc.tags.length; tagIndex += 1) {
-    const jsdocTag = jsdoc.tags[tagIndex];
-    const tagName = jsdocTag.tag;
-    if (jsxTags && jsxTagNames.has(tagName)) {
-      continue;
-    }
-    if (typed && checkTagForTypedValidity(jsdocTag, tagIndex)) {
-      continue;
-    }
-    const validTags = [...definedTags, ...(/** @type {string[]} */definedPreferredTags), ...definedNonPreferredTags, ...definedStructuredTags, ...(typed ? typedTagsNeedingName : [])];
-    if (utils.isValidTag(tagName, validTags)) {
-      let preferredTagName = utils.getPreferredTagName({
-        allowObjectReturn: true,
-        defaultMessage: `Blacklisted tag found (\`@${tagName}\`)`,
-        tagName
-      });
-      if (!preferredTagName) {
-        continue;
-      }
-      let message;
-      if (typeof preferredTagName === 'object') {
-        ({
-          message,
-          replacement: preferredTagName
-        } = /** @type {{message: string; replacement?: string | undefined;}} */
-        preferredTagName);
-      }
-      if (!message) {
-        message = `Invalid JSDoc tag (preference). Replace "${tagName}" JSDoc tag with "${preferredTagName}".`;
-      }
-      if (preferredTagName !== tagName) {
-        report(message, fixer => {
-          const replacement = sourceCode.getText(jsdocNode).replace(new RegExp(`@${(0, _escapeStringRegexp.default)(tagName)}\\b`, 'v'), `@${preferredTagName}`);
-          return fixer.replaceText(jsdocNode, replacement);
-        }, jsdocTag);
-      }
-    } else {
-      report(`Invalid JSDoc tag name "${tagName}".`, null, jsdocTag);
-    }
-  }
-  for (const inlineTag of utils.getInlineTags()) {
-    if (!inlineTags.includes(inlineTag.tag)) {
-      report(`Invalid JSDoc inline tag name "${inlineTag.tag}"`, null, inlineTag);
-    }
-  }
-}, {
-  iterateAllJsdocs: true,
-  meta: {
-    docs: {
-      description: 'Reports invalid block tag names.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-tag-names.md#repos-sticky-header'
-    },
-    fixable: 'code',
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        definedTags: {
-          description: `Use an array of \`definedTags\` strings to configure additional, allowed tags.
-The format is as follows:
-
-\`\`\`json
-{
-  "definedTags": ["note", "record"]
-}
-\`\`\``,
-          items: {
-            type: 'string'
-          },
-          type: 'array'
-        },
-        enableFixer: {
-          description: 'Set to `false` to disable auto-removal of types that are redundant with the [`typed` option](#typed).',
-          type: 'boolean'
-        },
-        inlineTags: {
-          description: `List of tags to allow inline.
-
-Defaults to array of \`'link', 'linkcode', 'linkplain', 'tutorial', 'inheritDoc', 'label', 'include', and 'includeCode'\``,
-          items: {
-            type: 'string'
-          },
-          type: 'array'
-        },
-        jsxTags: {
-          description: `If this is set to \`true\`, all of the following tags used to control JSX output are allowed:
-
-\`\`\`
-jsx
-jsxFrag
-jsxImportSource
-jsxRuntime
-\`\`\`
-
-For more information, see the [babel documentation](https://babeljs.io/docs/en/babel-plugin-transform-react-jsx).`,
-          type: 'boolean'
-        },
-        typed: {
-          description: `If this is set to \`true\`, additionally checks for tag names that are redundant when using a type checker such as TypeScript.
-
-These tags are always unnecessary when using TypeScript or similar:
-
-\`\`\`
-augments
-callback
-class
-enum
-implements
-private
-property
-protected
-public
-readonly
-this
-type
-typedef
-\`\`\`
-
-These tags are unnecessary except when inside a TypeScript \`declare\` context:
-
-\`\`\`
-abstract
-access
-class
-constant
-constructs
-default
-enum
-export
-exports
-function
-global
-inherits
-instance
-interface
-member
-memberof
-memberOf
-method
-mixes
-mixin
-module
-name
-namespace
-override
-property
-requires
-static
-this
-\`\`\``,
-          type: 'boolean'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'suggestion'
-  }
-});
-module.exports = exports.default;
-//# sourceMappingURL=checkTagNames.cjs.map

package/dist/rules/checkTagNames.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"checkTagNames.cjs","names":["iterateJsdoc","escapeStringRegexp"],"sources":["../../src/rules/checkTagNames.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport escapeStringRegexp from 'escape-string-regexp';\n\n// https://babeljs.io/docs/en/babel-plugin-transform-react-jsx/\nconst jsxTagNames = new Set([\n  'jsx',\n  'jsxFrag',\n  'jsxImportSource',\n  'jsxRuntime',\n]);\n\nconst typedTagsAlwaysUnnecessary = new Set([\n  'augments',\n  'callback',\n  'class',\n  'enum',\n  'implements',\n  'private',\n  'property',\n  'protected',\n  'public',\n  'readonly',\n  'this',\n  'type',\n  'typedef',\n]);\n\nconst typedTagsNeedingName = new Set([\n  'template',\n]);\n\nconst typedTagsUnnecessaryOutsideDeclare = new Set([\n  'abstract',\n  'access',\n  'class',\n  'constant',\n  'constructs',\n  'default',\n  'enum',\n  'export',\n  'exports',\n  'function',\n  'global',\n  'inherits',\n  'instance',\n  'interface',\n  'member',\n  'memberof',\n  'memberOf',\n  'method',\n  'mixes',\n  'mixin',\n  'module',\n  'name',\n  'namespace',\n  'override',\n  'property',\n  'requires',\n  'static',\n  'this',\n]);\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  jsdocNode,\n  node,\n  report,\n  settings,\n  sourceCode,\n  utils,\n}) => {\n  const\n    /**\n     * @type {{\n     *   definedTags: string[],\n     *   enableFixer: boolean,\n     *   inlineTags: string[],\n     *   jsxTags: boolean,\n     *   typed: boolean\n     }} */ {\n      definedTags = [],\n      enableFixer = true,\n      inlineTags = [\n        // jsdoc\n        'link', 'linkcode', 'linkplain', 'tutorial',\n        // https://tsdoc.org/pages/spec/tag_kinds/#inline-tags\n        'inheritDoc',\n        'label',\n        // https://typedoc.org/documents/Tags.html#inline-tags\n        'include', 'includeCode',\n      ],\n      jsxTags,\n      typed,\n    } = context.options[0] || {};\n\n  /** @type {(string|undefined)[]} */\n  let definedPreferredTags = [];\n  const {\n    structuredTags,\n    tagNamePreference,\n  } = settings;\n  const definedStructuredTags = Object.keys(structuredTags);\n  const definedNonPreferredTags = Object.keys(tagNamePreference);\n  if (definedNonPreferredTags.length) {\n    definedPreferredTags = Object.values(tagNamePreference).map((preferredTag) => {\n      if (typeof preferredTag === 'string') {\n        // May become an empty string but will be filtered out below\n        return preferredTag;\n      }\n\n      if (!preferredTag) {\n        return undefined;\n      }\n\n      if (typeof preferredTag !== 'object') {\n        utils.reportSettings(\n          'Invalid `settings.jsdoc.tagNamePreference`. Values must be falsy, a string, or an object.',\n        );\n      }\n\n      return preferredTag.replacement;\n    })\n      .filter(Boolean);\n  }\n\n  /**\n   * @param {import('eslint').Rule.Node} subNode\n   * @returns {boolean}\n   */\n  const isInAmbientContext = (subNode) => {\n    return subNode.type === 'Program' ?\n      /* c8 ignore next 2 -- Support old ESLint */\n      // @ts-expect-error ESLint < 10\n      (context.filename ?? context.getFilename()).endsWith('.d.ts') :\n      Boolean(\n        /** @type {import('@typescript-eslint/types').TSESTree.VariableDeclaration} */ (\n          subNode\n        ).declare,\n      ) || isInAmbientContext(subNode.parent);\n  };\n\n  /**\n   * @param {import('comment-parser').Spec} jsdocTag\n   * @returns {boolean}\n   */\n  const tagIsRedundantWhenTyped = (jsdocTag) => {\n    if (!typedTagsUnnecessaryOutsideDeclare.has(jsdocTag.tag)) {\n      return false;\n    }\n\n    if (jsdocTag.tag === 'default') {\n      return false;\n    }\n\n    if (node === null) {\n      return false;\n    }\n\n    /* c8 ignore next 2 -- Support old ESLint */\n    // @ts-expect-error ESLint < 10\n    if ((context.filename ?? context.getFilename()).endsWith('.d.ts') && [\n      null, 'Program', undefined,\n    ].includes(node?.parent?.type)) {\n      return false;\n    }\n\n    if (isInAmbientContext(/** @type {import('eslint').Rule.Node} */ (node))) {\n      return false;\n    }\n\n    return true;\n  };\n\n  /**\n   * @param {string} message\n   * @param {import('comment-parser').Spec} jsdocTag\n   * @param {import('../iterateJsdoc.js').Integer} tagIndex\n   * @param {Partial<import('comment-parser').Tokens>} [additionalTagChanges]\n   * @returns {void}\n   */\n  const reportWithTagRemovalFixer = (message, jsdocTag, tagIndex, additionalTagChanges) => {\n    utils.reportJSDoc(message, jsdocTag, enableFixer ? () => {\n      if (jsdocTag.description.trim()) {\n        utils.changeTag(jsdocTag, {\n          postType: '',\n          type: '',\n          ...additionalTagChanges,\n        });\n      } else {\n        utils.removeTag(tagIndex, {\n          removeEmptyBlock: true,\n        });\n      }\n    } : null, true);\n  };\n\n  /**\n   * @param {import('comment-parser').Spec} jsdocTag\n   * @param {import('../iterateJsdoc.js').Integer} tagIndex\n   * @returns {boolean}\n   */\n  const checkTagForTypedValidity = (jsdocTag, tagIndex) => {\n    if (typedTagsAlwaysUnnecessary.has(jsdocTag.tag)) {\n      reportWithTagRemovalFixer(\n        `'@${jsdocTag.tag}' is redundant when using a type system.`,\n        jsdocTag,\n        tagIndex,\n        {\n          postTag: '',\n          tag: '',\n        },\n      );\n      return true;\n    }\n\n    if (tagIsRedundantWhenTyped(jsdocTag)) {\n      reportWithTagRemovalFixer(\n        `'@${jsdocTag.tag}' is redundant outside of ambient (\\`declare\\`/\\`.d.ts\\`) contexts when using a type system.`,\n        jsdocTag,\n        tagIndex,\n      );\n      return true;\n    }\n\n    if (typedTagsNeedingName.has(jsdocTag.tag) && !jsdocTag.name) {\n      reportWithTagRemovalFixer(\n        `'@${jsdocTag.tag}' without a name is redundant when using a type system.`,\n        jsdocTag,\n        tagIndex,\n      );\n      return true;\n    }\n\n    return false;\n  };\n\n  for (let tagIndex = 0; tagIndex < jsdoc.tags.length; tagIndex += 1) {\n    const jsdocTag = jsdoc.tags[tagIndex];\n    const tagName = jsdocTag.tag;\n    if (jsxTags && jsxTagNames.has(tagName)) {\n      continue;\n    }\n\n    if (typed && checkTagForTypedValidity(jsdocTag, tagIndex)) {\n      continue;\n    }\n\n    const validTags = [\n      ...definedTags,\n      ...(/** @type {string[]} */ (definedPreferredTags)),\n      ...definedNonPreferredTags,\n      ...definedStructuredTags,\n      ...typed ? typedTagsNeedingName : [],\n    ];\n\n    if (utils.isValidTag(tagName, validTags)) {\n      let preferredTagName = utils.getPreferredTagName({\n        allowObjectReturn: true,\n        defaultMessage: `Blacklisted tag found (\\`@${tagName}\\`)`,\n        tagName,\n      });\n      if (!preferredTagName) {\n        continue;\n      }\n\n      let message;\n      if (typeof preferredTagName === 'object') {\n        ({\n          message,\n          replacement: preferredTagName,\n        } = /** @type {{message: string; replacement?: string | undefined;}} */ (\n          preferredTagName\n        ));\n      }\n\n      if (!message) {\n        message = `Invalid JSDoc tag (preference). Replace \"${tagName}\" JSDoc tag with \"${preferredTagName}\".`;\n      }\n\n      if (preferredTagName !== tagName) {\n        report(message, (fixer) => {\n          const replacement = sourceCode.getText(jsdocNode).replace(\n            new RegExp(`@${escapeStringRegexp(tagName)}\\\\b`, 'v'),\n            `@${preferredTagName}`,\n          );\n\n          return fixer.replaceText(jsdocNode, replacement);\n        }, jsdocTag);\n      }\n    } else {\n      report(`Invalid JSDoc tag name \"${tagName}\".`, null, jsdocTag);\n    }\n  }\n\n  for (const inlineTag of utils.getInlineTags()) {\n    if (!inlineTags.includes(inlineTag.tag)) {\n      report(`Invalid JSDoc inline tag name \"${inlineTag.tag}\"`, null, inlineTag);\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Reports invalid block tag names.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-tag-names.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          definedTags: {\n            description: `Use an array of \\`definedTags\\` strings to configure additional, allowed tags.\nThe format is as follows:\n\n\\`\\`\\`json\n{\n  \"definedTags\": [\"note\", \"record\"]\n}\n\\`\\`\\``,\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          enableFixer: {\n            description: 'Set to `false` to disable auto-removal of types that are redundant with the [`typed` option](#typed).',\n            type: 'boolean',\n          },\n          inlineTags: {\n            description: `List of tags to allow inline.\n\nDefaults to array of \\`'link', 'linkcode', 'linkplain', 'tutorial', 'inheritDoc', 'label', 'include', and 'includeCode'\\``,\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          jsxTags: {\n            description: `If this is set to \\`true\\`, all of the following tags used to control JSX output are allowed:\n\n\\`\\`\\`\njsx\njsxFrag\njsxImportSource\njsxRuntime\n\\`\\`\\`\n\nFor more information, see the [babel documentation](https://babeljs.io/docs/en/babel-plugin-transform-react-jsx).`,\n            type: 'boolean',\n          },\n          typed: {\n            description: `If this is set to \\`true\\`, additionally checks for tag names that are redundant when using a type checker such as TypeScript.\n\nThese tags are always unnecessary when using TypeScript or similar:\n\n\\`\\`\\`\naugments\ncallback\nclass\nenum\nimplements\nprivate\nproperty\nprotected\npublic\nreadonly\nthis\ntype\ntypedef\n\\`\\`\\`\n\nThese tags are unnecessary except when inside a TypeScript \\`declare\\` context:\n\n\\`\\`\\`\nabstract\naccess\nclass\nconstant\nconstructs\ndefault\nenum\nexport\nexports\nfunction\nglobal\ninherits\ninstance\ninterface\nmember\nmemberof\nmemberOf\nmethod\nmixes\nmixin\nmodule\nname\nnamespace\noverride\nproperty\nrequires\nstatic\nthis\n\\`\\`\\``,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA;AACA;AAAsD;AAEtD;AACA,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAC1B,KAAK,EACL,SAAS,EACT,iBAAiB,EACjB,YAAY,CACb,CAAC;AAEF,MAAM,0BAA0B,GAAG,IAAI,GAAG,CAAC,CACzC,UAAU,EACV,UAAU,EACV,OAAO,EACP,MAAM,EACN,YAAY,EACZ,SAAS,EACT,UAAU,EACV,WAAW,EACX,QAAQ,EACR,UAAU,EACV,MAAM,EACN,MAAM,EACN,SAAS,CACV,CAAC;AAEF,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAC,CACnC,UAAU,CACX,CAAC;AAEF,MAAM,kCAAkC,GAAG,IAAI,GAAG,CAAC,CACjD,UAAU,EACV,QAAQ,EACR,OAAO,EACP,UAAU,EACV,YAAY,EACZ,SAAS,EACT,MAAM,EACN,QAAQ,EACR,SAAS,EACT,UAAU,EACV,QAAQ,EACR,UAAU,EACV,UAAU,EACV,WAAW,EACX,QAAQ,EACR,UAAU,EACV,UAAU,EACV,QAAQ,EACR,OAAO,EACP,OAAO,EACP,QAAQ,EACR,MAAM,EACN,WAAW,EACX,UAAU,EACV,UAAU,EACV,UAAU,EACV,QAAQ,EACR,MAAM,CACP,CAAC;AAAC,iCAEY,IAAAA,qBAAY,EAAC,CAAC;EAC3B,OAAO;EACP,KAAK;EACL,SAAS;EACT,IAAI;EACJ,MAAM;EACN,QAAQ;EACR,UAAU;EACV;AACF,CAAC,KAAK;EACJ;EACE;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;EAAW;IACL,WAAW,GAAG,EAAE;IAChB,WAAW,GAAG,IAAI;IAClB,UAAU,GAAG;IACX;IACA,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU;IAC3C;IACA,YAAY,EACZ,OAAO;IACP;IACA,SAAS,EAAE,aAAa,CACzB;IACD,OAAO;IACP;EACF,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;EAE9B;EACA,IAAI,oBAAoB,GAAG,EAAE;EAC7B,MAAM;IACJ,cAAc;IACd;EACF,CAAC,GAAG,QAAQ;EACZ,MAAM,qBAAqB,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC;EACzD,MAAM,uBAAuB,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC;EAC9D,IAAI,uBAAuB,CAAC,MAAM,EAAE;IAClC,oBAAoB,GAAG,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAE,YAAY,IAAK;MAC5E,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE;QACpC;QACA,OAAO,YAAY;MACrB;MAEA,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO,SAAS;MAClB;MAEA,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE;QACpC,KAAK,CAAC,cAAc,CAClB,2FACF,CAAC;MACH;MAEA,OAAO,YAAY,CAAC,WAAW;IACjC,CAAC,CAAC,CACC,MAAM,CAAC,OAAO,CAAC;EACpB;;EAEA;AACF;AACA;AACA;EACE,MAAM,kBAAkB,GAAI,OAAO,IAAK;IACtC,OAAO,OAAO,CAAC,IAAI,KAAK,SAAS,GAC/B;IACA;IACA,CAAC,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,GAC7D,OAAO,CACL,8EACE,OAAO,CACP,OACJ,CAAC,IAAI,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC;EAC3C,CAAC;;EAED;AACF;AACA;AACA;EACE,MAAM,uBAAuB,GAAI,QAAQ,IAAK;IAC5C,IAAI,CAAC,kCAAkC,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;MACzD,OAAO,KAAK;IACd;IAEA,IAAI,QAAQ,CAAC,GAAG,KAAK,SAAS,EAAE;MAC9B,OAAO,KAAK;IACd;IAEA,IAAI,IAAI,KAAK,IAAI,EAAE;MACjB,OAAO,KAAK;IACd;;IAEA;IACA;IACA,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,CACnE,IAAI,EAAE,SAAS,EAAE,SAAS,CAC3B,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;MAC9B,OAAO,KAAK;IACd;IAEA,IAAI,kBAAkB,CAAC,yCAA2C,IAAK,CAAC,EAAE;MACxE,OAAO,KAAK;IACd;IAEA,OAAO,IAAI;EACb,CAAC;;EAED;AACF;AACA;AACA;AACA;AACA;AACA;EACE,MAAM,yBAAyB,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,oBAAoB,KAAK;IACvF,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,EAAE,WAAW,GAAG,MAAM;MACvD,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE;QAC/B,KAAK,CAAC,SAAS,CAAC,QAAQ,EAAE;UACxB,QAAQ,EAAE,EAAE;UACZ,IAAI,EAAE,EAAE;UACR,GAAG;QACL,CAAC,CAAC;MACJ,CAAC,MAAM;QACL,KAAK,CAAC,SAAS,CAAC,QAAQ,EAAE;UACxB,gBAAgB,EAAE;QACpB,CAAC,CAAC;MACJ;IACF,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC;EACjB,CAAC;;EAED;AACF;AACA;AACA;AACA;EACE,MAAM,wBAAwB,GAAG,CAAC,QAAQ,EAAE,QAAQ,KAAK;IACvD,IAAI,0BAA0B,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;MAChD,yBAAyB,CACvB,KAAK,QAAQ,CAAC,GAAG,0CAA0C,EAC3D,QAAQ,EACR,QAAQ,EACR;QACE,OAAO,EAAE,EAAE;QACX,GAAG,EAAE;MACP,CACF,CAAC;MACD,OAAO,IAAI;IACb;IAEA,IAAI,uBAAuB,CAAC,QAAQ,CAAC,EAAE;MACrC,yBAAyB,CACvB,KAAK,QAAQ,CAAC,GAAG,8FAA8F,EAC/G,QAAQ,EACR,QACF,CAAC;MACD,OAAO,IAAI;IACb;IAEA,IAAI,oBAAoB,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE;MAC5D,yBAAyB,CACvB,KAAK,QAAQ,CAAC,GAAG,yDAAyD,EAC1E,QAAQ,EACR,QACF,CAAC;MACD,OAAO,IAAI;IACb;IAEA,OAAO,KAAK;EACd,CAAC;EAED,KAAK,IAAI,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,IAAI,CAAC,EAAE;IAClE,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;IACrC,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG;IAC5B,IAAI,OAAO,IAAI,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;MACvC;IACF;IAEA,IAAI,KAAK,IAAI,wBAAwB,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE;MACzD;IACF;IAEA,MAAM,SAAS,GAAG,CAChB,GAAG,WAAW,EACd,IAAI,uBAAyB,oBAAoB,CAAE,EACnD,GAAG,uBAAuB,EAC1B,GAAG,qBAAqB,EACxB,IAAG,KAAK,GAAG,oBAAoB,GAAG,EAAE,EACrC;IAED,IAAI,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE;MACxC,IAAI,gBAAgB,GAAG,KAAK,CAAC,mBAAmB,CAAC;QAC/C,iBAAiB,EAAE,IAAI;QACvB,cAAc,EAAE,6BAA6B,OAAO,KAAK;QACzD;MACF,CAAC,CAAC;MACF,IAAI,CAAC,gBAAgB,EAAE;QACrB;MACF;MAEA,IAAI,OAAO;MACX,IAAI,OAAO,gBAAgB,KAAK,QAAQ,EAAE;QACxC,CAAC;UACC,OAAO;UACP,WAAW,EAAE;QACf,CAAC,GAAG;QACF,gBACD;MACH;MAEA,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,GAAG,4CAA4C,OAAO,qBAAqB,gBAAgB,IAAI;MACxG;MAEA,IAAI,gBAAgB,KAAK,OAAO,EAAE;QAChC,MAAM,CAAC,OAAO,EAAG,KAAK,IAAK;UACzB,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CACvD,IAAI,MAAM,CAAC,IAAI,IAAAC,2BAAkB,EAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,EACrD,IAAI,gBAAgB,EACtB,CAAC;UAED,OAAO,KAAK,CAAC,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC;QAClD,CAAC,EAAE,QAAQ,CAAC;MACd;IACF,CAAC,MAAM;MACL,MAAM,CAAC,2BAA2B,OAAO,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC;IAChE;EACF;EAEA,KAAK,MAAM,SAAS,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC,EAAE;IAC7C,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE;MACvC,MAAM,CAAC,kCAAkC,SAAS,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC;IAC7E;EACF;AACF,CAAC,EAAE;EACD,gBAAgB,EAAE,IAAI;EACtB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,kCAAkC;MAC/C,GAAG,EAAE;IACP,CAAC;IACD,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,WAAW,EAAE;UACX,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA,OAAO;UACK,KAAK,EAAE;YACL,IAAI,EAAE;UACR,CAAC;UACD,IAAI,EAAE;QACR,CAAC;QACD,WAAW,EAAE;UACX,WAAW,EAAE,uGAAuG;UACpH,IAAI,EAAE;QACR,CAAC;QACD,UAAU,EAAE;UACV,WAAW,EAAE;AACzB;AACA,0HAA0H;UAC9G,KAAK,EAAE;YACL,IAAI,EAAE;UACR,CAAC;UACD,IAAI,EAAE;QACR,CAAC;QACD,OAAO,EAAE;UACP,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,kHAAkH;UACtG,IAAI,EAAE;QACR,CAAC;QACD,KAAK,EAAE;UACL,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO;UACK,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}

package/dist/rules/checkTemplateNames.cjs

@@ -1,192 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _iterateJsdoc = _interopRequireWildcard(require("../iterateJsdoc.cjs"));
-var _jsdocUtils = require("../jsdocUtils.cjs");
-var _jsdoccomment = require("@es-joy/jsdoccomment");
-function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  jsdoc,
-  node,
-  report,
-  settings,
-  sourceCode,
-  utils
-}) => {
-  const {
-    mode
-  } = settings;
-  const tgName = /** @type {string} */utils.getPreferredTagName({
-    tagName: 'template'
-  });
-  if (!tgName) {
-    return;
-  }
-  const templateTags = utils.getTags(tgName);
-  const usedNames = new Set();
-  /**
-   * @param {string} potentialType
-   */
-  const checkForUsedTypes = potentialType => {
-    let parsedType;
-    try {
-      parsedType = mode === 'permissive' ? (0, _jsdoccomment.tryParse)(/** @type {string} */potentialType) : (0, _jsdoccomment.parse)(/** @type {string} */potentialType, mode);
-    } catch {
-      return;
-    }
-    (0, _jsdoccomment.traverse)(parsedType, nde => {
-      const {
-        type,
-        value
-      } = /** @type {import('jsdoc-type-pratt-parser').NameResult} */nde;
-      if (type === 'JsdocTypeName') {
-        usedNames.add(value);
-      }
-    });
-  };
-  const checkParamsAndReturnsTags = (jsdc = jsdoc) => {
-    const paramName = /** @type {string} */utils.getPreferredTagName({
-      tagName: 'param'
-    });
-    const paramTags = (0, _jsdocUtils.getTags)(jsdc, paramName);
-    for (const paramTag of paramTags) {
-      checkForUsedTypes(paramTag.type);
-    }
-    const returnsName = /** @type {string} */utils.getPreferredTagName({
-      tagName: 'returns'
-    });
-    const returnsTags = (0, _jsdocUtils.getTags)(jsdc, returnsName);
-    for (const returnsTag of returnsTags) {
-      checkForUsedTypes(returnsTag.type);
-    }
-  };
-  const checkTemplateTags = () => {
-    for (const tag of templateTags) {
-      const names = utils.parseClosureTemplateTag(tag);
-      for (const nme of names) {
-        if (!usedNames.has(nme)) {
-          report(`@${tgName} ${nme} not in use`, null, tag);
-        }
-      }
-    }
-  };
-
-  /**
-   * @param {import('@typescript-eslint/types').TSESTree.FunctionDeclaration|
-   *   import('@typescript-eslint/types').TSESTree.ClassDeclaration|
-   *   import('@typescript-eslint/types').TSESTree.TSInterfaceDeclaration|
-   *   import('@typescript-eslint/types').TSESTree.TSTypeAliasDeclaration} aliasDeclaration
-   * @param {boolean} [checkParamsAndReturns]
-   */
-  const checkParameters = (aliasDeclaration, checkParamsAndReturns) => {
-    /* c8 ignore next -- Guard */
-    const {
-      params
-    } = aliasDeclaration.typeParameters ?? {
-      params: []
-    };
-    for (const {
-      name: {
-        name
-      }
-    } of params) {
-      usedNames.add(name);
-    }
-    if (checkParamsAndReturns) {
-      checkParamsAndReturnsTags();
-    } else if (aliasDeclaration.type === 'ClassDeclaration') {
-      /* c8 ignore next -- TS */
-      for (const nde of aliasDeclaration?.body?.body ?? []) {
-        const commentNode = (0, _jsdoccomment.getJSDocComment)(sourceCode, nde, settings);
-        if (!commentNode) {
-          continue;
-        }
-        const innerJsdoc = (0, _iterateJsdoc.parseComment)(commentNode, '');
-        checkParamsAndReturnsTags(innerJsdoc);
-        const typeName = /** @type {string} */utils.getPreferredTagName({
-          tagName: 'type'
-        });
-        const typeTags = (0, _jsdocUtils.getTags)(innerJsdoc, typeName);
-        for (const typeTag of typeTags) {
-          checkForUsedTypes(typeTag.type);
-        }
-      }
-    }
-
-    // Template names may be used only within the heritage clause types of a
-    // class/interface, e.g. `@template T` used in `@augments {Base<T>}`.
-    for (const heritageTagName of ['augments', 'extends', 'implements']) {
-      for (const heritageTag of (0, _jsdocUtils.getTags)(jsdoc, heritageTagName)) {
-        checkForUsedTypes(heritageTag.type);
-      }
-    }
-    checkTemplateTags();
-  };
-  const handleTypeAliases = () => {
-    const nde = /** @type {import('@typescript-eslint/types').TSESTree.Node} */
-    node;
-    if (!nde) {
-      return;
-    }
-    switch (nde.type) {
-      case 'ClassDeclaration':
-      case 'TSInterfaceDeclaration':
-      case 'TSTypeAliasDeclaration':
-        checkParameters(nde);
-        break;
-      case 'ExportDefaultDeclaration':
-      case 'ExportNamedDeclaration':
-        switch (nde.declaration?.type) {
-          case 'ClassDeclaration':
-          case 'TSInterfaceDeclaration':
-          case 'TSTypeAliasDeclaration':
-            checkParameters(nde.declaration);
-            break;
-          case 'FunctionDeclaration':
-            checkParameters(nde.declaration, true);
-            break;
-        }
-        break;
-      case 'FunctionDeclaration':
-        checkParameters(nde, true);
-        break;
-    }
-  };
-  const callbackTags = utils.getTags('callback');
-  const functionTags = utils.getTags('function');
-  if (callbackTags.length || functionTags.length) {
-    checkParamsAndReturnsTags();
-    checkTemplateTags();
-    return;
-  }
-  const typedefTags = utils.getTags('typedef');
-  if (!typedefTags.length || typedefTags.length >= 2) {
-    handleTypeAliases();
-    return;
-  }
-  const potentialTypedefType = typedefTags[0].type;
-  checkForUsedTypes(potentialTypedefType);
-  const propertyName = /** @type {string} */utils.getPreferredTagName({
-    tagName: 'property'
-  });
-  const propertyTags = utils.getTags(propertyName);
-  for (const propertyTag of propertyTags) {
-    checkForUsedTypes(propertyTag.type);
-  }
-  checkTemplateTags();
-}, {
-  iterateAllJsdocs: true,
-  meta: {
-    docs: {
-      description: 'Checks that any `@template` names are actually used in the connected `@typedef` or type alias.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-template-names.md#repos-sticky-header'
-    },
-    schema: [],
-    type: 'suggestion'
-  }
-});
-module.exports = exports.default;
-//# sourceMappingURL=checkTemplateNames.cjs.map

package/dist/rules/checkTemplateNames.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"checkTemplateNames.cjs","names":["iterateJsdoc","tryParseType","parseType","traverse","getTags","getJSDocComment","parseComment"],"sources":["../../src/rules/checkTemplateNames.js"],"sourcesContent":["import iterateJsdoc, {\n  parseComment,\n} from '../iterateJsdoc.js';\nimport {\n  getTags,\n} from '../jsdocUtils.js';\nimport {\n  getJSDocComment,\n  parse as parseType,\n  traverse,\n  tryParse as tryParseType,\n} from '@es-joy/jsdoccomment';\n\nexport default iterateJsdoc(({\n  jsdoc,\n  node,\n  report,\n  settings,\n  sourceCode,\n  utils,\n}) => {\n  const {\n    mode,\n  } = settings;\n\n  const tgName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'template',\n  }));\n  if (!tgName) {\n    return;\n  }\n\n  const templateTags = utils.getTags(tgName);\n\n  const usedNames = new Set();\n  /**\n   * @param {string} potentialType\n   */\n  const checkForUsedTypes = (potentialType) => {\n    let parsedType;\n    try {\n      parsedType = mode === 'permissive' ?\n        tryParseType(/** @type {string} */ (potentialType)) :\n        parseType(/** @type {string} */ (potentialType), mode);\n    } catch {\n      return;\n    }\n\n    traverse(parsedType, (nde) => {\n      const {\n        type,\n        value,\n      } = /** @type {import('jsdoc-type-pratt-parser').NameResult} */ (nde);\n      if (type === 'JsdocTypeName') {\n        usedNames.add(value);\n      }\n    });\n  };\n\n  const checkParamsAndReturnsTags = (jsdc = jsdoc) => {\n    const paramName = /** @type {string} */ (utils.getPreferredTagName({\n      tagName: 'param',\n    }));\n    const paramTags = getTags(jsdc, paramName);\n    for (const paramTag of paramTags) {\n      checkForUsedTypes(paramTag.type);\n    }\n\n    const returnsName = /** @type {string} */ (utils.getPreferredTagName({\n      tagName: 'returns',\n    }));\n    const returnsTags = getTags(jsdc, returnsName);\n    for (const returnsTag of returnsTags) {\n      checkForUsedTypes(returnsTag.type);\n    }\n  };\n\n  const checkTemplateTags = () => {\n    for (const tag of templateTags) {\n      const names = utils.parseClosureTemplateTag(tag);\n      for (const nme of names) {\n        if (!usedNames.has(nme)) {\n          report(`@${tgName} ${nme} not in use`, null, tag);\n        }\n      }\n    }\n  };\n\n  /**\n   * @param {import('@typescript-eslint/types').TSESTree.FunctionDeclaration|\n   *   import('@typescript-eslint/types').TSESTree.ClassDeclaration|\n   *   import('@typescript-eslint/types').TSESTree.TSInterfaceDeclaration|\n   *   import('@typescript-eslint/types').TSESTree.TSTypeAliasDeclaration} aliasDeclaration\n   * @param {boolean} [checkParamsAndReturns]\n   */\n  const checkParameters = (aliasDeclaration, checkParamsAndReturns) => {\n    /* c8 ignore next -- Guard */\n    const {\n      params,\n    } = aliasDeclaration.typeParameters ?? {\n      params: [],\n    };\n    for (const {\n      name: {\n        name,\n      },\n    } of params) {\n      usedNames.add(name);\n    }\n\n    if (checkParamsAndReturns) {\n      checkParamsAndReturnsTags();\n    } else if (aliasDeclaration.type === 'ClassDeclaration') {\n      /* c8 ignore next -- TS */\n      for (const nde of aliasDeclaration?.body?.body ?? []) {\n        const commentNode = getJSDocComment(sourceCode, nde, settings);\n        if (!commentNode) {\n          continue;\n        }\n\n        const innerJsdoc = parseComment(commentNode, '');\n        checkParamsAndReturnsTags(innerJsdoc);\n\n        const typeName = /** @type {string} */ (utils.getPreferredTagName({\n          tagName: 'type',\n        }));\n        const typeTags = getTags(innerJsdoc, typeName);\n        for (const typeTag of typeTags) {\n          checkForUsedTypes(typeTag.type);\n        }\n      }\n    }\n\n    // Template names may be used only within the heritage clause types of a\n    // class/interface, e.g. `@template T` used in `@augments {Base<T>}`.\n    for (const heritageTagName of [\n      'augments', 'extends', 'implements',\n    ]) {\n      for (const heritageTag of getTags(jsdoc, heritageTagName)) {\n        checkForUsedTypes(heritageTag.type);\n      }\n    }\n\n    checkTemplateTags();\n  };\n\n  const handleTypeAliases = () => {\n    const nde = /** @type {import('@typescript-eslint/types').TSESTree.Node} */ (\n      node\n    );\n    if (!nde) {\n      return;\n    }\n\n    switch (nde.type) {\n      case 'ClassDeclaration':\n      case 'TSInterfaceDeclaration':\n      case 'TSTypeAliasDeclaration':\n        checkParameters(nde);\n        break;\n      case 'ExportDefaultDeclaration':\n      case 'ExportNamedDeclaration':\n        switch (nde.declaration?.type) {\n          case 'ClassDeclaration':\n          case 'TSInterfaceDeclaration':\n          case 'TSTypeAliasDeclaration':\n            checkParameters(nde.declaration);\n            break;\n          case 'FunctionDeclaration':\n            checkParameters(nde.declaration, true);\n            break;\n        }\n\n        break;\n      case 'FunctionDeclaration':\n        checkParameters(nde, true);\n        break;\n    }\n  };\n\n  const callbackTags = utils.getTags('callback');\n  const functionTags = utils.getTags('function');\n  if (callbackTags.length || functionTags.length) {\n    checkParamsAndReturnsTags();\n    checkTemplateTags();\n    return;\n  }\n\n  const typedefTags = utils.getTags('typedef');\n  if (!typedefTags.length || typedefTags.length >= 2) {\n    handleTypeAliases();\n    return;\n  }\n\n  const potentialTypedefType = typedefTags[0].type;\n  checkForUsedTypes(potentialTypedefType);\n\n  const propertyName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'property',\n  }));\n  const propertyTags = utils.getTags(propertyName);\n  for (const propertyTag of propertyTags) {\n    checkForUsedTypes(propertyTag.type);\n  }\n\n  checkTemplateTags();\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Checks that any `@template` names are actually used in the connected `@typedef` or type alias.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-template-names.md#repos-sticky-header',\n    },\n    schema: [],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA;AAGA;AAGA;AAK8B;AAAA,iCAEf,IAAAA,qBAAY,EAAC,CAAC;EAC3B,KAAK;EACL,IAAI;EACJ,MAAM;EACN,QAAQ;EACR,UAAU;EACV;AACF,CAAC,KAAK;EACJ,MAAM;IACJ;EACF,CAAC,GAAG,QAAQ;EAEZ,MAAM,MAAM,GAAG,qBAAuB,KAAK,CAAC,mBAAmB,CAAC;IAC9D,OAAO,EAAE;EACX,CAAC,CAAE;EACH,IAAI,CAAC,MAAM,EAAE;IACX;EACF;EAEA,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;EAE1C,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC;EAC3B;AACF;AACA;EACE,MAAM,iBAAiB,GAAI,aAAa,IAAK;IAC3C,IAAI,UAAU;IACd,IAAI;MACF,UAAU,GAAG,IAAI,KAAK,YAAY,GAChC,IAAAC,sBAAY,EAAC,qBAAuB,aAAc,CAAC,GACnD,IAAAC,mBAAS,EAAC,qBAAuB,aAAa,EAAG,IAAI,CAAC;IAC1D,CAAC,CAAC,MAAM;MACN;IACF;IAEA,IAAAC,cAAA,QAAQ,EAAC,UAAU,EAAG,GAAG,IAAK;MAC5B,MAAM;QACJ,IAAI;QACJ;MACF,CAAC,GAAG,2DAA6D,GAAI;MACrE,IAAI,IAAI,KAAK,eAAe,EAAE;QAC5B,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC;MACtB;IACF,CAAC,CAAC;EACJ,CAAC;EAED,MAAM,yBAAyB,GAAG,CAAC,IAAI,GAAG,KAAK,KAAK;IAClD,MAAM,SAAS,GAAG,qBAAuB,KAAK,CAAC,mBAAmB,CAAC;MACjE,OAAO,EAAE;IACX,CAAC,CAAE;IACH,MAAM,SAAS,GAAG,IAAAC,YAAA,OAAO,EAAC,IAAI,EAAE,SAAS,CAAC;IAC1C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;MAChC,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC;IAClC;IAEA,MAAM,WAAW,GAAG,qBAAuB,KAAK,CAAC,mBAAmB,CAAC;MACnE,OAAO,EAAE;IACX,CAAC,CAAE;IACH,MAAM,WAAW,GAAG,IAAAA,YAAA,OAAO,EAAC,IAAI,EAAE,WAAW,CAAC;IAC9C,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;MACpC,iBAAiB,CAAC,UAAU,CAAC,IAAI,CAAC;IACpC;EACF,CAAC;EAED,MAAM,iBAAiB,GAAG,MAAM;IAC9B,KAAK,MAAM,GAAG,IAAI,YAAY,EAAE;MAC9B,MAAM,KAAK,GAAG,KAAK,CAAC,uBAAuB,CAAC,GAAG,CAAC;MAChD,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE;QACvB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;UACvB,MAAM,CAAC,IAAI,MAAM,IAAI,GAAG,aAAa,EAAE,IAAI,EAAE,GAAG,CAAC;QACnD;MACF;IACF;EACF,CAAC;;EAED;AACF;AACA;AACA;AACA;AACA;AACA;EACE,MAAM,eAAe,GAAG,CAAC,gBAAgB,EAAE,qBAAqB,KAAK;IACnE;IACA,MAAM;MACJ;IACF,CAAC,GAAG,gBAAgB,CAAC,cAAc,IAAI;MACrC,MAAM,EAAE;IACV,CAAC;IACD,KAAK,MAAM;MACT,IAAI,EAAE;QACJ;MACF;IACF,CAAC,IAAI,MAAM,EAAE;MACX,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC;IACrB;IAEA,IAAI,qBAAqB,EAAE;MACzB,yBAAyB,CAAC,CAAC;IAC7B,CAAC,MAAM,IAAI,gBAAgB,CAAC,IAAI,KAAK,kBAAkB,EAAE;MACvD;MACA,KAAK,MAAM,GAAG,IAAI,gBAAgB,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE;QACpD,MAAM,WAAW,GAAG,IAAAC,cAAA,eAAe,EAAC,UAAU,EAAE,GAAG,EAAE,QAAQ,CAAC;QAC9D,IAAI,CAAC,WAAW,EAAE;UAChB;QACF;QAEA,MAAM,UAAU,GAAG,IAAAC,cAAA,YAAY,EAAC,WAAW,EAAE,EAAE,CAAC;QAChD,yBAAyB,CAAC,UAAU,CAAC;QAErC,MAAM,QAAQ,GAAG,qBAAuB,KAAK,CAAC,mBAAmB,CAAC;UAChE,OAAO,EAAE;QACX,CAAC,CAAE;QACH,MAAM,QAAQ,GAAG,IAAAF,YAAA,OAAO,EAAC,UAAU,EAAE,QAAQ,CAAC;QAC9C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;UAC9B,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC;QACjC;MACF;IACF;;IAEA;IACA;IACA,KAAK,MAAM,eAAe,IAAI,CAC5B,UAAU,EAAE,SAAS,EAAE,YAAY,CACpC,EAAE;MACD,KAAK,MAAM,WAAW,IAAI,IAAAA,YAAA,OAAO,EAAC,KAAK,EAAE,eAAe,CAAC,EAAE;QACzD,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC;MACrC;IACF;IAEA,iBAAiB,CAAC,CAAC;EACrB,CAAC;EAED,MAAM,iBAAiB,GAAG,MAAM;IAC9B,MAAM,GAAG,GAAG;IACV,IACD;IACD,IAAI,CAAC,GAAG,EAAE;MACR;IACF;IAEA,QAAQ,GAAG,CAAC,IAAI;MACd,KAAK,kBAAkB;MACvB,KAAK,wBAAwB;MAC7B,KAAK,wBAAwB;QAC3B,eAAe,CAAC,GAAG,CAAC;QACpB;MACF,KAAK,0BAA0B;MAC/B,KAAK,wBAAwB;QAC3B,QAAQ,GAAG,CAAC,WAAW,EAAE,IAAI;UAC3B,KAAK,kBAAkB;UACvB,KAAK,wBAAwB;UAC7B,KAAK,wBAAwB;YAC3B,eAAe,CAAC,GAAG,CAAC,WAAW,CAAC;YAChC;UACF,KAAK,qBAAqB;YACxB,eAAe,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC;YACtC;QACJ;QAEA;MACF,KAAK,qBAAqB;QACxB,eAAe,CAAC,GAAG,EAAE,IAAI,CAAC;QAC1B;IACJ;EACF,CAAC;EAED,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC;EAC9C,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC;EAC9C,IAAI,YAAY,CAAC,MAAM,IAAI,YAAY,CAAC,MAAM,EAAE;IAC9C,yBAAyB,CAAC,CAAC;IAC3B,iBAAiB,CAAC,CAAC;IACnB;EACF;EAEA,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC;EAC5C,IAAI,CAAC,WAAW,CAAC,MAAM,IAAI,WAAW,CAAC,MAAM,IAAI,CAAC,EAAE;IAClD,iBAAiB,CAAC,CAAC;IACnB;EACF;EAEA,MAAM,oBAAoB,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI;EAChD,iBAAiB,CAAC,oBAAoB,CAAC;EAEvC,MAAM,YAAY,GAAG,qBAAuB,KAAK,CAAC,mBAAmB,CAAC;IACpE,OAAO,EAAE;EACX,CAAC,CAAE;EACH,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC;EAChD,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;IACtC,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC;EACrC;EAEA,iBAAiB,CAAC,CAAC;AACrB,CAAC,EAAE;EACD,gBAAgB,EAAE,IAAI;EACtB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,gGAAgG;MAC7G,GAAG,EAAE;IACP,CAAC;IACD,MAAM,EAAE,EAAE;IACV,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}

package/dist/rules/checkTypes.cjs

@@ -1,111 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _buildRejectOrPreferRuleDefinition = require("../buildRejectOrPreferRuleDefinition.cjs");
-var _jsdocUtils = require("../jsdocUtils.cjs");
-/**
- * @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 {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
- */
-
-/** @type {CheckNativeTypes} */
-const checkNativeTypes = (preferredTypes, typeNodeName, preferred, parentNode, invalidTypes) => {
-  let changedPreferred = preferred;
-  for (const strictNativeType of _jsdocUtils.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;
-};
-var _default = exports.default = (0, _buildRejectOrPreferRuleDefinition.buildRejectOrPreferRuleDefinition)({
-  checkNativeTypes,
-  schema: [{
-    additionalProperties: false,
-    properties: {
-      exemptTagContexts: {
-        description: 'Avoids reporting when a bad type is found on a specified tag.',
-        items: {
-          additionalProperties: false,
-          properties: {
-            tag: {
-              description: 'Set a key `tag` to the tag to exempt',
-              type: 'string'
-            },
-            types: {
-              description: `Set to \`true\` to indicate that any types on that tag will be allowed,
-or to an array of strings which will only allow specific bad types.
-If an array of strings is given, these must match the type exactly,
-e.g., if you only allow \`"object"\`, it will not allow
-\`"object<string, string>"\`. Note that this is different from the
-behavior of \`settings.jsdoc.preferredTypes\`. This option is useful
-for normally restricting generic types like \`object\` with
-\`preferredTypes\`, but allowing \`typedef\` to indicate that its base
-type is \`object\`.`,
-              oneOf: [{
-                type: 'boolean'
-              }, {
-                items: {
-                  type: 'string'
-                },
-                type: 'array'
-              }]
-            }
-          },
-          type: 'object'
-        },
-        type: 'array'
-      },
-      noDefaults: {
-        description: `Insists that only the supplied option type
-map is to be used, and that the default preferences (such as "string"
-over "String") will not be enforced. The option's default is \`false\`.`,
-        type: 'boolean'
-      },
-      unifyParentAndChildTypeChecks: {
-        description: `@deprecated Use the \`preferredTypes[preferredType]\` setting of the same name instead.
-If this option is \`true\`, will currently override \`unifyParentAndChildTypeChecks\` on the \`preferredTypes\` setting.`,
-        type: 'boolean'
-      }
-    },
-    type: 'object'
-  }]
-});
-module.exports = exports.default;
-//# sourceMappingURL=checkTypes.cjs.map