eslint-plugin-jsdoc 52.0.4 → 53.0.0

package/dist/rules/requireTemplate.cjs

@@ -1,182 +1,123 @@
-"use strict";
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+const require_iterateJsdoc = require('../iterateJsdoc.cjs');
+const __es_joy_jsdoccomment = require_rolldown_runtime.__toESM(require("@es-joy/jsdoccomment"));
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-var _jsdoccomment = require("@es-joy/jsdoccomment");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  context,
-  node,
-  report,
-  settings,
-  utils
-}) => {
-  const {
-    requireSeparateTemplates = false
-  } = context.options[0] || {};
-  const {
-    mode
-  } = settings;
-  const usedNames = 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
-      /* c8 ignore next -- Guard */
-    } = aliasDeclaration.typeParameters ?? {
-      /* c8 ignore next -- Guard */
-      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 = /** @type {import('@typescript-eslint/types').TSESTree.Node} */
-    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 = new Map();
-
-  /**
-   * @param {import('comment-parser').Spec} potentialTag
-   */
-  const checkForUsedTypes = potentialTag => {
-    let parsedType;
-    try {
-      parsedType = mode === 'permissive' ? (0, _jsdoccomment.tryParse)(/** @type {string} */potentialTag.type) : (0, _jsdoccomment.parse)(/** @type {string} */potentialTag.type, mode);
-    } catch {
-      return;
-    }
-    (0, _jsdoccomment.traverse)(parsedType, nde => {
-      const {
-        type,
-        value
-      } = /** @type {import('jsdoc-type-pratt-parser').NameResult} */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 = /** @type {string} */utils.getPreferredTagName({
-        tagName
-      });
-      const matchingTags = utils.getTags(preferredTagName);
-      for (const matchingTag of matchingTags) {
-        checkForUsedTypes(matchingTag);
-      }
-    }
-
-    // Could check against whitelist/blacklist
-    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']);
+//#region src/rules/requireTemplate.js
+var requireTemplate_default = require_iterateJsdoc.default(({ 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" ? (0, __es_joy_jsdoccomment.tryParse)(potentialTag.type) : (0, __es_joy_jsdoccomment.parse)(potentialTag.type, mode);
+		} catch {
+			return;
+		}
+		(0, __es_joy_jsdoccomment.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'
-  }
+	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"
+	}
 });
-module.exports = exports.default;
+
+//#endregion
+exports.default = requireTemplate_default;
 //# sourceMappingURL=requireTemplate.cjs.map

package/dist/rules/requireTemplate.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"requireTemplate.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","_jsdoccomment","e","__esModule","default","_default","exports","iterateJsdoc","context","node","report","settings","utils","requireSeparateTemplates","options","mode","usedNames","Set","templateTags","getTags","templateNames","flatMap","tag","parseClosureTemplateTag","name","names","split","length","checkTypeParams","aliasDeclaration","params","typeParameters","add","usedName","includes","handleTypes","nde","type","declaration","usedNameToTag","Map","checkForUsedTypes","potentialTag","parsedType","tryParseType","parseType","traverse","value","test","has","set","checkTagsAndTemplates","tagNames","tagName","preferredTagName","getPreferredTagName","matchingTags","matchingTag","get","callbackTags","functionTags","typedefTags","potentialTypedef","iterateAllJsdocs","meta","docs","description","url","schema","additionalProperties","properties","module"],"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":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAI8B,SAAAD,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAF,OAAA,GAEf,IAAAG,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,IAAI;EACJC,MAAM;EACNC,QAAQ;EACRC;AACF,CAAC,KAAK;EACJ,MAAM;IACJC,wBAAwB,GAAG;EAC7B,CAAC,GAAGL,OAAO,CAACM,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,MAAM;IACJC;EACF,CAAC,GAAGJ,QAAQ;EAEZ,MAAMK,SAAS,GAAG,IAAIC,GAAG,CAAC,CAAC;EAC3B,MAAMC,YAAY,GAAGN,KAAK,CAACO,OAAO,CAAC,UAAU,CAAC;EAC9C,MAAMC,aAAa,GAAGF,YAAY,CAACG,OAAO,CAAEC,GAAG,IAAK;IAClD,OAAOV,KAAK,CAACW,uBAAuB,CAACD,GAAG,CAAC;EAC3C,CAAC,CAAC;EAEF,IAAIT,wBAAwB,EAAE;IAC5B,KAAK,MAAMS,GAAG,IAAIJ,YAAY,EAAE;MAC9B,MAAM;QACJM;MACF,CAAC,GAAGF,GAAG;MACP,MAAMG,KAAK,GAAGD,IAAI,CAACE,KAAK,CAAC,OAAO,CAAC;MACjC,IAAID,KAAK,CAACE,MAAM,GAAG,CAAC,EAAE;QACpBjB,MAAM,CAAC,kCAAkCe,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,EAAEH,GAAG,CAAC;MACjE;IACF;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACE,MAAMM,eAAe,GAAIC,gBAAgB,IAAK;IAC5C,MAAM;MACJC;MACA;IACF,CAAC,GAAGD,gBAAgB,CAACE,cAAc,IAAI;MACrC;MACAD,MAAM,EAAE;IACV,CAAC;IACD,KAAK,MAAM;MACTN,IAAI,EAAE;QACJA;MACF;IACF,CAAC,IAAIM,MAAM,EAAE;MACXd,SAAS,CAACgB,GAAG,CAACR,IAAI,CAAC;IACrB;IAEA,KAAK,MAAMS,QAAQ,IAAIjB,SAAS,EAAE;MAChC,IAAI,CAACI,aAAa,CAACc,QAAQ,CAACD,QAAQ,CAAC,EAAE;QACrCvB,MAAM,CAAC,qBAAqBuB,QAAQ,EAAE,CAAC;MACzC;IACF;EACF,CAAC;EAED,MAAME,WAAW,GAAGA,CAAA,KAAM;IACxB,MAAMC,GAAG,GAAG;IACV3B,IACD;IACD,IAAI,CAAC2B,GAAG,EAAE;MACR;IACF;IAEA,QAAQA,GAAG,CAACC,IAAI;MACd,KAAK,kBAAkB;MACvB,KAAK,qBAAqB;MAC1B,KAAK,wBAAwB;MAC7B,KAAK,wBAAwB;QAC3BT,eAAe,CAACQ,GAAG,CAAC;QACpB;MACF,KAAK,0BAA0B;QAC7B,QAAQA,GAAG,CAACE,WAAW,EAAED,IAAI;UAC3B,KAAK,kBAAkB;UACvB,KAAK,qBAAqB;UAC1B,KAAK,wBAAwB;YAC3BT,eAAe,CAACQ,GAAG,CAACE,WAAW,CAAC;YAChC;QACJ;QAEA;MACF,KAAK,wBAAwB;QAC3B,QAAQF,GAAG,CAACE,WAAW,EAAED,IAAI;UAC3B,KAAK,kBAAkB;UACvB,KAAK,qBAAqB;UAC1B,KAAK,wBAAwB;UAC7B,KAAK,wBAAwB;YAC3BT,eAAe,CAACQ,GAAG,CAACE,WAAW,CAAC;YAChC;QACJ;QAEA;IACJ;EACF,CAAC;EAED,MAAMC,aAAa,GAAG,IAAIC,GAAG,CAAC,CAAC;;EAE/B;AACF;AACA;EACE,MAAMC,iBAAiB,GAAIC,YAAY,IAAK;IAC1C,IAAIC,UAAU;IACd,IAAI;MACFA,UAAU,GAAG5B,IAAI,KAAK,YAAY,GAChC,IAAA6B,sBAAY,EAAC,qBAAuBF,YAAY,CAACL,IAAK,CAAC,GACvD,IAAAQ,mBAAS,EAAC,qBAAuBH,YAAY,CAACL,IAAI,EAAGtB,IAAI,CAAC;IAC9D,CAAC,CAAC,MAAM;MACN;IACF;IAEA,IAAA+B,sBAAQ,EAACH,UAAU,EAAGP,GAAG,IAAK;MAC5B,MAAM;QACJC,IAAI;QACJU;MACF,CAAC,GAAG,2DAA6DX,GAAI;MACrE,IAAIC,IAAI,KAAK,eAAe,IAAK,UAAU,CAAEW,IAAI,CAACD,KAAK,CAAC,EAAE;QACxD/B,SAAS,CAACgB,GAAG,CAACe,KAAK,CAAC;QACpB,IAAI,CAACR,aAAa,CAACU,GAAG,CAACF,KAAK,CAAC,EAAE;UAC7BR,aAAa,CAACW,GAAG,CAACH,KAAK,EAAEL,YAAY,CAAC;QACxC;MACF;IACF,CAAC,CAAC;EACJ,CAAC;;EAED;AACF;AACA;EACE,MAAMS,qBAAqB,GAAIC,QAAQ,IAAK;IAC1C,KAAK,MAAMC,OAAO,IAAID,QAAQ,EAAE;MAC9B,MAAME,gBAAgB,GAAG,qBAAuB1C,KAAK,CAAC2C,mBAAmB,CAAC;QACxEF;MACF,CAAC,CAAE;MACH,MAAMG,YAAY,GAAG5C,KAAK,CAACO,OAAO,CAACmC,gBAAgB,CAAC;MACpD,KAAK,MAAMG,WAAW,IAAID,YAAY,EAAE;QACtCf,iBAAiB,CAACgB,WAAW,CAAC;MAChC;IACF;;IAEA;IACA,KAAK,MAAMxB,QAAQ,IAAIjB,SAAS,EAAE;MAChC,IAAI,CAACI,aAAa,CAACc,QAAQ,CAACD,QAAQ,CAAC,EAAE;QACrCvB,MAAM,CAAC,qBAAqBuB,QAAQ,EAAE,EAAE,IAAI,EAAEM,aAAa,CAACmB,GAAG,CAACzB,QAAQ,CAAC,CAAC;MAC5E;IACF;EACF,CAAC;EAED,MAAM0B,YAAY,GAAG/C,KAAK,CAACO,OAAO,CAAC,UAAU,CAAC;EAC9C,MAAMyC,YAAY,GAAGhD,KAAK,CAACO,OAAO,CAAC,UAAU,CAAC;EAC9C,IAAIwC,YAAY,CAAChC,MAAM,IAAIiC,YAAY,CAACjC,MAAM,EAAE;IAC9CwB,qBAAqB,CAAC,CACpB,OAAO,EAAE,SAAS,CACnB,CAAC;IACF;EACF;EAEA,MAAMU,WAAW,GAAGjD,KAAK,CAACO,OAAO,CAAC,SAAS,CAAC;EAC5C,IAAI,CAAC0C,WAAW,CAAClC,MAAM,IAAIkC,WAAW,CAAClC,MAAM,IAAI,CAAC,EAAE;IAClDQ,WAAW,CAAC,CAAC;IACb;EACF;EAEA,MAAM2B,gBAAgB,GAAGD,WAAW,CAAC,CAAC,CAAC;EACvCpB,iBAAiB,CAACqB,gBAAgB,CAAC;EAEnCX,qBAAqB,CAAC,CACpB,UAAU,CACX,CAAC;AACJ,CAAC,EAAE;EACDY,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,wDAAwD;MACrEC,GAAG,EAAE;IACP,CAAC;IACDC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVzD,wBAAwB,EAAE;UACxBwB,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAkC,MAAA,CAAAjE,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}
+{"version":3,"file":"requireTemplate.cjs","names":["iterateJsdoc"],"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,8BAAeA,6BAAa,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,mDACgB,aAAa,KAAM,oCACtB,aAAa,MAAO,KAAK;EAC7D,QAAO;AACN;EACD;sCAEQ,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/requireTemplate.js

@@ -0,0 +1,122 @@
+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

@@ -0,0 +1 @@
+{"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.cjs

@@ -1,101 +1,67 @@
-"use strict";
+const require_iterateJsdoc = require('../iterateJsdoc.cjs');
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+//#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([
-  // inheritdoc implies that all documentation is inherited
-  // see https://jsdoc.app/tags-inheritdoc.html
-  //
-  // Abstract methods are by definition incomplete,
-  // so it is not necessary to document that they throw an error.
-  'abstract', 'virtual',
-  // The designated type can itself document `@throws`
-  'type']) || utils.avoidDocs();
+* 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 _default = exports.default = (0, _iterateJsdoc.default)(({
-  report,
-  utils
-}) => {
-  // A preflight check. We do not need to run a deep check for abstract
-  //  functions.
-  if (canSkip(utils)) {
-    return;
-  }
-  const tagName = /** @type {string} */utils.getPreferredTagName({
-    tagName: 'throws'
-  });
-  if (!tagName) {
-    return;
-  }
-  const tags = utils.getTags(tagName);
-  const iteratingFunction = utils.isIteratingFunction();
-
-  // In case the code returns something, we expect a return value in JSDoc.
-  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.`);
-  }
+var requireThrows_default = require_iterateJsdoc.default(({ 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'
-  }
+	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"
+	}
 });
-module.exports = exports.default;
+
+//#endregion
+exports.default = requireThrows_default;
 //# sourceMappingURL=requireThrows.cjs.map