eslint-plugin-jsdoc 52.0.4 → 53.0.0

package/dist/rules/requireYieldsCheck.cjs

@@ -1,161 +1,105 @@
-"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/requireYieldsCheck.js
 /**
- * @param {import('../iterateJsdoc.js').Utils} utils
- * @param {import('../iterateJsdoc.js').Settings} settings
- * @returns {boolean}
- */
+* @param {import('../iterateJsdoc.js').Utils} utils
+* @param {import('../iterateJsdoc.js').Settings} settings
+* @returns {boolean}
+*/
 const canSkip = (utils, settings) => {
-  const voidingTags = [
-  // An abstract function is by definition incomplete
-  // so it is perfectly fine if a yield is documented but
-  // not present within the function.
-  // A subclass may inherit the doc and implement the
-  // missing yield.
-  'abstract', 'virtual',
-  // Constructor functions do not have a yield value
-  //  so we can bail here, too.
-  'class', 'constructor',
-  // This seems to imply a class as well
-  'interface'];
-  if (settings.mode === 'closure') {
-    // Structural Interface in GCC terms, equivalent to @interface tag as far as this rule is concerned
-    voidingTags.push('record');
-  }
-  return utils.hasATag(voidingTags) || utils.isConstructor() || utils.classHasTag('interface') || settings.mode === 'closure' && utils.classHasTag('record');
+	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");
 };
