eslint-plugin-jsdoc 53.0.1 → 54.1.0

package/dist/rules/checkSyntax.js

@@ -1,25 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/checkSyntax.js
-var checkSyntax_default = iterateJsdoc(({ jsdoc, report, settings }) => {
-	const { mode } = settings;
-	if (mode === "jsdoc" || mode === "typescript") {
-		for (const tag of jsdoc.tags) if (tag.type.slice(-1) === "=") {
-			report("Syntax should not be Google Closure Compiler style.", null, tag);
-			break;
-		}
-	}
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Reports against syntax not valid for the mode (e.g., Google Closure Compiler in non-Closure mode).",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-syntax.md#repos-sticky-header"
-		},
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { checkSyntax_default as default };
-//# sourceMappingURL=checkSyntax.js.map

package/dist/rules/checkSyntax.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"checkSyntax.js","names":[],"sources":["../../src/rules/checkSyntax.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  jsdoc,\n  report,\n  settings,\n}) => {\n  const {\n    mode,\n  } = settings;\n\n  // Don't check for \"permissive\" and \"closure\"\n  if (mode === 'jsdoc' || mode === 'typescript') {\n    for (const tag of jsdoc.tags) {\n      if (tag.type.slice(-1) === '=') {\n        report('Syntax should not be Google Closure Compiler style.', null, tag);\n        break;\n      }\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Reports against syntax not valid for the mode (e.g., Google Closure Compiler in non-Closure mode).',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-syntax.md#repos-sticky-header',\n    },\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,0BAAe,aAAa,CAAC,EAC3B,OACA,QACA,UACD,KAAK;CACJ,MAAM,EACJ,MACD,GAAG;AAGJ,KAAI,SAAS,WAAW,SAAS,cAC/B;OAAK,MAAM,OAAO,MAAM,KACtB,KAAI,IAAI,KAAK,MAAM,GAAG,KAAK,KAAK;GAC9B,OAAO,uDAAuD,MAAM,IAAI;AACxE;EACD;CACF;AAEJ,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/checkTagNames.js

@@ -1,191 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-import escapeStringRegexp from "escape-string-regexp";
-
-//#region src/rules/checkTagNames.js
-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 checkTagNames_default = iterateJsdoc(({ context, jsdoc, jsdocNode, node, report, settings, sourceCode, utils }) => {
-	const { definedTags = [], enableFixer = true, 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") return preferredTag;
-		if (!preferredTag) return void 0;
-		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" ? 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;
-		if (context.getFilename().endsWith(".d.ts") && [
-			null,
-			"Program",
-			void 0
-		].includes(node?.parent?.type)) return false;
-		if (isInAmbientContext(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,
-			...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} = 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(`@${escapeStringRegexp(tagName)}\\b`, "v"), `@${preferredTagName}`);
-				return fixer.replaceText(jsdocNode, replacement);
-			}, jsdocTag);
-		} else report(`Invalid JSDoc tag name "${tagName}".`, null, jsdocTag);
-	}
-}, {
-	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: {
-					items: { type: "string" },
-					type: "array"
-				},
-				enableFixer: { type: "boolean" },
-				jsxTags: { type: "boolean" },
-				typed: { type: "boolean" }
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { checkTagNames_default as default };
-//# sourceMappingURL=checkTagNames.js.map

package/dist/rules/checkTagNames.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"checkTagNames.js","names":[],"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     *   jsxTags: boolean,\n     *   typed: boolean\n     }} */ {\n      definedTags = [],\n      enableFixer = true,\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      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    if (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  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            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          enableFixer: {\n            type: 'boolean',\n          },\n          jsxTags: {\n            type: 'boolean',\n          },\n          typed: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;AAIA,MAAM,cAAc,IAAI,IAAI;CAC1B;CACA;CACA;CACA;AACD;AAED,MAAM,6BAA6B,IAAI,IAAI;CACzC;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;AAED,MAAM,uBAAuB,IAAI,IAAI,CACnC,UACD;AAED,MAAM,qCAAqC,IAAI,IAAI;CACjD;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;AAED,4BAAe,aAAa,CAAC,EAC3B,SACA,OACA,WACA,MACA,QACA,UACA,YACA,OACD,KAAK;CACJ,MAOS,EACL,cAAc,CAAE,GAChB,cAAc,MACd,SACA,OACD,GAAG,QAAQ,QAAQ,MAAM,CAAE;;CAG9B,IAAI,uBAAuB,CAAE;CAC7B,MAAM,EACJ,gBACA,mBACD,GAAG;CACJ,MAAM,wBAAwB,OAAO,KAAK,eAAe;CACzD,MAAM,0BAA0B,OAAO,KAAK,kBAAkB;AAC9D,KAAI,wBAAwB,QAC1B,uBAAuB,OAAO,OAAO,kBAAkB,CAAC,IAAI,CAAC,iBAAiB;AAC5E,MAAI,OAAO,iBAAiB,SAE1B,QAAO;AAGT,MAAI,CAAC,aACH,QAAO;AAGT,MAAI,OAAO,iBAAiB,UAC1B,MAAM,eACJ,4FACD;AAGH,SAAO,aAAa;CACrB,EAAC,CACC,OAAO,QAAQ;;;;;CAOpB,MAAM,qBAAqB,CAAC,YAAY;AACtC,SAAO,QAAQ,SAAS,YACtB,QAAQ,aAAa,CAAC,SAAS,QAAQ,GACvC;;GAEI,QACA;GACH,IAAI,mBAAmB,QAAQ,OAAO;CAC1C;;;;;CAMD,MAAM,0BAA0B,CAAC,aAAa;AAC5C,MAAI,CAAC,mCAAmC,IAAI,SAAS,IAAI,CACvD,QAAO;AAGT,MAAI,SAAS,QAAQ,UACnB,QAAO;AAGT,MAAI,SAAS,KACX,QAAO;AAGT,MAAI,QAAQ,aAAa,CAAC,SAAS,QAAQ,IAAI;GAC7C;GAAM;GAAW;EAClB,EAAC,SAAS,MAAM,QAAQ,KAAK,CAC5B,QAAO;AAGT,MAAI,mBAA8D,KAAM,CACtE,QAAO;AAGT,SAAO;CACR;;;;;;;;CASD,MAAM,4BAA4B,CAAC,SAAS,UAAU,UAAU,yBAAyB;EACvF,MAAM,YAAY,SAAS,UAAU,cAAc,MAAM;AACvD,OAAI,SAAS,YAAY,MAAM,EAC7B,MAAM,UAAU,UAAU;IACxB,UAAU;IACV,MAAM;IACN,GAAG;GACJ,EAAC;QAEF,MAAM,UAAU,UAAU,EACxB,kBAAkB,KACnB,EAAC;EAEL,IAAG,MAAM,KAAK;CAChB;;;;;;CAOD,MAAM,2BAA2B,CAAC,UAAU,aAAa;AACvD,MAAI,2BAA2B,IAAI,SAAS,IAAI,EAAE;GAChD,0BACE,CAAC,EAAE,EAAE,SAAS,IAAI,wCAAwC,CAAC,EAC3D,UACA,UACA;IACE,SAAS;IACT,KAAK;GACN,EACF;AACD,UAAO;EACR;AAED,MAAI,wBAAwB,SAAS,EAAE;GACrC,0BACE,CAAC,EAAE,EAAE,SAAS,IAAI,4FAA4F,CAAC,EAC/G,UACA,SACD;AACD,UAAO;EACR;AAED,MAAI,qBAAqB,IAAI,SAAS,IAAI,IAAI,CAAC,SAAS,MAAM;GAC5D,0BACE,CAAC,EAAE,EAAE,SAAS,IAAI,uDAAuD,CAAC,EAC1E,UACA,SACD;AACD,UAAO;EACR;AAED,SAAO;CACR;AAED,MAAK,IAAI,WAAW,GAAG,WAAW,MAAM,KAAK,QAAQ,YAAY,GAAG;EAClE,MAAM,WAAW,MAAM,KAAK;EAC5B,MAAM,UAAU,SAAS;AACzB,MAAI,WAAW,YAAY,IAAI,QAAQ,CACrC;AAGF,MAAI,SAAS,yBAAyB,UAAU,SAAS,CACvD;EAGF,MAAM,YAAY;GAChB,GAAG;GACH,GAA6B;GAC7B,GAAG;GACH,GAAG;GACH,GAAG,QAAQ,uBAAuB,CAAE;EACrC;AAED,MAAI,MAAM,WAAW,SAAS,UAAU,EAAE;GACxC,IAAI,mBAAmB,MAAM,oBAAoB;IAC/C,mBAAmB;IACnB,gBAAgB,CAAC,0BAA0B,EAAE,QAAQ,GAAG,CAAC;IACzD;GACD,EAAC;AACF,OAAI,CAAC,iBACH;GAGF,IAAI;AACJ,OAAI,OAAO,qBAAqB,WAC7B,CACC,SACA,aAAa,iBACd,GACC;AAIJ,OAAI,CAAC,SACH,UAAU,CAAC,yCAAyC,EAAE,QAAQ,kBAAkB,EAAE,iBAAiB,EAAE,CAAC;AAGxG,OAAI,qBAAqB,SACvB,OAAO,SAAS,CAAC,UAAU;IACzB,MAAM,cAAc,WAAW,QAAQ,UAAU,CAAC,QAChD,IAAI,OAAO,CAAC,CAAC,EAAE,mBAAmB,QAAQ,CAAC,GAAG,CAAC,EAAE,MACjD,CAAC,CAAC,EAAE,kBAAkB,CACvB;AAED,WAAO,MAAM,YAAY,WAAW,YAAY;GACjD,GAAE,SAAS;EAEf,OACC,OAAO,CAAC,wBAAwB,EAAE,QAAQ,EAAE,CAAC,EAAE,MAAM,SAAS;CAEjE;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,aAAa;KACX,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,aAAa,EACX,MAAM,UACP;IACD,SAAS,EACP,MAAM,UACP;IACD,OAAO,EACL,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/checkTemplateNames.js

@@ -1,124 +0,0 @@
-import { getTags } from "../jsdocUtils.js";
-import iterateJsdoc, { parseComment } from "../iterateJsdoc.js";
-import { getJSDocComment, parse, traverse, tryParse } from "@es-joy/jsdoccomment";
-
-//#region src/rules/checkTemplateNames.js
-var checkTemplateNames_default = iterateJsdoc(({ jsdoc, node, report, settings, sourceCode, utils }) => {
-	const { mode } = settings;
-	const templateTags = utils.getTags("template");
-	const usedNames = /* @__PURE__ */ new Set();
-	/**
-	* @param {string} potentialType
-	*/
-	const checkForUsedTypes = (potentialType) => {
-		let parsedType;
-		try {
-			parsedType = mode === "permissive" ? tryParse(potentialType) : parse(potentialType, mode);
-		} catch {
-			return;
-		}
-		traverse(parsedType, (nde) => {
-			const { type, value } = nde;
-			if (type === "JsdocTypeName") usedNames.add(value);
-		});
-	};
-	const checkParamsAndReturnsTags = (jsdc = jsdoc) => {
-		const paramName = utils.getPreferredTagName({ tagName: "param" });
-		const paramTags = getTags(jsdc, paramName);
-		for (const paramTag of paramTags) checkForUsedTypes(paramTag.type);
-		const returnsName = utils.getPreferredTagName({ tagName: "returns" });
-		const returnsTags = getTags(jsdc, returnsName);
-		for (const returnsTag of returnsTags) checkForUsedTypes(returnsTag.type);
-	};
-	const checkTemplateTags = () => {
-		for (const tag of templateTags) {
-			const { name } = tag;
-			const names = name.split(/,\s*/v);
-			for (const nme of names) if (!usedNames.has(nme)) report(`@template ${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 = getJSDocComment(sourceCode, nde, settings);
-			if (!commentNode) continue;
-			const innerJsdoc = parseComment(commentNode, "");
-			checkParamsAndReturnsTags(innerJsdoc);
-			const typeName = utils.getPreferredTagName({ tagName: "type" });
-			const typeTags = getTags(innerJsdoc, typeName);
-			for (const typeTag of typeTags) checkForUsedTypes(typeTag.type);
-		}
-		checkTemplateTags();
-	};
-	const handleTypeAliases = () => {
-		const nde = 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 = 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"
-	}
-});
-
-//#endregion
-export { checkTemplateNames_default as default };
-//# sourceMappingURL=checkTemplateNames.js.map

package/dist/rules/checkTemplateNames.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"checkTemplateNames.js","names":["tryParseType","parseType"],"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 templateTags = utils.getTags('template');\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 {\n        name,\n      } = tag;\n      const names = name.split(/,\\s*/v);\n      for (const nme of names) {\n        if (!usedNames.has(nme)) {\n          report(`@template ${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        // @ts-expect-error Should be ok\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    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,iCAAe,aAAa,CAAC,EAC3B,OACA,MACA,QACA,UACA,YACA,OACD,KAAK;CACJ,MAAM,EACJ,MACD,GAAG;CAEJ,MAAM,eAAe,MAAM,QAAQ,WAAW;CAE9C,MAAM,4BAAY,IAAI;;;;CAItB,MAAM,oBAAoB,CAAC,kBAAkB;EAC3C,IAAI;AACJ,MAAI;GACF,aAAa,SAAS,eACpBA,SAAoC,cAAe,GACnDC,MAAiC,eAAgB,KAAK;EACzD,QAAO;AACN;EACD;EAED,SAAS,YAAY,CAAC,QAAQ;GAC5B,MAAM,EACJ,MACA,OACD,GAAgE;AACjE,OAAI,SAAS,iBACX,UAAU,IAAI,MAAM;EAEvB,EAAC;CACH;CAED,MAAM,4BAA4B,CAAC,OAAO,UAAU;EAClD,MAAM,YAAmC,MAAM,oBAAoB,EACjE,SAAS,QACV,EAAC;EACF,MAAM,YAAY,QAAQ,MAAM,UAAU;AAC1C,OAAK,MAAM,YAAY,WACrB,kBAAkB,SAAS,KAAK;EAGlC,MAAM,cAAqC,MAAM,oBAAoB,EACnE,SAAS,UACV,EAAC;EACF,MAAM,cAAc,QAAQ,MAAM,YAAY;AAC9C,OAAK,MAAM,cAAc,aACvB,kBAAkB,WAAW,KAAK;CAErC;CAED,MAAM,oBAAoB,MAAM;AAC9B,OAAK,MAAM,OAAO,cAAc;GAC9B,MAAM,EACJ,MACD,GAAG;GACJ,MAAM,QAAQ,KAAK,MAAM,QAAQ;AACjC,QAAK,MAAM,OAAO,MAChB,KAAI,CAAC,UAAU,IAAI,IAAI,EACrB,OAAO,CAAC,UAAU,EAAE,IAAI,WAAW,CAAC,EAAE,MAAM,IAAI;EAGrD;CACF;;;;;;;;CASD,MAAM,kBAAkB,CAAC,kBAAkB,0BAA0B;;EAEnE,MAAM,EACJ,QACD,GAAG,iBAAiB,kBAAkB,EACrC,QAAQ,CAAE,EACX;AACD,OAAK,MAAM,EACT,MAAM,EACJ,MACD,EACF,IAAI,QACH,UAAU,IAAI,KAAK;AAGrB,MAAI,uBACF,2BAA2B;WAClB,iBAAiB,SAAS;;AAEnC,OAAK,MAAM,OAAO,kBAAkB,MAAM,QAAQ,CAAE,GAAE;GAEpD,MAAM,cAAc,gBAAgB,YAAY,KAAK,SAAS;AAC9D,OAAI,CAAC,YACH;GAGF,MAAM,aAAa,aAAa,aAAa,GAAG;GAChD,0BAA0B,WAAW;GAErC,MAAM,WAAkC,MAAM,oBAAoB,EAChE,SAAS,OACV,EAAC;GACF,MAAM,WAAW,QAAQ,YAAY,SAAS;AAC9C,QAAK,MAAM,WAAW,UACpB,kBAAkB,QAAQ,KAAK;EAElC;EAGH,mBAAmB;CACpB;CAED,MAAM,oBAAoB,MAAM;EAC9B,MAAM,MACJ;AAEF,MAAI,CAAC,IACH;AAGF,UAAQ,IAAI,MAAZ;GACE,KAAK;GACL,KAAK;GACL,KAAK;IACH,gBAAgB,IAAI;AACpB;GACF,KAAK;GACL,KAAK;AACH,YAAQ,IAAI,aAAa,MAAzB;KACE,KAAK;KACL,KAAK;KACL,KAAK;MACH,gBAAgB,IAAI,YAAY;AAChC;KACF,KAAK;MACH,gBAAgB,IAAI,aAAa,KAAK;AACtC;IACH;AAED;GACF,KAAK;IACH,gBAAgB,KAAK,KAAK;AAC1B;EACH;CACF;CAED,MAAM,eAAe,MAAM,QAAQ,WAAW;CAC9C,MAAM,eAAe,MAAM,QAAQ,WAAW;AAC9C,KAAI,aAAa,UAAU,aAAa,QAAQ;EAC9C,2BAA2B;EAC3B,mBAAmB;AACnB;CACD;CAED,MAAM,cAAc,MAAM,QAAQ,UAAU;AAC5C,KAAI,CAAC,YAAY,UAAU,YAAY,UAAU,GAAG;EAClD,mBAAmB;AACnB;CACD;CAED,MAAM,uBAAuB,YAAY,GAAG;CAC5C,kBAAkB,qBAAqB;CAEvC,MAAM,eAAsC,MAAM,oBAAoB,EACpE,SAAS,WACV,EAAC;CACF,MAAM,eAAe,MAAM,QAAQ,aAAa;AAChD,MAAK,MAAM,eAAe,cACxB,kBAAkB,YAAY,KAAK;CAGrC,mBAAmB;AACpB,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CAAE;EACV,MAAM;CACP;AACF,EAAC"}