eslint-plugin-jsdoc 53.0.1 → 54.1.0

package/dist/rules/requirePropertyName.js

@@ -1,21 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/requirePropertyName.js
-var requirePropertyName_default = iterateJsdoc(({ report, utils }) => {
-	utils.forEachPreferredTag("property", (jsdoc, targetTagName) => {
-		if (jsdoc.tag && jsdoc.name === "") report(`There must be an identifier after @${targetTagName} ${jsdoc.type === "" ? "type" : "tag"}.`, null, jsdoc);
-	});
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Requires that all function `@property` tags have names.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-name.md#repos-sticky-header"
-		},
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { requirePropertyName_default as default };
-//# sourceMappingURL=requirePropertyName.js.map

package/dist/rules/requirePropertyName.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requirePropertyName.js","names":[],"sources":["../../src/rules/requirePropertyName.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  report,\n  utils,\n}) => {\n  utils.forEachPreferredTag('property', (jsdoc, targetTagName) => {\n    if (jsdoc.tag && jsdoc.name === '') {\n      report(\n        `There must be an identifier after @${targetTagName} ${jsdoc.type === '' ? 'type' : 'tag'}.`,\n        null,\n        jsdoc,\n      );\n    }\n  });\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Requires that all function `@property` tags have names.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-name.md#repos-sticky-header',\n    },\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,kCAAe,aAAa,CAAC,EAC3B,QACA,OACD,KAAK;CACJ,MAAM,oBAAoB,YAAY,CAAC,OAAO,kBAAkB;AAC9D,MAAI,MAAM,OAAO,MAAM,SAAS,IAC9B,OACE,CAAC,mCAAmC,EAAE,cAAc,CAAC,EAAE,MAAM,SAAS,KAAK,SAAS,MAAM,CAAC,CAAC,EAC5F,MACA,MACD;CAEJ,EAAC;AACH,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/requirePropertyType.js

@@ -1,21 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/requirePropertyType.js
-var requirePropertyType_default = iterateJsdoc(({ report, utils }) => {
-	utils.forEachPreferredTag("property", (jsdoc, targetTagName) => {
-		if (!jsdoc.type) report(`Missing JSDoc @${targetTagName} "${jsdoc.name}" type.`, null, jsdoc);
-	});
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Requires that each `@property` tag has a `type` value.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-type.md#repos-sticky-header"
-		},
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { requirePropertyType_default as default };
-//# sourceMappingURL=requirePropertyType.js.map

package/dist/rules/requirePropertyType.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requirePropertyType.js","names":[],"sources":["../../src/rules/requirePropertyType.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  report,\n  utils,\n}) => {\n  utils.forEachPreferredTag('property', (jsdoc, targetTagName) => {\n    if (!jsdoc.type) {\n      report(\n        `Missing JSDoc @${targetTagName} \"${jsdoc.name}\" type.`,\n        null,\n        jsdoc,\n      );\n    }\n  });\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Requires that each `@property` tag has a `type` value.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-type.md#repos-sticky-header',\n    },\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,kCAAe,aAAa,CAAC,EAC3B,QACA,OACD,KAAK;CACJ,MAAM,oBAAoB,YAAY,CAAC,OAAO,kBAAkB;AAC9D,MAAI,CAAC,MAAM,MACT,OACE,CAAC,eAAe,EAAE,cAAc,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,EACvD,MACA,MACD;CAEJ,EAAC;AACH,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/requireReturns.js

@@ -1,131 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-import exportParser_default from "../exportParser.js";
-
-//#region src/rules/requireReturns.js
-/**
-* We can skip checking for a return value, in case the documentation is inherited
-* or the method is either a constructor or an abstract method.
-*
-* In either of these cases the return value is optional or not defined.
-* @param {import('../iterateJsdoc.js').Utils} utils
-*   a reference to the utils which are used to probe if a tag is present or not.
-* @returns {boolean}
-*   true in case deep checking can be skipped; otherwise false.
-*/
-const canSkip = (utils) => {
-	return utils.hasATag([
-		"abstract",
-		"virtual",
-		"class",
-		"constructor",
-		"type",
-		"interface"
-	]) || utils.avoidDocs();
-};
-var requireReturns_default = iterateJsdoc(({ context, info: { comment }, node, report, settings, utils }) => {
-	const { contexts, enableFixer = false, forceRequireReturn = false, forceReturnsWithAsync = false, publicOnly = false } = context.options[0] || {};
-	if (canSkip(utils)) return;
-	/** @type {boolean|undefined} */
-	let forceRequireReturnContext;
-	if (contexts) {
-		const { foundContext } = utils.findContext(contexts, comment);
-		if (typeof foundContext === "object") forceRequireReturnContext = foundContext.forceRequireReturn;
-	}
-	const tagName = utils.getPreferredTagName({ tagName: "returns" });
-	if (!tagName) return;
-	const tags = utils.getTags(tagName);
-	if (tags.length > 1) report(`Found more than one @${tagName} declaration.`);
-	const iteratingFunction = utils.isIteratingFunction();
-	const [tag] = tags;
-	const missingReturnTag = typeof tag === "undefined" || tag === null;
-	const shouldReport = () => {
-		if (!missingReturnTag) return false;
-		if (publicOnly) {
-			/** @type {import('./requireJsdoc.js').RequireJsdocOpts} */
-			const opt = {
-				ancestorsOnly: Boolean(publicOnly?.ancestorsOnly ?? false),
-				esm: Boolean(publicOnly?.esm ?? true),
-				initModuleExports: Boolean(publicOnly?.cjs ?? true),
-				initWindow: Boolean(publicOnly?.window ?? false)
-			};
-			/* c8 ignore next -- Fallback to deprecated method */
-			const { sourceCode = context.getSourceCode() } = context;
-			const exported = exportParser_default.isUncommentedExport(node, sourceCode, opt, settings);
-			if (!exported) return false;
-		}
-		if ((forceRequireReturn || forceRequireReturnContext) && (iteratingFunction || utils.isVirtualFunction())) return true;
-		const isAsync = !iteratingFunction && utils.hasTag("async") || iteratingFunction && utils.isAsync();
-		if (forceReturnsWithAsync && isAsync) return true;
-		return iteratingFunction && utils.hasValueOrExecutorHasNonEmptyResolveValue(forceReturnsWithAsync);
-	};
-	if (shouldReport()) utils.reportJSDoc(`Missing JSDoc @${tagName} declaration.`, null, enableFixer ? () => {
-		utils.addTag(tagName);
-	} : null);
-}, {
-	contextDefaults: true,
-	meta: {
-		docs: {
-			description: "Requires that returns are documented.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns.md#repos-sticky-header"
-		},
-		fixable: "code",
-		schema: [{
-			additionalProperties: false,
-			properties: {
-				checkConstructors: {
-					default: false,
-					type: "boolean"
-				},
-				checkGetters: {
-					default: true,
-					type: "boolean"
-				},
-				contexts: {
-					items: { anyOf: [{ type: "string" }, {
-						additionalProperties: false,
-						properties: {
-							comment: { type: "string" },
-							context: { type: "string" },
-							forceRequireReturn: { type: "boolean" }
-						},
-						type: "object"
-					}] },
-					type: "array"
-				},
-				enableFixer: { type: "boolean" },
-				exemptedBy: {
-					items: { type: "string" },
-					type: "array"
-				},
-				forceRequireReturn: {
-					default: false,
-					type: "boolean"
-				},
-				forceReturnsWithAsync: {
-					default: false,
-					type: "boolean"
-				},
-				publicOnly: { oneOf: [{
-					default: false,
-					type: "boolean"
-				}, {
-					additionalProperties: false,
-					default: {},
-					properties: {
-						ancestorsOnly: { type: "boolean" },
-						cjs: { type: "boolean" },
-						esm: { type: "boolean" },
-						window: { type: "boolean" }
-					},
-					type: "object"
-				}] }
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { requireReturns_default as default };
-//# sourceMappingURL=requireReturns.js.map

package/dist/rules/requireReturns.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireReturns.js","names":["exportParser"],"sources":["../../src/rules/requireReturns.js"],"sourcesContent":["import exportParser from '../exportParser.js';\nimport iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * We can skip checking for a return value, in case the documentation is inherited\n * or the method is either a constructor or an abstract method.\n *\n * In either of these cases the return value is optional or not defined.\n * @param {import('../iterateJsdoc.js').Utils} utils\n *   a reference to the utils which are used to probe if a tag is present or not.\n * @returns {boolean}\n *   true in case deep checking can be skipped; otherwise false.\n */\nconst canSkip = (utils) => {\n  return utils.hasATag([\n    // inheritdoc implies that all documentation is inherited\n    // see https://jsdoc.app/tags-inheritdoc.html\n    //\n    // Abstract methods are by definition incomplete,\n    // so it is not an error if it declares a return value but does not implement it.\n    'abstract',\n    'virtual',\n\n    // Constructors do not have a return value by definition (https://jsdoc.app/tags-class.html)\n    // So we can bail out here, too.\n    'class',\n    'constructor',\n\n    // Return type is specified by type in @type\n    'type',\n\n    // This seems to imply a class as well\n    'interface',\n  ]) ||\n    utils.avoidDocs();\n};\n\nexport default iterateJsdoc(({\n  context,\n  info: {\n    comment,\n  },\n  node,\n  report,\n  settings,\n  utils,\n}) => {\n  const {\n    contexts,\n    enableFixer = false,\n    forceRequireReturn = false,\n    forceReturnsWithAsync = false,\n    publicOnly = false,\n  } = context.options[0] || {};\n\n  // A preflight check. We do not need to run a deep check\n  // in case the @returns comment is optional or undefined.\n  if (canSkip(utils)) {\n    return;\n  }\n\n  /** @type {boolean|undefined} */\n  let forceRequireReturnContext;\n  if (contexts) {\n    const {\n      foundContext,\n    } = utils.findContext(contexts, comment);\n    if (typeof foundContext === 'object') {\n      forceRequireReturnContext = foundContext.forceRequireReturn;\n    }\n  }\n\n  const tagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'returns',\n  }));\n  if (!tagName) {\n    return;\n  }\n\n  const tags = utils.getTags(tagName);\n\n  if (tags.length > 1) {\n    report(`Found more than one @${tagName} declaration.`);\n  }\n\n  const iteratingFunction = utils.isIteratingFunction();\n\n  // In case the code returns something, we expect a return value in JSDoc.\n  const [\n    tag,\n  ] = tags;\n  const missingReturnTag = typeof tag === 'undefined' || tag === null;\n\n  const shouldReport = () => {\n    if (!missingReturnTag) {\n      return false;\n    }\n\n    if (publicOnly) {\n      /** @type {import('./requireJsdoc.js').RequireJsdocOpts} */\n      const opt = {\n        ancestorsOnly: Boolean(publicOnly?.ancestorsOnly ?? false),\n        esm: Boolean(publicOnly?.esm ?? true),\n        initModuleExports: Boolean(publicOnly?.cjs ?? true),\n        initWindow: Boolean(publicOnly?.window ?? false),\n      };\n      /* c8 ignore next -- Fallback to deprecated method */\n      const {\n        sourceCode = context.getSourceCode(),\n      } = context;\n      const exported = exportParser.isUncommentedExport(\n        /** @type {import('eslint').Rule.Node} */ (node), sourceCode, opt, settings,\n      );\n\n      if (!exported) {\n        return false;\n      }\n    }\n\n    if ((forceRequireReturn || forceRequireReturnContext) && (\n      iteratingFunction || utils.isVirtualFunction()\n    )) {\n      return true;\n    }\n\n    const isAsync = !iteratingFunction && utils.hasTag('async') ||\n      iteratingFunction && utils.isAsync();\n\n    if (forceReturnsWithAsync && isAsync) {\n      return true;\n    }\n\n    return iteratingFunction && utils.hasValueOrExecutorHasNonEmptyResolveValue(\n      forceReturnsWithAsync,\n    );\n  };\n\n  if (shouldReport()) {\n    utils.reportJSDoc(`Missing JSDoc @${tagName} declaration.`, null, enableFixer ? () => {\n      utils.addTag(tagName);\n    } : null);\n  }\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that returns are documented.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          checkConstructors: {\n            default: false,\n            type: 'boolean',\n          },\n          checkGetters: {\n            default: true,\n            type: 'boolean',\n          },\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                    forceRequireReturn: {\n                      type: 'boolean',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          enableFixer: {\n            type: 'boolean',\n          },\n          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          forceRequireReturn: {\n            default: false,\n            type: 'boolean',\n          },\n          forceReturnsWithAsync: {\n            default: false,\n            type: 'boolean',\n          },\n          publicOnly: {\n            oneOf: [\n              {\n                default: false,\n                type: 'boolean',\n              },\n              {\n                additionalProperties: false,\n                default: {},\n                properties: {\n                  ancestorsOnly: {\n                    type: 'boolean',\n                  },\n                  cjs: {\n                    type: 'boolean',\n                  },\n                  esm: {\n                    type: 'boolean',\n                  },\n                  window: {\n                    type: 'boolean',\n                  },\n                },\n                type: 'object',\n              },\n            ],\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;;;;;;;AAaA,MAAM,UAAU,CAAC,UAAU;AACzB,QAAO,MAAM,QAAQ;EAMnB;EACA;EAIA;EACA;EAGA;EAGA;CACD,EAAC,IACA,MAAM,WAAW;AACpB;AAED,6BAAe,aAAa,CAAC,EAC3B,SACA,MAAM,EACJ,SACD,EACD,MACA,QACA,UACA,OACD,KAAK;CACJ,MAAM,EACJ,UACA,cAAc,OACd,qBAAqB,OACrB,wBAAwB,OACxB,aAAa,OACd,GAAG,QAAQ,QAAQ,MAAM,CAAE;AAI5B,KAAI,QAAQ,MAAM,CAChB;;CAIF,IAAI;AACJ,KAAI,UAAU;EACZ,MAAM,EACJ,cACD,GAAG,MAAM,YAAY,UAAU,QAAQ;AACxC,MAAI,OAAO,iBAAiB,UAC1B,4BAA4B,aAAa;CAE5C;CAED,MAAM,UAAiC,MAAM,oBAAoB,EAC/D,SAAS,UACV,EAAC;AACF,KAAI,CAAC,QACH;CAGF,MAAM,OAAO,MAAM,QAAQ,QAAQ;AAEnC,KAAI,KAAK,SAAS,GAChB,OAAO,CAAC,qBAAqB,EAAE,QAAQ,aAAa,CAAC,CAAC;CAGxD,MAAM,oBAAoB,MAAM,qBAAqB;CAGrD,MAAM,CACJ,IACD,GAAG;CACJ,MAAM,mBAAmB,OAAO,QAAQ,eAAe,QAAQ;CAE/D,MAAM,eAAe,MAAM;AACzB,MAAI,CAAC,iBACH,QAAO;AAGT,MAAI,YAAY;;GAEd,MAAM,MAAM;IACV,eAAe,QAAQ,YAAY,iBAAiB,MAAM;IAC1D,KAAK,QAAQ,YAAY,OAAO,KAAK;IACrC,mBAAmB,QAAQ,YAAY,OAAO,KAAK;IACnD,YAAY,QAAQ,YAAY,UAAU,MAAM;GACjD;;GAED,MAAM,EACJ,aAAa,QAAQ,eAAe,EACrC,GAAG;GACJ,MAAM,WAAWA,qBAAa,oBACe,MAAO,YAAY,KAAK,SACpE;AAED,OAAI,CAAC,SACH,QAAO;EAEV;AAED,OAAK,sBAAsB,+BACzB,qBAAqB,MAAM,mBAAmB,EAE9C,QAAO;EAGT,MAAM,UAAU,CAAC,qBAAqB,MAAM,OAAO,QAAQ,IACzD,qBAAqB,MAAM,SAAS;AAEtC,MAAI,yBAAyB,QAC3B,QAAO;AAGT,SAAO,qBAAqB,MAAM,0CAChC,sBACD;CACF;AAED,KAAI,cAAc,EAChB,MAAM,YAAY,CAAC,eAAe,EAAE,QAAQ,aAAa,CAAC,EAAE,MAAM,cAAc,MAAM;EACpF,MAAM,OAAO,QAAQ;CACtB,IAAG,KAAK;AAEZ,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,mBAAmB;KACjB,SAAS;KACT,MAAM;IACP;IACD,cAAc;KACZ,SAAS;KACT,MAAM;IACP;IACD,UAAU;KACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;MACE,sBAAsB;MACtB,YAAY;OACV,SAAS,EACP,MAAM,SACP;OACD,SAAS,EACP,MAAM,SACP;OACD,oBAAoB,EAClB,MAAM,UACP;MACF;MACD,MAAM;KACP,CACF,EACF;KACD,MAAM;IACP;IACD,aAAa,EACX,MAAM,UACP;IACD,YAAY;KACV,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,oBAAoB;KAClB,SAAS;KACT,MAAM;IACP;IACD,uBAAuB;KACrB,SAAS;KACT,MAAM;IACP;IACD,YAAY,EACV,OAAO,CACL;KACE,SAAS;KACT,MAAM;IACP,GACD;KACE,sBAAsB;KACtB,SAAS,CAAE;KACX,YAAY;MACV,eAAe,EACb,MAAM,UACP;MACD,KAAK,EACH,MAAM,UACP;MACD,KAAK,EACH,MAAM,UACP;MACD,QAAQ,EACN,MAAM,UACP;KACF;KACD,MAAM;IACP,CACF,EACF;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/requireReturnsCheck.js

@@ -1,66 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/requireReturnsCheck.js
-/**
-* @param {import('../iterateJsdoc.js').Utils} utils
-* @param {import('../iterateJsdoc.js').Settings} settings
-* @returns {boolean}
-*/
-const canSkip = (utils, settings) => {
-	const voidingTags = [
-		"abstract",
-		"virtual",
-		"class",
-		"constructor",
-		"interface"
-	];
-	if (settings.mode === "closure") voidingTags.push("record");
-	return utils.hasATag(voidingTags) || utils.isConstructor() || utils.classHasTag("interface") || settings.mode === "closure" && utils.classHasTag("record");
-};
-var requireReturnsCheck_default = iterateJsdoc(({ context, node, report, settings, utils }) => {
-	const { exemptAsync = true, exemptGenerators = settings.mode === "typescript", reportMissingReturnForUndefinedTypes = false } = context.options[0] || {};
-	if (canSkip(utils, settings)) return;
-	if (exemptAsync && utils.isAsync()) return;
-	const tagName = utils.getPreferredTagName({ tagName: "returns" });
-	if (!tagName) return;
-	const tags = utils.getTags(tagName);
-	if (tags.length === 0) return;
-	if (tags.length > 1) {
-		report(`Found more than one @${tagName} declaration.`);
-		return;
-	}
-	const [tag] = tags;
-	const type = tag.type.trim();
-	if (/asserts\s/v.test(type)) return;
-	const returnNever = type === "never";
-	if (returnNever && utils.hasValueOrExecutorHasNonEmptyResolveValue(false)) {
-		report(`JSDoc @${tagName} declaration set with "never" but return expression is present in function.`);
-		return;
-	}
-	if (!returnNever && (reportMissingReturnForUndefinedTypes || !utils.mayBeUndefinedTypeTag(tag)) && (tag.type === "" && !utils.hasValueOrExecutorHasNonEmptyResolveValue(exemptAsync) || tag.type !== "" && !utils.hasValueOrExecutorHasNonEmptyResolveValue(exemptAsync, true)) && Boolean(!exemptGenerators || !node || !("generator" in node) || !node.generator)) report(`JSDoc @${tagName} declaration present but return expression not available in function.`);
-}, { meta: {
-	docs: {
-		description: "Requires a return statement in function body if a `@returns` tag is specified in jsdoc comment.",
-		url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-check.md#repos-sticky-header"
-	},
-	schema: [{
-		additionalProperties: false,
-		properties: {
-			exemptAsync: {
-				default: true,
-				type: "boolean"
-			},
-			exemptGenerators: { type: "boolean" },
-			reportMissingReturnForUndefinedTypes: {
-				default: false,
-				type: "boolean"
-			}
-		},
-		type: "object"
-	}],
-	type: "suggestion"
-} });
-
-//#endregion
-export { requireReturnsCheck_default as default };
-//# sourceMappingURL=requireReturnsCheck.js.map

package/dist/rules/requireReturnsCheck.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireReturnsCheck.js","names":[],"sources":["../../src/rules/requireReturnsCheck.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {import('../iterateJsdoc.js').Settings} settings\n * @returns {boolean}\n */\nconst canSkip = (utils, settings) => {\n  const voidingTags = [\n    // An abstract function is by definition incomplete\n    // so it is perfectly fine if a return is documented but\n    // not present within the function.\n    // A subclass may inherit the doc and implement the\n    // missing return.\n    'abstract',\n    'virtual',\n\n    // A constructor function returns `this` by default, so may be `@returns`\n    //   tag indicating this but no explicit return\n    'class',\n    'constructor',\n    'interface',\n  ];\n\n  if (settings.mode === 'closure') {\n    // Structural Interface in GCC terms, equivalent to @interface tag as far as this rule is concerned\n    voidingTags.push('record');\n  }\n\n  return utils.hasATag(voidingTags) ||\n    utils.isConstructor() ||\n    utils.classHasTag('interface') ||\n    settings.mode === 'closure' && utils.classHasTag('record');\n};\n\n// eslint-disable-next-line complexity -- Temporary\nexport default iterateJsdoc(({\n  context,\n  node,\n  report,\n  settings,\n  utils,\n}) => {\n  const {\n    exemptAsync = true,\n    exemptGenerators = settings.mode === 'typescript',\n    reportMissingReturnForUndefinedTypes = false,\n  } = context.options[0] || {};\n\n  if (canSkip(utils, settings)) {\n    return;\n  }\n\n  if (exemptAsync && utils.isAsync()) {\n    return;\n  }\n\n  const tagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'returns',\n  }));\n  if (!tagName) {\n    return;\n  }\n\n  const tags = utils.getTags(tagName);\n\n  if (tags.length === 0) {\n    return;\n  }\n\n  if (tags.length > 1) {\n    report(`Found more than one @${tagName} declaration.`);\n\n    return;\n  }\n\n  const [\n    tag,\n  ] = tags;\n\n  const type = tag.type.trim();\n\n  // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#assertion-functions\n  if (/asserts\\s/v.test(type)) {\n    return;\n  }\n\n  const returnNever = type === 'never';\n\n  if (returnNever && utils.hasValueOrExecutorHasNonEmptyResolveValue(false)) {\n    report(`JSDoc @${tagName} declaration set with \"never\" but return expression is present in function.`);\n\n    return;\n  }\n\n  // In case a return value is declared in JSDoc, we also expect one in the code.\n  if (\n    !returnNever &&\n    (\n      reportMissingReturnForUndefinedTypes ||\n      !utils.mayBeUndefinedTypeTag(tag)\n    ) &&\n    (tag.type === '' && !utils.hasValueOrExecutorHasNonEmptyResolveValue(\n      exemptAsync,\n    ) ||\n    tag.type !== '' && !utils.hasValueOrExecutorHasNonEmptyResolveValue(\n      exemptAsync,\n      true,\n    )) &&\n    Boolean(\n      !exemptGenerators || !node ||\n      !('generator' in /** @type {import('../iterateJsdoc.js').Node} */ (node)) ||\n      !(/** @type {import('@typescript-eslint/types').TSESTree.FunctionDeclaration} */ (node)).generator,\n    )\n  ) {\n    report(`JSDoc @${tagName} declaration present but return expression not available in function.`);\n  }\n}, {\n  meta: {\n    docs: {\n      description: 'Requires a return statement in function body if a `@returns` tag is specified in jsdoc comment.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-check.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          exemptAsync: {\n            default: true,\n            type: 'boolean',\n          },\n          exemptGenerators: {\n            type: 'boolean',\n          },\n          reportMissingReturnForUndefinedTypes: {\n            default: false,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;AAOA,MAAM,UAAU,CAAC,OAAO,aAAa;CACnC,MAAM,cAAc;EAMlB;EACA;EAIA;EACA;EACA;CACD;AAED,KAAI,SAAS,SAAS,WAEpB,YAAY,KAAK,SAAS;AAG5B,QAAO,MAAM,QAAQ,YAAY,IAC/B,MAAM,eAAe,IACrB,MAAM,YAAY,YAAY,IAC9B,SAAS,SAAS,aAAa,MAAM,YAAY,SAAS;AAC7D;AAGD,kCAAe,aAAa,CAAC,EAC3B,SACA,MACA,QACA,UACA,OACD,KAAK;CACJ,MAAM,EACJ,cAAc,MACd,mBAAmB,SAAS,SAAS,cACrC,uCAAuC,OACxC,GAAG,QAAQ,QAAQ,MAAM,CAAE;AAE5B,KAAI,QAAQ,OAAO,SAAS,CAC1B;AAGF,KAAI,eAAe,MAAM,SAAS,CAChC;CAGF,MAAM,UAAiC,MAAM,oBAAoB,EAC/D,SAAS,UACV,EAAC;AACF,KAAI,CAAC,QACH;CAGF,MAAM,OAAO,MAAM,QAAQ,QAAQ;AAEnC,KAAI,KAAK,WAAW,EAClB;AAGF,KAAI,KAAK,SAAS,GAAG;EACnB,OAAO,CAAC,qBAAqB,EAAE,QAAQ,aAAa,CAAC,CAAC;AAEtD;CACD;CAED,MAAM,CACJ,IACD,GAAG;CAEJ,MAAM,OAAO,IAAI,KAAK,MAAM;AAG5B,KAAI,aAAa,KAAK,KAAK,CACzB;CAGF,MAAM,cAAc,SAAS;AAE7B,KAAI,eAAe,MAAM,0CAA0C,MAAM,EAAE;EACzE,OAAO,CAAC,OAAO,EAAE,QAAQ,2EAA2E,CAAC,CAAC;AAEtG;CACD;AAGD,KACE,CAAC,gBAEC,wCACA,CAAC,MAAM,sBAAsB,IAAI,MAElC,IAAI,SAAS,MAAM,CAAC,MAAM,0CACzB,YACD,IACD,IAAI,SAAS,MAAM,CAAC,MAAM,0CACxB,aACA,KACD,KACD,QACE,CAAC,oBAAoB,CAAC,QACtB,EAAE,eAAiE,SACnE,CAAkF,KAAO,UAC1F,EAED,OAAO,CAAC,OAAO,EAAE,QAAQ,qEAAqE,CAAC,CAAC;AAEnG,GAAE,EACD,MAAM;CACJ,MAAM;EACJ,aAAa;EACb,KAAK;CACN;CACD,QAAQ,CACN;EACE,sBAAsB;EACtB,YAAY;GACV,aAAa;IACX,SAAS;IACT,MAAM;GACP;GACD,kBAAkB,EAChB,MAAM,UACP;GACD,sCAAsC;IACpC,SAAS;IACT,MAAM;GACP;EACF;EACD,MAAM;CACP,CACF;CACD,MAAM;AACP,EACF,EAAC"}

package/dist/rules/requireReturnsDescription.js

@@ -1,43 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/requireReturnsDescription.js
-var requireReturnsDescription_default = iterateJsdoc(({ report, utils }) => {
-	utils.forEachPreferredTag("returns", (jsdocTag, targetTagName) => {
-		const type = jsdocTag.type && jsdocTag.type.trim();
-		if ([
-			"Promise<undefined>",
-			"Promise<void>",
-			"undefined",
-			"void"
-		].includes(type)) return;
-		if (!jsdocTag.description.trim()) report(`Missing JSDoc @${targetTagName} description.`, null, jsdocTag);
-	});
-}, {
-	contextDefaults: true,
-	meta: {
-		docs: {
-			description: "Requires that the `@returns` tag has a `description` value.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-description.md#repos-sticky-header"
-		},
-		schema: [{
-			additionalProperties: false,
-			properties: { contexts: {
-				items: { anyOf: [{ type: "string" }, {
-					additionalProperties: false,
-					properties: {
-						comment: { type: "string" },
-						context: { type: "string" }
-					},
-					type: "object"
-				}] },
-				type: "array"
-			} },
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { requireReturnsDescription_default as default };
-//# sourceMappingURL=requireReturnsDescription.js.map

package/dist/rules/requireReturnsDescription.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireReturnsDescription.js","names":[],"sources":["../../src/rules/requireReturnsDescription.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  report,\n  utils,\n}) => {\n  utils.forEachPreferredTag('returns', (jsdocTag, targetTagName) => {\n    const type = jsdocTag.type && jsdocTag.type.trim();\n\n    if ([\n      'Promise<undefined>', 'Promise<void>', 'undefined', 'void',\n    ].includes(type)) {\n      return;\n    }\n\n    if (!jsdocTag.description.trim()) {\n      report(`Missing JSDoc @${targetTagName} description.`, null, jsdocTag);\n    }\n  });\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that the `@returns` tag has a `description` value.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-description.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,wCAAe,aAAa,CAAC,EAC3B,QACA,OACD,KAAK;CACJ,MAAM,oBAAoB,WAAW,CAAC,UAAU,kBAAkB;EAChE,MAAM,OAAO,SAAS,QAAQ,SAAS,KAAK,MAAM;AAElD,MAAI;GACF;GAAsB;GAAiB;GAAa;EACrD,EAAC,SAAS,KAAK,CACd;AAGF,MAAI,CAAC,SAAS,YAAY,MAAM,EAC9B,OAAO,CAAC,eAAe,EAAE,cAAc,aAAa,CAAC,EAAE,MAAM,SAAS;CAEzE,EAAC;AACH,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,UAAU;IACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;KACE,sBAAsB;KACtB,YAAY;MACV,SAAS,EACP,MAAM,SACP;MACD,SAAS,EACP,MAAM,SACP;KACF;KACD,MAAM;IACP,CACF,EACF;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/requireReturnsType.js

@@ -1,36 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/requireReturnsType.js
-var requireReturnsType_default = iterateJsdoc(({ report, utils }) => {
-	utils.forEachPreferredTag("returns", (jsdocTag, targetTagName) => {
-		if (!jsdocTag.type) report(`Missing JSDoc @${targetTagName} type.`, null, jsdocTag);
-	});
-}, {
-	contextDefaults: true,
-	meta: {
-		docs: {
-			description: "Requires that `@returns` tag has `type` value.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-type.md#repos-sticky-header"
-		},
-		schema: [{
-			additionalProperties: false,
-			properties: { contexts: {
-				items: { anyOf: [{ type: "string" }, {
-					additionalProperties: false,
-					properties: {
-						comment: { type: "string" },
-						context: { type: "string" }
-					},
-					type: "object"
-				}] },
-				type: "array"
-			} },
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { requireReturnsType_default as default };
-//# sourceMappingURL=requireReturnsType.js.map

package/dist/rules/requireReturnsType.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireReturnsType.js","names":[],"sources":["../../src/rules/requireReturnsType.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  report,\n  utils,\n}) => {\n  utils.forEachPreferredTag('returns', (jsdocTag, targetTagName) => {\n    if (!jsdocTag.type) {\n      report(`Missing JSDoc @${targetTagName} type.`, null, jsdocTag);\n    }\n  });\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that `@returns` tag has `type` value.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-type.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,iCAAe,aAAa,CAAC,EAC3B,QACA,OACD,KAAK;CACJ,MAAM,oBAAoB,WAAW,CAAC,UAAU,kBAAkB;AAChE,MAAI,CAAC,SAAS,MACZ,OAAO,CAAC,eAAe,EAAE,cAAc,MAAM,CAAC,EAAE,MAAM,SAAS;CAElE,EAAC;AACH,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,UAAU;IACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;KACE,sBAAsB;KACtB,YAAY;MACV,SAAS,EACP,MAAM,SACP;MACD,SAAS,EACP,MAAM,SACP;KACF;KACD,MAAM;IACP,CACF,EACF;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/requireTemplate.js

@@ -1,122 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-import { parse, traverse, tryParse } from "@es-joy/jsdoccomment";
-
-//#region src/rules/requireTemplate.js
-var requireTemplate_default = iterateJsdoc(({ context, node, report, settings, utils }) => {
-	const { requireSeparateTemplates = false } = context.options[0] || {};
-	const { mode } = settings;
-	const usedNames = /* @__PURE__ */ new Set();
-	const templateTags = utils.getTags("template");
-	const templateNames = templateTags.flatMap((tag) => {
-		return utils.parseClosureTemplateTag(tag);
-	});
-	if (requireSeparateTemplates) for (const tag of templateTags) {
-		const { name } = tag;
-		const names = name.split(/,\s*/v);
-		if (names.length > 1) report(`Missing separate @template for ${names[1]}`, 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
-	*/
-	const checkTypeParams = (aliasDeclaration) => {
-		const { params } = aliasDeclaration.typeParameters ?? { params: [] };
-		for (const { name: { name } } of params) usedNames.add(name);
-		for (const usedName of usedNames) if (!templateNames.includes(usedName)) report(`Missing @template ${usedName}`);
-	};
-	const handleTypes = () => {
-		const nde = node;
-		if (!nde) return;
-		switch (nde.type) {
-			case "ClassDeclaration":
-			case "FunctionDeclaration":
-			case "TSInterfaceDeclaration":
-			case "TSTypeAliasDeclaration":
-				checkTypeParams(nde);
-				break;
-			case "ExportDefaultDeclaration":
-				switch (nde.declaration?.type) {
-					case "ClassDeclaration":
-					case "FunctionDeclaration":
-					case "TSInterfaceDeclaration":
-						checkTypeParams(nde.declaration);
-						break;
-				}
-				break;
-			case "ExportNamedDeclaration":
-				switch (nde.declaration?.type) {
-					case "ClassDeclaration":
-					case "FunctionDeclaration":
-					case "TSInterfaceDeclaration":
-					case "TSTypeAliasDeclaration":
-						checkTypeParams(nde.declaration);
-						break;
-				}
-				break;
-		}
-	};
-	const usedNameToTag = /* @__PURE__ */ new Map();
-	/**
-	* @param {import('comment-parser').Spec} potentialTag
-	*/
-	const checkForUsedTypes = (potentialTag) => {
-		let parsedType;
-		try {
-			parsedType = mode === "permissive" ? tryParse(potentialTag.type) : parse(potentialTag.type, mode);
-		} catch {
-			return;
-		}
-		traverse(parsedType, (nde) => {
-			const { type, value } = nde;
-			if (type === "JsdocTypeName" && /^[A-Z]$/v.test(value)) {
-				usedNames.add(value);
-				if (!usedNameToTag.has(value)) usedNameToTag.set(value, potentialTag);
-			}
-		});
-	};
-	/**
-	* @param {string[]} tagNames
-	*/
-	const checkTagsAndTemplates = (tagNames) => {
-		for (const tagName of tagNames) {
-			const preferredTagName = utils.getPreferredTagName({ tagName });
-			const matchingTags = utils.getTags(preferredTagName);
-			for (const matchingTag of matchingTags) checkForUsedTypes(matchingTag);
-		}
-		for (const usedName of usedNames) if (!templateNames.includes(usedName)) report(`Missing @template ${usedName}`, null, usedNameToTag.get(usedName));
-	};
-	const callbackTags = utils.getTags("callback");
-	const functionTags = utils.getTags("function");
-	if (callbackTags.length || functionTags.length) {
-		checkTagsAndTemplates(["param", "returns"]);
-		return;
-	}
-	const typedefTags = utils.getTags("typedef");
-	if (!typedefTags.length || typedefTags.length >= 2) {
-		handleTypes();
-		return;
-	}
-	const potentialTypedef = typedefTags[0];
-	checkForUsedTypes(potentialTypedef);
-	checkTagsAndTemplates(["property"]);
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Requires template tags for each generic type parameter",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-template.md#repos-sticky-header"
-		},
-		schema: [{
-			additionalProperties: false,
-			properties: { requireSeparateTemplates: { type: "boolean" } },
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { requireTemplate_default as default };
-//# sourceMappingURL=requireTemplate.js.map

package/dist/rules/requireTemplate.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireTemplate.js","names":["tryParseType","parseType"],"sources":["../../src/rules/requireTemplate.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  parse as parseType,\n  traverse,\n  tryParse as tryParseType,\n} from '@es-joy/jsdoccomment';\n\nexport default iterateJsdoc(({\n  context,\n  node,\n  report,\n  settings,\n  utils,\n}) => {\n  const {\n    requireSeparateTemplates = false,\n  } = context.options[0] || {};\n\n  const {\n    mode,\n  } = settings;\n\n  const usedNames = new Set();\n  const templateTags = utils.getTags('template');\n  const templateNames = templateTags.flatMap((tag) => {\n    return utils.parseClosureTemplateTag(tag);\n  });\n\n  if (requireSeparateTemplates) {\n    for (const tag of templateTags) {\n      const {\n        name,\n      } = tag;\n      const names = name.split(/,\\s*/v);\n      if (names.length > 1) {\n        report(`Missing separate @template for ${names[1]}`, null, tag);\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   */\n  const checkTypeParams = (aliasDeclaration) => {\n    const {\n      params,\n      /* c8 ignore next -- Guard */\n    } = aliasDeclaration.typeParameters ?? {\n      /* c8 ignore next -- Guard */\n      params: [],\n    };\n    for (const {\n      name: {\n        name,\n      },\n    } of params) {\n      usedNames.add(name);\n    }\n\n    for (const usedName of usedNames) {\n      if (!templateNames.includes(usedName)) {\n        report(`Missing @template ${usedName}`);\n      }\n    }\n  };\n\n  const handleTypes = () => {\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 'FunctionDeclaration':\n      case 'TSInterfaceDeclaration':\n      case 'TSTypeAliasDeclaration':\n        checkTypeParams(nde);\n        break;\n      case 'ExportDefaultDeclaration':\n        switch (nde.declaration?.type) {\n          case 'ClassDeclaration':\n          case 'FunctionDeclaration':\n          case 'TSInterfaceDeclaration':\n            checkTypeParams(nde.declaration);\n            break;\n        }\n\n        break;\n      case 'ExportNamedDeclaration':\n        switch (nde.declaration?.type) {\n          case 'ClassDeclaration':\n          case 'FunctionDeclaration':\n          case 'TSInterfaceDeclaration':\n          case 'TSTypeAliasDeclaration':\n            checkTypeParams(nde.declaration);\n            break;\n        }\n\n        break;\n    }\n  };\n\n  const usedNameToTag = new Map();\n\n  /**\n   * @param {import('comment-parser').Spec} potentialTag\n   */\n  const checkForUsedTypes = (potentialTag) => {\n    let parsedType;\n    try {\n      parsedType = mode === 'permissive' ?\n        tryParseType(/** @type {string} */ (potentialTag.type)) :\n        parseType(/** @type {string} */ (potentialTag.type), 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' && (/^[A-Z]$/v).test(value)) {\n        usedNames.add(value);\n        if (!usedNameToTag.has(value)) {\n          usedNameToTag.set(value, potentialTag);\n        }\n      }\n    });\n  };\n\n  /**\n   * @param {string[]} tagNames\n   */\n  const checkTagsAndTemplates = (tagNames) => {\n    for (const tagName of tagNames) {\n      const preferredTagName = /** @type {string} */ (utils.getPreferredTagName({\n        tagName,\n      }));\n      const matchingTags = utils.getTags(preferredTagName);\n      for (const matchingTag of matchingTags) {\n        checkForUsedTypes(matchingTag);\n      }\n    }\n\n    // Could check against whitelist/blacklist\n    for (const usedName of usedNames) {\n      if (!templateNames.includes(usedName)) {\n        report(`Missing @template ${usedName}`, null, usedNameToTag.get(usedName));\n      }\n    }\n  };\n\n  const callbackTags = utils.getTags('callback');\n  const functionTags = utils.getTags('function');\n  if (callbackTags.length || functionTags.length) {\n    checkTagsAndTemplates([\n      'param', 'returns',\n    ]);\n    return;\n  }\n\n  const typedefTags = utils.getTags('typedef');\n  if (!typedefTags.length || typedefTags.length >= 2) {\n    handleTypes();\n    return;\n  }\n\n  const potentialTypedef = typedefTags[0];\n  checkForUsedTypes(potentialTypedef);\n\n  checkTagsAndTemplates([\n    'property',\n  ]);\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Requires template tags for each generic type parameter',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-template.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          requireSeparateTemplates: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;AAOA,8BAAe,aAAa,CAAC,EAC3B,SACA,MACA,QACA,UACA,OACD,KAAK;CACJ,MAAM,EACJ,2BAA2B,OAC5B,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,MAAM,EACJ,MACD,GAAG;CAEJ,MAAM,4BAAY,IAAI;CACtB,MAAM,eAAe,MAAM,QAAQ,WAAW;CAC9C,MAAM,gBAAgB,aAAa,QAAQ,CAAC,QAAQ;AAClD,SAAO,MAAM,wBAAwB,IAAI;CAC1C,EAAC;AAEF,KAAI,yBACF,MAAK,MAAM,OAAO,cAAc;EAC9B,MAAM,EACJ,MACD,GAAG;EACJ,MAAM,QAAQ,KAAK,MAAM,QAAQ;AACjC,MAAI,MAAM,SAAS,GACjB,OAAO,CAAC,+BAA+B,EAAE,MAAM,IAAI,EAAE,MAAM,IAAI;CAElE;;;;;;;CASH,MAAM,kBAAkB,CAAC,qBAAqB;EAC5C,MAAM,EACJ,QAED,GAAG,iBAAiB,kBAAkB,EAErC,QAAQ,CAAE,EACX;AACD,OAAK,MAAM,EACT,MAAM,EACJ,MACD,EACF,IAAI,QACH,UAAU,IAAI,KAAK;AAGrB,OAAK,MAAM,YAAY,UACrB,KAAI,CAAC,cAAc,SAAS,SAAS,EACnC,OAAO,CAAC,kBAAkB,EAAE,UAAU,CAAC;CAG5C;CAED,MAAM,cAAc,MAAM;EACxB,MAAM,MACJ;AAEF,MAAI,CAAC,IACH;AAGF,UAAQ,IAAI,MAAZ;GACE,KAAK;GACL,KAAK;GACL,KAAK;GACL,KAAK;IACH,gBAAgB,IAAI;AACpB;GACF,KAAK;AACH,YAAQ,IAAI,aAAa,MAAzB;KACE,KAAK;KACL,KAAK;KACL,KAAK;MACH,gBAAgB,IAAI,YAAY;AAChC;IACH;AAED;GACF,KAAK;AACH,YAAQ,IAAI,aAAa,MAAzB;KACE,KAAK;KACL,KAAK;KACL,KAAK;KACL,KAAK;MACH,gBAAgB,IAAI,YAAY;AAChC;IACH;AAED;EACH;CACF;CAED,MAAM,gCAAgB,IAAI;;;;CAK1B,MAAM,oBAAoB,CAAC,iBAAiB;EAC1C,IAAI;AACJ,MAAI;GACF,aAAa,SAAS,eACpBA,SAAoC,aAAa,KAAM,GACvDC,MAAiC,aAAa,MAAO,KAAK;EAC7D,QAAO;AACN;EACD;EAED,SAAS,YAAY,CAAC,QAAQ;GAC5B,MAAM,EACJ,MACA,OACD,GAAgE;AACjE,OAAI,SAAS,mBAAoB,WAAY,KAAK,MAAM,EAAE;IACxD,UAAU,IAAI,MAAM;AACpB,QAAI,CAAC,cAAc,IAAI,MAAM,EAC3B,cAAc,IAAI,OAAO,aAAa;GAEzC;EACF,EAAC;CACH;;;;CAKD,MAAM,wBAAwB,CAAC,aAAa;AAC1C,OAAK,MAAM,WAAW,UAAU;GAC9B,MAAM,mBAA0C,MAAM,oBAAoB,EACxE,QACD,EAAC;GACF,MAAM,eAAe,MAAM,QAAQ,iBAAiB;AACpD,QAAK,MAAM,eAAe,cACxB,kBAAkB,YAAY;EAEjC;AAGD,OAAK,MAAM,YAAY,UACrB,KAAI,CAAC,cAAc,SAAS,SAAS,EACnC,OAAO,CAAC,kBAAkB,EAAE,UAAU,EAAE,MAAM,cAAc,IAAI,SAAS,CAAC;CAG/E;CAED,MAAM,eAAe,MAAM,QAAQ,WAAW;CAC9C,MAAM,eAAe,MAAM,QAAQ,WAAW;AAC9C,KAAI,aAAa,UAAU,aAAa,QAAQ;EAC9C,sBAAsB,CACpB,SAAS,SACV,EAAC;AACF;CACD;CAED,MAAM,cAAc,MAAM,QAAQ,UAAU;AAC5C,KAAI,CAAC,YAAY,UAAU,YAAY,UAAU,GAAG;EAClD,aAAa;AACb;CACD;CAED,MAAM,mBAAmB,YAAY;CACrC,kBAAkB,iBAAiB;CAEnC,sBAAsB,CACpB,UACD,EAAC;AACH,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,0BAA0B,EACxB,MAAM,UACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/requireThrows.js

@@ -1,67 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/requireThrows.js
-/**
-* We can skip checking for a throws value, in case the documentation is inherited
-* or the method is either a constructor or an abstract method.
-* @param {import('../iterateJsdoc.js').Utils} utils a reference to the utils which are used to probe if a tag is present or not.
-* @returns {boolean} true in case deep checking can be skipped; otherwise false.
-*/
-const canSkip = (utils) => {
-	return utils.hasATag([
-		"abstract",
-		"virtual",
-		"type"
-	]) || utils.avoidDocs();
-};
-var requireThrows_default = iterateJsdoc(({ report, utils }) => {
-	if (canSkip(utils)) return;
-	const tagName = utils.getPreferredTagName({ tagName: "throws" });
-	if (!tagName) return;
-	const tags = utils.getTags(tagName);
-	const iteratingFunction = utils.isIteratingFunction();
-	const [tag] = tags;
-	const missingThrowsTag = typeof tag === "undefined" || tag === null;
-	const shouldReport = () => {
-		if (!missingThrowsTag) {
-			if (tag.type.trim() === "never" && iteratingFunction && utils.hasThrowValue()) report(`JSDoc @${tagName} declaration set to "never" but throw value found.`);
-			return false;
-		}
-		return iteratingFunction && utils.hasThrowValue();
-	};
-	if (shouldReport()) report(`Missing JSDoc @${tagName} declaration.`);
-}, {
-	contextDefaults: true,
-	meta: {
-		docs: {
-			description: "Requires that throw statements are documented.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws.md#repos-sticky-header"
-		},
-		schema: [{
-			additionalProperties: false,
-			properties: {
-				contexts: {
-					items: { anyOf: [{ type: "string" }, {
-						additionalProperties: false,
-						properties: {
-							comment: { type: "string" },
-							context: { type: "string" }
-						},
-						type: "object"
-					}] },
-					type: "array"
-				},
-				exemptedBy: {
-					items: { type: "string" },
-					type: "array"
-				}
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { requireThrows_default as default };
-//# sourceMappingURL=requireThrows.js.map

package/dist/rules/requireThrows.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireThrows.js","names":[],"sources":["../../src/rules/requireThrows.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * We can skip checking for a throws value, in case the documentation is inherited\n * or the method is either a constructor or an abstract method.\n * @param {import('../iterateJsdoc.js').Utils} utils a reference to the utils which are used to probe if a tag is present or not.\n * @returns {boolean} true in case deep checking can be skipped; otherwise false.\n */\nconst canSkip = (utils) => {\n  return utils.hasATag([\n    // inheritdoc implies that all documentation is inherited\n    // see https://jsdoc.app/tags-inheritdoc.html\n    //\n    // Abstract methods are by definition incomplete,\n    // so it is not necessary to document that they throw an error.\n    'abstract',\n    'virtual',\n\n    // The designated type can itself document `@throws`\n    'type',\n  ]) ||\n    utils.avoidDocs();\n};\n\nexport default iterateJsdoc(({\n  report,\n  utils,\n}) => {\n  // A preflight check. We do not need to run a deep check for abstract\n  //  functions.\n  if (canSkip(utils)) {\n    return;\n  }\n\n  const tagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'throws',\n  }));\n  if (!tagName) {\n    return;\n  }\n\n  const tags = utils.getTags(tagName);\n  const iteratingFunction = utils.isIteratingFunction();\n\n  // In case the code returns something, we expect a return value in JSDoc.\n  const [\n    tag,\n  ] = tags;\n  const missingThrowsTag = typeof tag === 'undefined' || tag === null;\n\n  const shouldReport = () => {\n    if (!missingThrowsTag) {\n      if (tag.type.trim() === 'never' && iteratingFunction && utils.hasThrowValue()) {\n        report(`JSDoc @${tagName} declaration set to \"never\" but throw value found.`);\n      }\n\n      return false;\n    }\n\n    return iteratingFunction && utils.hasThrowValue();\n  };\n\n  if (shouldReport()) {\n    report(`Missing JSDoc @${tagName} declaration.`);\n  }\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that throw statements are documented.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;;AAQA,MAAM,UAAU,CAAC,UAAU;AACzB,QAAO,MAAM,QAAQ;EAMnB;EACA;EAGA;CACD,EAAC,IACA,MAAM,WAAW;AACpB;AAED,4BAAe,aAAa,CAAC,EAC3B,QACA,OACD,KAAK;AAGJ,KAAI,QAAQ,MAAM,CAChB;CAGF,MAAM,UAAiC,MAAM,oBAAoB,EAC/D,SAAS,SACV,EAAC;AACF,KAAI,CAAC,QACH;CAGF,MAAM,OAAO,MAAM,QAAQ,QAAQ;CACnC,MAAM,oBAAoB,MAAM,qBAAqB;CAGrD,MAAM,CACJ,IACD,GAAG;CACJ,MAAM,mBAAmB,OAAO,QAAQ,eAAe,QAAQ;CAE/D,MAAM,eAAe,MAAM;AACzB,MAAI,CAAC,kBAAkB;AACrB,OAAI,IAAI,KAAK,MAAM,KAAK,WAAW,qBAAqB,MAAM,eAAe,EAC3E,OAAO,CAAC,OAAO,EAAE,QAAQ,kDAAkD,CAAC,CAAC;AAG/E,UAAO;EACR;AAED,SAAO,qBAAqB,MAAM,eAAe;CAClD;AAED,KAAI,cAAc,EAChB,OAAO,CAAC,eAAe,EAAE,QAAQ,aAAa,CAAC,CAAC;AAEnD,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,UAAU;KACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;MACE,sBAAsB;MACtB,YAAY;OACV,SAAS,EACP,MAAM,SACP;OACD,SAAS,EACP,MAAM,SACP;MACF;MACD,MAAM;KACP,CACF,EACF;KACD,MAAM;IACP;IACD,YAAY;KACV,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}