-
 /**
- * @param {import('../iterateJsdoc.js').Utils} utils
- * @param {import('../iterateJsdoc.js').Report} report
- * @param {string} tagName
- * @returns {[]|[preferredTagName: string, tag: import('comment-parser').Spec]}
- */
+* @param {import('../iterateJsdoc.js').Utils} utils
+* @param {import('../iterateJsdoc.js').Report} report
+* @param {string} tagName
+* @returns {[]|[preferredTagName: string, tag: import('comment-parser').Spec]}
+*/
 const checkTagName = (utils, report, tagName) => {
-  const preferredTagName = /** @type {string} */utils.getPreferredTagName({
-    tagName
-  });
-  if (!preferredTagName) {
-    return [];
-  }
-  const tags = utils.getTags(preferredTagName);
-  if (tags.length === 0) {
-    return [];
-  }
-  if (tags.length > 1) {
-    report(`Found more than one @${preferredTagName} declaration.`);
-    return [];
-  }
-  return [preferredTagName, tags[0]];
+	const preferredTagName = utils.getPreferredTagName({ tagName });
+	if (!preferredTagName) return [];
+	const tags = utils.getTags(preferredTagName);
+	if (tags.length === 0) return [];
+	if (tags.length > 1) {
+		report(`Found more than one @${preferredTagName} declaration.`);
+		return [];
+	}
+	return [preferredTagName, tags[0]];
 };
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  context,
-  report,
-  settings,
-  utils
-}) => {
-  if (canSkip(utils, settings)) {
-    return;
-  }
-  const {
-    checkGeneratorsOnly = false,
-    next = false
-  } = context.options[0] || {};
-  const [preferredYieldTagName, yieldTag] = checkTagName(utils, report, 'yields');
-  if (preferredYieldTagName) {
-    const shouldReportYields = () => {
-      if (/** @type {import('comment-parser').Spec} */yieldTag.type.trim() === 'never') {
-        if (utils.hasYieldValue()) {
-          report(`JSDoc @${preferredYieldTagName} declaration set with "never" but yield expression is present in function.`);
-        }
-        return false;
-      }
-      if (checkGeneratorsOnly && !utils.isGenerator()) {
-        return true;
-      }
-      return !utils.mayBeUndefinedTypeTag(/** @type {import('comment-parser').Spec} */
-      yieldTag) && !utils.hasYieldValue();
-    };
+var requireYieldsCheck_default = require_iterateJsdoc.default(({ context, report, settings, utils }) => {
+	if (canSkip(utils, settings)) return;
+	const { checkGeneratorsOnly = false, next = false } = context.options[0] || {};
+	const [preferredYieldTagName, yieldTag] = checkTagName(utils, report, "yields");
+	if (preferredYieldTagName) {
+		const shouldReportYields = () => {
+			if (yieldTag.type.trim() === "never") {
+				if (utils.hasYieldValue()) report(`JSDoc @${preferredYieldTagName} declaration set with "never" but yield expression is present in function.`);
+				return false;
+			}
+			if (checkGeneratorsOnly && !utils.isGenerator()) return true;
+			return !utils.mayBeUndefinedTypeTag(yieldTag) && !utils.hasYieldValue();
+		};
+		if (shouldReportYields()) report(`JSDoc @${preferredYieldTagName} declaration present but yield expression not available in function.`);
+	}
+	if (next) {
+		const [preferredNextTagName, nextTag] = checkTagName(utils, report, "next");
+		if (preferredNextTagName) {
+			const shouldReportNext = () => {
+				if (nextTag.type.trim() === "never") {
+					if (utils.hasYieldReturnValue()) report(`JSDoc @${preferredNextTagName} declaration set with "never" but yield expression with return value is present in function.`);
+					return false;
+				}
+				if (checkGeneratorsOnly && !utils.isGenerator()) return true;
+				return !utils.mayBeUndefinedTypeTag(nextTag) && !utils.hasYieldReturnValue();
+			};
+			if (shouldReportNext()) report(`JSDoc @${preferredNextTagName} declaration present but yield expression with return value not available in function.`);
+		}
+	}
+}, { meta: {
+	docs: {
+		description: "Requires a yield statement in function body if a `@yields` tag is specified in jsdoc comment.",
+		url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-check.md#repos-sticky-header"
+	},
+	schema: [{
+		additionalProperties: false,
+		properties: {
+			checkGeneratorsOnly: {
+				default: false,
+				type: "boolean"
+			},
+			contexts: {
+				items: { anyOf: [{ type: "string" }, {
+					additionalProperties: false,
+					properties: {
+						comment: { type: "string" },
+						context: { type: "string" }
+					},
+					type: "object"
+				}] },
+				type: "array"
+			},
+			exemptedBy: {
+				items: { type: "string" },
+				type: "array"
+			},
+			next: {
+				default: false,
+				type: "boolean"
+			}
+		},
+		type: "object"
+	}],
+	type: "suggestion"
+} });
 
-    // In case a yield value is declared in JSDoc, we also expect one in the code.
-    if (shouldReportYields()) {
-      report(`JSDoc @${preferredYieldTagName} declaration present but yield expression not available in function.`);
-    }
-  }
-  if (next) {
-    const [preferredNextTagName, nextTag] = checkTagName(utils, report, 'next');
-    if (preferredNextTagName) {
-      const shouldReportNext = () => {
-        if (/** @type {import('comment-parser').Spec} */nextTag.type.trim() === 'never') {
-          if (utils.hasYieldReturnValue()) {
-            report(`JSDoc @${preferredNextTagName} declaration set with "never" but yield expression with return value is present in function.`);
-          }
-          return false;
-        }
-        if (checkGeneratorsOnly && !utils.isGenerator()) {
-          return true;
-        }
-        return !utils.mayBeUndefinedTypeTag(/** @type {import('comment-parser').Spec} */
-        nextTag) && !utils.hasYieldReturnValue();
-      };
-      if (shouldReportNext()) {
-        report(`JSDoc @${preferredNextTagName} declaration present but yield expression with return value not available in function.`);
-      }
-    }
-  }
-}, {
-  meta: {
-    docs: {
-      description: 'Requires a yield statement in function body if a `@yields` tag is specified in jsdoc comment.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-check.md#repos-sticky-header'
-    },
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        checkGeneratorsOnly: {
-          default: false,
-          type: 'boolean'
-        },
-        contexts: {
-          items: {
-            anyOf: [{
-              type: 'string'
-            }, {
-              additionalProperties: false,
-              properties: {
-                comment: {
-                  type: 'string'
-                },
-                context: {
-                  type: 'string'
-                }
-              },
-              type: 'object'
-            }]
-          },
-          type: 'array'
-        },
-        exemptedBy: {
-          items: {
-            type: 'string'
-          },
-          type: 'array'
-        },
-        next: {
-          default: false,
-          type: 'boolean'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'suggestion'
-  }
-});
-module.exports = exports.default;
+//#endregion
+exports.default = requireYieldsCheck_default;
 //# sourceMappingURL=requireYieldsCheck.cjs.map

package/dist/rules/requireYieldsCheck.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"requireYieldsCheck.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","canSkip","utils","settings","voidingTags","mode","push","hasATag","isConstructor","classHasTag","checkTagName","report","tagName","preferredTagName","getPreferredTagName","tags","getTags","length","_default","exports","iterateJsdoc","context","checkGeneratorsOnly","next","options","preferredYieldTagName","yieldTag","shouldReportYields","type","trim","hasYieldValue","isGenerator","mayBeUndefinedTypeTag","preferredNextTagName","nextTag","shouldReportNext","hasYieldReturnValue","meta","docs","description","url","schema","additionalProperties","properties","contexts","items","anyOf","comment","exemptedBy","module"],"sources":["../../src/rules/requireYieldsCheck.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 yield is documented but\n    // not present within the function.\n    // A subclass may inherit the doc and implement the\n    // missing yield.\n    'abstract',\n    'virtual',\n\n    // Constructor functions do not have a yield value\n    //  so we can bail here, too.\n    'class',\n    'constructor',\n\n    // This seems to imply a class as well\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/**\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {import('../iterateJsdoc.js').Report} report\n * @param {string} tagName\n * @returns {[]|[preferredTagName: string, tag: import('comment-parser').Spec]}\n */\nconst checkTagName = (utils, report, tagName) => {\n  const preferredTagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName,\n  }));\n  if (!preferredTagName) {\n    return [];\n  }\n\n  const tags = utils.getTags(preferredTagName);\n\n  if (tags.length === 0) {\n    return [];\n  }\n\n  if (tags.length > 1) {\n    report(`Found more than one @${preferredTagName} declaration.`);\n\n    return [];\n  }\n\n  return [\n    preferredTagName, tags[0],\n  ];\n};\n\nexport default iterateJsdoc(({\n  context,\n  report,\n  settings,\n  utils,\n}) => {\n  if (canSkip(utils, settings)) {\n    return;\n  }\n\n  const {\n    checkGeneratorsOnly = false,\n    next = false,\n  } = context.options[0] || {};\n\n  const [\n    preferredYieldTagName,\n    yieldTag,\n  ] = checkTagName(\n    utils, report, 'yields',\n  );\n  if (preferredYieldTagName) {\n    const shouldReportYields = () => {\n      if (\n        /** @type {import('comment-parser').Spec} */ (\n          yieldTag\n        ).type.trim() === 'never'\n      ) {\n        if (utils.hasYieldValue()) {\n          report(`JSDoc @${preferredYieldTagName} declaration set with \"never\" but yield expression is present in function.`);\n        }\n\n        return false;\n      }\n\n      if (checkGeneratorsOnly && !utils.isGenerator()) {\n        return true;\n      }\n\n      return !utils.mayBeUndefinedTypeTag(\n        /** @type {import('comment-parser').Spec} */\n        (yieldTag),\n      ) && !utils.hasYieldValue();\n    };\n\n    // In case a yield value is declared in JSDoc, we also expect one in the code.\n    if (shouldReportYields()) {\n      report(`JSDoc @${preferredYieldTagName} declaration present but yield expression not available in function.`);\n    }\n  }\n\n  if (next) {\n    const [\n      preferredNextTagName,\n      nextTag,\n    ] = checkTagName(\n      utils, report, 'next',\n    );\n    if (preferredNextTagName) {\n      const shouldReportNext = () => {\n        if (\n          /** @type {import('comment-parser').Spec} */ (\n            nextTag\n          ).type.trim() === 'never'\n        ) {\n          if (utils.hasYieldReturnValue()) {\n            report(`JSDoc @${preferredNextTagName} declaration set with \"never\" but yield expression with return value is present in function.`);\n          }\n\n          return false;\n        }\n\n        if (checkGeneratorsOnly && !utils.isGenerator()) {\n          return true;\n        }\n\n        return !utils.mayBeUndefinedTypeTag(\n          /** @type {import('comment-parser').Spec} */\n          (nextTag),\n        ) && !utils.hasYieldReturnValue();\n      };\n\n      if (shouldReportNext()) {\n        report(`JSDoc @${preferredNextTagName} declaration present but yield expression with return value not available in function.`);\n      }\n    }\n  }\n}, {\n  meta: {\n    docs: {\n      description: 'Requires a yield statement in function body if a `@yields` tag is specified in jsdoc comment.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-check.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          checkGeneratorsOnly: {\n            default: false,\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                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          next: {\n            default: false,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE9C;AACA;AACA;AACA;AACA;AACA,MAAMG,OAAO,GAAGA,CAACC,KAAK,EAAEC,QAAQ,KAAK;EACnC,MAAMC,WAAW,GAAG;EAClB;EACA;EACA;EACA;EACA;EACA,UAAU,EACV,SAAS;EAET;EACA;EACA,OAAO,EACP,aAAa;EAEb;EACA,WAAW,CACZ;EAED,IAAID,QAAQ,CAACE,IAAI,KAAK,SAAS,EAAE;IAC/B;IACAD,WAAW,CAACE,IAAI,CAAC,QAAQ,CAAC;EAC5B;EAEA,OAAOJ,KAAK,CAACK,OAAO,CAACH,WAAW,CAAC,IAC/BF,KAAK,CAACM,aAAa,CAAC,CAAC,IACrBN,KAAK,CAACO,WAAW,CAAC,WAAW,CAAC,IAC9BN,QAAQ,CAACE,IAAI,KAAK,SAAS,IAAIH,KAAK,CAACO,WAAW,CAAC,QAAQ,CAAC;AAC9D,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,YAAY,GAAGA,CAACR,KAAK,EAAES,MAAM,EAAEC,OAAO,KAAK;EAC/C,MAAMC,gBAAgB,GAAG,qBAAuBX,KAAK,CAACY,mBAAmB,CAAC;IACxEF;EACF,CAAC,CAAE;EACH,IAAI,CAACC,gBAAgB,EAAE;IACrB,OAAO,EAAE;EACX;EAEA,MAAME,IAAI,GAAGb,KAAK,CAACc,OAAO,CAACH,gBAAgB,CAAC;EAE5C,IAAIE,IAAI,CAACE,MAAM,KAAK,CAAC,EAAE;IACrB,OAAO,EAAE;EACX;EAEA,IAAIF,IAAI,CAACE,MAAM,GAAG,CAAC,EAAE;IACnBN,MAAM,CAAC,wBAAwBE,gBAAgB,eAAe,CAAC;IAE/D,OAAO,EAAE;EACX;EAEA,OAAO,CACLA,gBAAgB,EAAEE,IAAI,CAAC,CAAC,CAAC,CAC1B;AACH,CAAC;AAAC,IAAAG,QAAA,GAAAC,OAAA,CAAAnB,OAAA,GAEa,IAAAoB,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPV,MAAM;EACNR,QAAQ;EACRD;AACF,CAAC,KAAK;EACJ,IAAID,OAAO,CAACC,KAAK,EAAEC,QAAQ,CAAC,EAAE;IAC5B;EACF;EAEA,MAAM;IACJmB,mBAAmB,GAAG,KAAK;IAC3BC,IAAI,GAAG;EACT,CAAC,GAAGF,OAAO,CAACG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,MAAM,CACJC,qBAAqB,EACrBC,QAAQ,CACT,GAAGhB,YAAY,CACdR,KAAK,EAAES,MAAM,EAAE,QACjB,CAAC;EACD,IAAIc,qBAAqB,EAAE;IACzB,MAAME,kBAAkB,GAAGA,CAAA,KAAM;MAC/B,IACE,4CACED,QAAQ,CACRE,IAAI,CAACC,IAAI,CAAC,CAAC,KAAK,OAAO,EACzB;QACA,IAAI3B,KAAK,CAAC4B,aAAa,CAAC,CAAC,EAAE;UACzBnB,MAAM,CAAC,UAAUc,qBAAqB,4EAA4E,CAAC;QACrH;QAEA,OAAO,KAAK;MACd;MAEA,IAAIH,mBAAmB,IAAI,CAACpB,KAAK,CAAC6B,WAAW,CAAC,CAAC,EAAE;QAC/C,OAAO,IAAI;MACb;MAEA,OAAO,CAAC7B,KAAK,CAAC8B,qBAAqB,CACjC;MACCN,QACH,CAAC,IAAI,CAACxB,KAAK,CAAC4B,aAAa,CAAC,CAAC;IAC7B,CAAC;;IAED;IACA,IAAIH,kBAAkB,CAAC,CAAC,EAAE;MACxBhB,MAAM,CAAC,UAAUc,qBAAqB,sEAAsE,CAAC;IAC/G;EACF;EAEA,IAAIF,IAAI,EAAE;IACR,MAAM,CACJU,oBAAoB,EACpBC,OAAO,CACR,GAAGxB,YAAY,CACdR,KAAK,EAAES,MAAM,EAAE,MACjB,CAAC;IACD,IAAIsB,oBAAoB,EAAE;MACxB,MAAME,gBAAgB,GAAGA,CAAA,KAAM;QAC7B,IACE,4CACED,OAAO,CACPN,IAAI,CAACC,IAAI,CAAC,CAAC,KAAK,OAAO,EACzB;UACA,IAAI3B,KAAK,CAACkC,mBAAmB,CAAC,CAAC,EAAE;YAC/BzB,MAAM,CAAC,UAAUsB,oBAAoB,8FAA8F,CAAC;UACtI;UAEA,OAAO,KAAK;QACd;QAEA,IAAIX,mBAAmB,IAAI,CAACpB,KAAK,CAAC6B,WAAW,CAAC,CAAC,EAAE;UAC/C,OAAO,IAAI;QACb;QAEA,OAAO,CAAC7B,KAAK,CAAC8B,qBAAqB,CACjC;QACCE,OACH,CAAC,IAAI,CAAChC,KAAK,CAACkC,mBAAmB,CAAC,CAAC;MACnC,CAAC;MAED,IAAID,gBAAgB,CAAC,CAAC,EAAE;QACtBxB,MAAM,CAAC,UAAUsB,oBAAoB,wFAAwF,CAAC;MAChI;IACF;EACF;AACF,CAAC,EAAE;EACDI,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,+FAA+F;MAC5GC,GAAG,EAAE;IACP,CAAC;IACDC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVrB,mBAAmB,EAAE;UACnBtB,OAAO,EAAE,KAAK;UACd4B,IAAI,EAAE;QACR,CAAC;QACDgB,QAAQ,EAAE;UACRC,KAAK,EAAE;YACLC,KAAK,EAAE,CACL;cACElB,IAAI,EAAE;YACR,CAAC,EACD;cACEc,oBAAoB,EAAE,KAAK;cAC3BC,UAAU,EAAE;gBACVI,OAAO,EAAE;kBACPnB,IAAI,EAAE;gBACR,CAAC;gBACDP,OAAO,EAAE;kBACPO,IAAI,EAAE;gBACR;cACF,CAAC;cACDA,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACDoB,UAAU,EAAE;UACVH,KAAK,EAAE;YACLjB,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACDL,IAAI,EAAE;UACJvB,OAAO,EAAE,KAAK;UACd4B,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAqB,MAAA,CAAA9B,OAAA,GAAAA,OAAA,CAAAnB,OAAA","ignoreList":[]}
+{"version":3,"file":"requireYieldsCheck.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/requireYieldsCheck.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 yield is documented but\n    // not present within the function.\n    // A subclass may inherit the doc and implement the\n    // missing yield.\n    'abstract',\n    'virtual',\n\n    // Constructor functions do not have a yield value\n    //  so we can bail here, too.\n    'class',\n    'constructor',\n\n    // This seems to imply a class as well\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/**\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {import('../iterateJsdoc.js').Report} report\n * @param {string} tagName\n * @returns {[]|[preferredTagName: string, tag: import('comment-parser').Spec]}\n */\nconst checkTagName = (utils, report, tagName) => {\n  const preferredTagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName,\n  }));\n  if (!preferredTagName) {\n    return [];\n  }\n\n  const tags = utils.getTags(preferredTagName);\n\n  if (tags.length === 0) {\n    return [];\n  }\n\n  if (tags.length > 1) {\n    report(`Found more than one @${preferredTagName} declaration.`);\n\n    return [];\n  }\n\n  return [\n    preferredTagName, tags[0],\n  ];\n};\n\nexport default iterateJsdoc(({\n  context,\n  report,\n  settings,\n  utils,\n}) => {\n  if (canSkip(utils, settings)) {\n    return;\n  }\n\n  const {\n    checkGeneratorsOnly = false,\n    next = false,\n  } = context.options[0] || {};\n\n  const [\n    preferredYieldTagName,\n    yieldTag,\n  ] = checkTagName(\n    utils, report, 'yields',\n  );\n  if (preferredYieldTagName) {\n    const shouldReportYields = () => {\n      if (\n        /** @type {import('comment-parser').Spec} */ (\n          yieldTag\n        ).type.trim() === 'never'\n      ) {\n        if (utils.hasYieldValue()) {\n          report(`JSDoc @${preferredYieldTagName} declaration set with \"never\" but yield expression is present in function.`);\n        }\n\n        return false;\n      }\n\n      if (checkGeneratorsOnly && !utils.isGenerator()) {\n        return true;\n      }\n\n      return !utils.mayBeUndefinedTypeTag(\n        /** @type {import('comment-parser').Spec} */\n        (yieldTag),\n      ) && !utils.hasYieldValue();\n    };\n\n    // In case a yield value is declared in JSDoc, we also expect one in the code.\n    if (shouldReportYields()) {\n      report(`JSDoc @${preferredYieldTagName} declaration present but yield expression not available in function.`);\n    }\n  }\n\n  if (next) {\n    const [\n      preferredNextTagName,\n      nextTag,\n    ] = checkTagName(\n      utils, report, 'next',\n    );\n    if (preferredNextTagName) {\n      const shouldReportNext = () => {\n        if (\n          /** @type {import('comment-parser').Spec} */ (\n            nextTag\n          ).type.trim() === 'never'\n        ) {\n          if (utils.hasYieldReturnValue()) {\n            report(`JSDoc @${preferredNextTagName} declaration set with \"never\" but yield expression with return value is present in function.`);\n          }\n\n          return false;\n        }\n\n        if (checkGeneratorsOnly && !utils.isGenerator()) {\n          return true;\n        }\n\n        return !utils.mayBeUndefinedTypeTag(\n          /** @type {import('comment-parser').Spec} */\n          (nextTag),\n        ) && !utils.hasYieldReturnValue();\n      };\n\n      if (shouldReportNext()) {\n        report(`JSDoc @${preferredNextTagName} declaration present but yield expression with return value not available in function.`);\n      }\n    }\n  }\n}, {\n  meta: {\n    docs: {\n      description: 'Requires a yield statement in function body if a `@yields` tag is specified in jsdoc comment.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-check.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          checkGeneratorsOnly: {\n            default: false,\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                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          next: {\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;EAGA;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;;;;;;;AAQD,MAAM,eAAe,CAAC,OAAO,QAAQ,YAAY;CAC/C,MAAM,mBAA0C,MAAM,oBAAoB,EACxE,QACD,EAAC;AACF,KAAI,CAAC,iBACH,QAAO,CAAE;CAGX,MAAM,OAAO,MAAM,QAAQ,iBAAiB;AAE5C,KAAI,KAAK,WAAW,EAClB,QAAO,CAAE;AAGX,KAAI,KAAK,SAAS,GAAG;EACnB,OAAO,CAAC,qBAAqB,EAAE,iBAAiB,aAAa,CAAC,CAAC;AAE/D,SAAO,CAAE;CACV;AAED,QAAO,CACL,kBAAkB,KAAK,EACxB;AACF;AAED,iCAAeA,6BAAa,CAAC,EAC3B,SACA,QACA,UACA,OACD,KAAK;AACJ,KAAI,QAAQ,OAAO,SAAS,CAC1B;CAGF,MAAM,EACJ,sBAAsB,OACtB,OAAO,OACR,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,MAAM,CACJ,uBACA,SACD,GAAG,aACF,OAAO,QAAQ,SAChB;AACD,KAAI,uBAAuB;EACzB,MAAM,qBAAqB,MAAM;AAC/B,OAEI,SACA,KAAK,MAAM,KAAK,SAClB;AACA,QAAI,MAAM,eAAe,EACvB,OAAO,CAAC,OAAO,EAAE,sBAAsB,0EAA0E,CAAC,CAAC;AAGrH,WAAO;GACR;AAED,OAAI,uBAAuB,CAAC,MAAM,aAAa,CAC7C,QAAO;AAGT,UAAO,CAAC,MAAM,sBAEX,SACF,IAAI,CAAC,MAAM,eAAe;EAC5B;AAGD,MAAI,oBAAoB,EACtB,OAAO,CAAC,OAAO,EAAE,sBAAsB,oEAAoE,CAAC,CAAC;CAEhH;AAED,KAAI,MAAM;EACR,MAAM,CACJ,sBACA,QACD,GAAG,aACF,OAAO,QAAQ,OAChB;AACD,MAAI,sBAAsB;GACxB,MAAM,mBAAmB,MAAM;AAC7B,QAEI,QACA,KAAK,MAAM,KAAK,SAClB;AACA,SAAI,MAAM,qBAAqB,EAC7B,OAAO,CAAC,OAAO,EAAE,qBAAqB,4FAA4F,CAAC,CAAC;AAGtI,YAAO;IACR;AAED,QAAI,uBAAuB,CAAC,MAAM,aAAa,CAC7C,QAAO;AAGT,WAAO,CAAC,MAAM,sBAEX,QACF,IAAI,CAAC,MAAM,qBAAqB;GAClC;AAED,OAAI,kBAAkB,EACpB,OAAO,CAAC,OAAO,EAAE,qBAAqB,sFAAsF,CAAC,CAAC;EAEjI;CACF;AACF,GAAE,EACD,MAAM;CACJ,MAAM;EACJ,aAAa;EACb,KAAK;CACN;CACD,QAAQ,CACN;EACE,sBAAsB;EACtB,YAAY;GACV,qBAAqB;IACnB,SAAS;IACT,MAAM;GACP;GACD,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;GACD,YAAY;IACV,OAAO,EACL,MAAM,SACP;IACD,MAAM;GACP;GACD,MAAM;IACJ,SAAS;IACT,MAAM;GACP;EACF;EACD,MAAM;CACP,CACF;CACD,MAAM;AACP,EACF,EAAC"}

package/dist/rules/requireYieldsCheck.js

@@ -0,0 +1,105 @@
+import iterateJsdoc from "../iterateJsdoc.js";
+
+//#region src/rules/requireYieldsCheck.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");
+};
+/**
+* @param {import('../iterateJsdoc.js').Utils} utils
+* @param {import('../iterateJsdoc.js').Report} report
+* @param {string} tagName
+* @returns {[]|[preferredTagName: string, tag: import('comment-parser').Spec]}
+*/
+const checkTagName = (utils, report, tagName) => {
+	const preferredTagName = utils.getPreferredTagName({ tagName });
+	if (!preferredTagName) return [];
+	const tags = utils.getTags(preferredTagName);
+	if (tags.length === 0) return [];
+	if (tags.length > 1) {
+		report(`Found more than one @${preferredTagName} declaration.`);
+		return [];
+	}
+	return [preferredTagName, tags[0]];
+};
+var requireYieldsCheck_default = iterateJsdoc(({ context, report, settings, utils }) => {
+	if (canSkip(utils, settings)) return;
+	const { checkGeneratorsOnly = false, next = false } = context.options[0] || {};
+	const [preferredYieldTagName, yieldTag] = checkTagName(utils, report, "yields");
+	if (preferredYieldTagName) {
+		const shouldReportYields = () => {
+			if (yieldTag.type.trim() === "never") {
+				if (utils.hasYieldValue()) report(`JSDoc @${preferredYieldTagName} declaration set with "never" but yield expression is present in function.`);
+				return false;
+			}
+			if (checkGeneratorsOnly && !utils.isGenerator()) return true;
+			return !utils.mayBeUndefinedTypeTag(yieldTag) && !utils.hasYieldValue();
+		};
+		if (shouldReportYields()) report(`JSDoc @${preferredYieldTagName} declaration present but yield expression not available in function.`);
+	}
+	if (next) {
+		const [preferredNextTagName, nextTag] = checkTagName(utils, report, "next");
+		if (preferredNextTagName) {
+			const shouldReportNext = () => {
+				if (nextTag.type.trim() === "never") {
+					if (utils.hasYieldReturnValue()) report(`JSDoc @${preferredNextTagName} declaration set with "never" but yield expression with return value is present in function.`);
+					return false;
+				}
+				if (checkGeneratorsOnly && !utils.isGenerator()) return true;
+				return !utils.mayBeUndefinedTypeTag(nextTag) && !utils.hasYieldReturnValue();
+			};
+			if (shouldReportNext()) report(`JSDoc @${preferredNextTagName} declaration present but yield expression with return value not available in function.`);
+		}
+	}
+}, { meta: {
+	docs: {
+		description: "Requires a yield statement in function body if a `@yields` tag is specified in jsdoc comment.",
+		url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-check.md#repos-sticky-header"
+	},
+	schema: [{
+		additionalProperties: false,
+		properties: {
+			checkGeneratorsOnly: {
+				default: false,
+				type: "boolean"
+			},
+			contexts: {
+				items: { anyOf: [{ type: "string" }, {
+					additionalProperties: false,
+					properties: {
+						comment: { type: "string" },
+						context: { type: "string" }
+					},
+					type: "object"
+				}] },
+				type: "array"
+			},
+			exemptedBy: {
+				items: { type: "string" },
+				type: "array"
+			},
+			next: {
+				default: false,
+				type: "boolean"
+			}
+		},
+		type: "object"
+	}],
+	type: "suggestion"
+} });
+
+//#endregion
+export { requireYieldsCheck_default as default };
+//# sourceMappingURL=requireYieldsCheck.js.map

package/dist/rules/requireYieldsCheck.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requireYieldsCheck.js","names":[],"sources":["../../src/rules/requireYieldsCheck.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 yield is documented but\n    // not present within the function.\n    // A subclass may inherit the doc and implement the\n    // missing yield.\n    'abstract',\n    'virtual',\n\n    // Constructor functions do not have a yield value\n    //  so we can bail here, too.\n    'class',\n    'constructor',\n\n    // This seems to imply a class as well\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/**\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {import('../iterateJsdoc.js').Report} report\n * @param {string} tagName\n * @returns {[]|[preferredTagName: string, tag: import('comment-parser').Spec]}\n */\nconst checkTagName = (utils, report, tagName) => {\n  const preferredTagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName,\n  }));\n  if (!preferredTagName) {\n    return [];\n  }\n\n  const tags = utils.getTags(preferredTagName);\n\n  if (tags.length === 0) {\n    return [];\n  }\n\n  if (tags.length > 1) {\n    report(`Found more than one @${preferredTagName} declaration.`);\n\n    return [];\n  }\n\n  return [\n    preferredTagName, tags[0],\n  ];\n};\n\nexport default iterateJsdoc(({\n  context,\n  report,\n  settings,\n  utils,\n}) => {\n  if (canSkip(utils, settings)) {\n    return;\n  }\n\n  const {\n    checkGeneratorsOnly = false,\n    next = false,\n  } = context.options[0] || {};\n\n  const [\n    preferredYieldTagName,\n    yieldTag,\n  ] = checkTagName(\n    utils, report, 'yields',\n  );\n  if (preferredYieldTagName) {\n    const shouldReportYields = () => {\n      if (\n        /** @type {import('comment-parser').Spec} */ (\n          yieldTag\n        ).type.trim() === 'never'\n      ) {\n        if (utils.hasYieldValue()) {\n          report(`JSDoc @${preferredYieldTagName} declaration set with \"never\" but yield expression is present in function.`);\n        }\n\n        return false;\n      }\n\n      if (checkGeneratorsOnly && !utils.isGenerator()) {\n        return true;\n      }\n\n      return !utils.mayBeUndefinedTypeTag(\n        /** @type {import('comment-parser').Spec} */\n        (yieldTag),\n      ) && !utils.hasYieldValue();\n    };\n\n    // In case a yield value is declared in JSDoc, we also expect one in the code.\n    if (shouldReportYields()) {\n      report(`JSDoc @${preferredYieldTagName} declaration present but yield expression not available in function.`);\n    }\n  }\n\n  if (next) {\n    const [\n      preferredNextTagName,\n      nextTag,\n    ] = checkTagName(\n      utils, report, 'next',\n    );\n    if (preferredNextTagName) {\n      const shouldReportNext = () => {\n        if (\n          /** @type {import('comment-parser').Spec} */ (\n            nextTag\n          ).type.trim() === 'never'\n        ) {\n          if (utils.hasYieldReturnValue()) {\n            report(`JSDoc @${preferredNextTagName} declaration set with \"never\" but yield expression with return value is present in function.`);\n          }\n\n          return false;\n        }\n\n        if (checkGeneratorsOnly && !utils.isGenerator()) {\n          return true;\n        }\n\n        return !utils.mayBeUndefinedTypeTag(\n          /** @type {import('comment-parser').Spec} */\n          (nextTag),\n        ) && !utils.hasYieldReturnValue();\n      };\n\n      if (shouldReportNext()) {\n        report(`JSDoc @${preferredNextTagName} declaration present but yield expression with return value not available in function.`);\n      }\n    }\n  }\n}, {\n  meta: {\n    docs: {\n      description: 'Requires a yield statement in function body if a `@yields` tag is specified in jsdoc comment.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-check.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          checkGeneratorsOnly: {\n            default: false,\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                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          next: {\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;EAGA;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;;;;;;;AAQD,MAAM,eAAe,CAAC,OAAO,QAAQ,YAAY;CAC/C,MAAM,mBAA0C,MAAM,oBAAoB,EACxE,QACD,EAAC;AACF,KAAI,CAAC,iBACH,QAAO,CAAE;CAGX,MAAM,OAAO,MAAM,QAAQ,iBAAiB;AAE5C,KAAI,KAAK,WAAW,EAClB,QAAO,CAAE;AAGX,KAAI,KAAK,SAAS,GAAG;EACnB,OAAO,CAAC,qBAAqB,EAAE,iBAAiB,aAAa,CAAC,CAAC;AAE/D,SAAO,CAAE;CACV;AAED,QAAO,CACL,kBAAkB,KAAK,EACxB;AACF;AAED,iCAAe,aAAa,CAAC,EAC3B,SACA,QACA,UACA,OACD,KAAK;AACJ,KAAI,QAAQ,OAAO,SAAS,CAC1B;CAGF,MAAM,EACJ,sBAAsB,OACtB,OAAO,OACR,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,MAAM,CACJ,uBACA,SACD,GAAG,aACF,OAAO,QAAQ,SAChB;AACD,KAAI,uBAAuB;EACzB,MAAM,qBAAqB,MAAM;AAC/B,OAEI,SACA,KAAK,MAAM,KAAK,SAClB;AACA,QAAI,MAAM,eAAe,EACvB,OAAO,CAAC,OAAO,EAAE,sBAAsB,0EAA0E,CAAC,CAAC;AAGrH,WAAO;GACR;AAED,OAAI,uBAAuB,CAAC,MAAM,aAAa,CAC7C,QAAO;AAGT,UAAO,CAAC,MAAM,sBAEX,SACF,IAAI,CAAC,MAAM,eAAe;EAC5B;AAGD,MAAI,oBAAoB,EACtB,OAAO,CAAC,OAAO,EAAE,sBAAsB,oEAAoE,CAAC,CAAC;CAEhH;AAED,KAAI,MAAM;EACR,MAAM,CACJ,sBACA,QACD,GAAG,aACF,OAAO,QAAQ,OAChB;AACD,MAAI,sBAAsB;GACxB,MAAM,mBAAmB,MAAM;AAC7B,QAEI,QACA,KAAK,MAAM,KAAK,SAClB;AACA,SAAI,MAAM,qBAAqB,EAC7B,OAAO,CAAC,OAAO,EAAE,qBAAqB,4FAA4F,CAAC,CAAC;AAGtI,YAAO;IACR;AAED,QAAI,uBAAuB,CAAC,MAAM,aAAa,CAC7C,QAAO;AAGT,WAAO,CAAC,MAAM,sBAEX,QACF,IAAI,CAAC,MAAM,qBAAqB;GAClC;AAED,OAAI,kBAAkB,EACpB,OAAO,CAAC,OAAO,EAAE,qBAAqB,sFAAsF,CAAC,CAAC;EAEjI;CACF;AACF,GAAE,EACD,MAAM;CACJ,MAAM;EACJ,aAAa;EACb,KAAK;CACN;CACD,QAAQ,CACN;EACE,sBAAsB;EACtB,YAAY;GACV,qBAAqB;IACnB,SAAS;IACT,MAAM;GACP;GACD,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;GACD,YAAY;IACV,OAAO,EACL,MAAM,SACP;IACD,MAAM;GACP;GACD,MAAM;IACJ,SAAS;IACT,MAAM;GACP;EACF;EACD,MAAM;CACP,CACF;CACD,MAAM;AACP,EACF,EAAC"}