eslint-plugin-jsdoc 53.0.1 → 54.0.0

package/dist/rules/requireYields.cjs

@@ -1,115 +1,175 @@
-const require_iterateJsdoc = require('../iterateJsdoc.cjs');
+"use strict";
 
-//#region src/rules/requireYields.js
+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 }; }
 /**
-* We can skip checking for a yield value, in case the documentation is inherited
-* or the method has a constructor or abstract tag.
-*
-* In either of these cases the yield 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();
+ * We can skip checking for a yield value, in case the documentation is inherited
+ * or the method has a constructor or abstract tag.
+ *
+ * In either of these cases the yield 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([
+  // inheritdoc implies that all documentation is inherited
+  // see https://jsdoc.app/tags-inheritdoc.html
+  //
+  // Abstract methods are by definition incomplete,
+  // so it is not an error if it declares a yield value but does not implement it.
+  'abstract', 'virtual',
+  // Constructors do not have a yield value
+  // so we can bail out here, too.
+  'class', 'constructor',
+  // Yield (and any `next`) type is specified accompanying the targeted
+  //   @type
+  'type',
+  // This seems to imply a class as well
+  'interface']) || utils.avoidDocs();
 };
+
 /**
-* @param {import('../iterateJsdoc.js').Utils} utils
-* @param {import('../iterateJsdoc.js').Report} report
-* @param {string} tagName
-* @returns {[preferredTagName?: string, missingTag?: boolean]}
-*/
+ * @param {import('../iterateJsdoc.js').Utils} utils
+ * @param {import('../iterateJsdoc.js').Report} report
+ * @param {string} tagName
+ * @returns {[preferredTagName?: string, missingTag?: boolean]}
+ */
 const checkTagName = (utils, report, tagName) => {
-	const preferredTagName = utils.getPreferredTagName({ tagName });
-	if (!preferredTagName) return [];
-	const tags = utils.getTags(preferredTagName);
-	if (tags.length > 1) report(`Found more than one @${preferredTagName} declaration.`);
-	const [tag] = tags;
-	const missingTag = typeof tag === "undefined" || tag === null;
-	return [preferredTagName, missingTag];
+  const preferredTagName = /** @type {string} */utils.getPreferredTagName({
+    tagName
+  });
+  if (!preferredTagName) {
+    return [];
+  }
+  const tags = utils.getTags(preferredTagName);
+  if (tags.length > 1) {
+    report(`Found more than one @${preferredTagName} declaration.`);
+  }
+
+  // In case the code yields something, we expect a yields value in JSDoc.
+  const [tag] = tags;
+  const missingTag = typeof tag === 'undefined' || tag === null;
+  return [preferredTagName, missingTag];
 };
-var requireYields_default = require_iterateJsdoc.default(({ context, report, utils }) => {
-	const { forceRequireNext = false, forceRequireYields = false, next = false, nextWithGeneratorTag = false, withGeneratorTag = true } = context.options[0] || {};
-	if (canSkip(utils)) return;
-	const iteratingFunction = utils.isIteratingFunction();
-	const [preferredYieldTagName, missingYieldTag] = checkTagName(utils, report, "yields");
-	if (preferredYieldTagName) {
-		const shouldReportYields = () => {
-			if (!missingYieldTag) return false;
-			if (withGeneratorTag && utils.hasTag("generator") || forceRequireYields && iteratingFunction && utils.isGenerator()) return true;
-			return iteratingFunction && utils.isGenerator() && utils.hasYieldValue();
-		};
-		if (shouldReportYields()) report(`Missing JSDoc @${preferredYieldTagName} declaration.`);
-	}
-	if (next || nextWithGeneratorTag || forceRequireNext) {
-		const [preferredNextTagName, missingNextTag] = checkTagName(utils, report, "next");
-		if (!preferredNextTagName) return;
-		const shouldReportNext = () => {
-			if (!missingNextTag) return false;
-			if (nextWithGeneratorTag && utils.hasTag("generator")) return true;
-			if (!next && !forceRequireNext || !iteratingFunction || !utils.isGenerator()) return false;
-			return forceRequireNext || utils.hasYieldReturnValue();
-		};
-		if (shouldReportNext()) report(`Missing JSDoc @${preferredNextTagName} declaration.`);
-	}
+var _default = exports.default = (0, _iterateJsdoc.default)(({
+  context,
+  report,
+  utils
+}) => {
+  const {
+    forceRequireNext = false,
+    forceRequireYields = false,
+    next = false,
+    nextWithGeneratorTag = false,
+    withGeneratorTag = true
+  } = context.options[0] || {};
+
+  // A preflight check. We do not need to run a deep check
+  // in case the @yield comment is optional or undefined.
+  if (canSkip(utils)) {
+    return;
+  }
+  const iteratingFunction = utils.isIteratingFunction();
+  const [preferredYieldTagName, missingYieldTag] = checkTagName(utils, report, 'yields');
+  if (preferredYieldTagName) {
+    const shouldReportYields = () => {
+      if (!missingYieldTag) {
+        return false;
+      }
+      if (withGeneratorTag && utils.hasTag('generator') || forceRequireYields && iteratingFunction && utils.isGenerator()) {
+        return true;
+      }
+      return iteratingFunction && utils.isGenerator() && utils.hasYieldValue();
+    };
+    if (shouldReportYields()) {
+      report(`Missing JSDoc @${preferredYieldTagName} declaration.`);
+    }
+  }
+  if (next || nextWithGeneratorTag || forceRequireNext) {
+    const [preferredNextTagName, missingNextTag] = checkTagName(utils, report, 'next');
+    if (!preferredNextTagName) {
+      return;
+    }
+    const shouldReportNext = () => {
+      if (!missingNextTag) {
+        return false;
+      }
+      if (nextWithGeneratorTag && utils.hasTag('generator')) {
+        return true;
+      }
+      if (!next && !forceRequireNext || !iteratingFunction || !utils.isGenerator()) {
+        return false;
+      }
+      return forceRequireNext || utils.hasYieldReturnValue();
+    };
+    if (shouldReportNext()) {
+      report(`Missing JSDoc @${preferredNextTagName} declaration.`);
+    }
+  }
 }, {
-	contextDefaults: true,
-	meta: {
-		docs: {
-			description: "Requires yields are documented.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields.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"
-				},
-				forceRequireNext: {
-					default: false,
-					type: "boolean"
-				},
-				forceRequireYields: {
-					default: false,
-					type: "boolean"
-				},
-				next: {
-					default: false,
-					type: "boolean"
-				},
-				nextWithGeneratorTag: {
-					default: false,
-					type: "boolean"
-				},
-				withGeneratorTag: {
-					default: true,
-					type: "boolean"
-				}
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	}
+  contextDefaults: true,
+  meta: {
+    docs: {
+      description: 'Requires yields are documented.',
+      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields.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'
+        },
+        forceRequireNext: {
+          default: false,
+          type: 'boolean'
+        },
+        forceRequireYields: {
+          default: false,
+          type: 'boolean'
+        },
+        next: {
+          default: false,
+          type: 'boolean'
+        },
+        nextWithGeneratorTag: {
+          default: false,
+          type: 'boolean'
+        },
+        withGeneratorTag: {
+          default: true,
+          type: 'boolean'
+        }
+      },
+      type: 'object'
+    }],
+    type: 'suggestion'
+  }
 });
-
-//#endregion
-exports.default = requireYields_default;
+module.exports = exports.default;
 //# sourceMappingURL=requireYields.cjs.map

package/dist/rules/requireYields.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"requireYields.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/requireYields.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * We can skip checking for a yield value, in case the documentation is inherited\n * or the method has a constructor or abstract tag.\n *\n * In either of these cases the yield value is optional or not defined.\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 an error if it declares a yield value but does not implement it.\n    'abstract',\n    'virtual',\n\n    // Constructors do not have a yield value\n    // so we can bail out here, too.\n    'class',\n    'constructor',\n\n    // Yield (and any `next`) type is specified accompanying the targeted\n    //   @type\n    'type',\n\n    // This seems to imply a class as well\n    'interface',\n  ]) ||\n    utils.avoidDocs();\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, missingTag?: boolean]}\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 > 1) {\n    report(`Found more than one @${preferredTagName} declaration.`);\n  }\n\n  // In case the code yields something, we expect a yields value in JSDoc.\n  const [\n    tag,\n  ] = tags;\n  const missingTag = typeof tag === 'undefined' || tag === null;\n\n  return [\n    preferredTagName, missingTag,\n  ];\n};\n\nexport default iterateJsdoc(({\n  context,\n  report,\n  utils,\n}) => {\n  const {\n    forceRequireNext = false,\n    forceRequireYields = false,\n    next = false,\n    nextWithGeneratorTag = false,\n    withGeneratorTag = true,\n  } = context.options[0] || {};\n\n  // A preflight check. We do not need to run a deep check\n  // in case the @yield comment is optional or undefined.\n  if (canSkip(utils)) {\n    return;\n  }\n\n  const iteratingFunction = utils.isIteratingFunction();\n\n  const [\n    preferredYieldTagName,\n    missingYieldTag,\n  ] = checkTagName(\n    utils, report, 'yields',\n  );\n  if (preferredYieldTagName) {\n    const shouldReportYields = () => {\n      if (!missingYieldTag) {\n        return false;\n      }\n\n      if (\n        withGeneratorTag && utils.hasTag('generator') ||\n        forceRequireYields && iteratingFunction && utils.isGenerator()\n      ) {\n        return true;\n      }\n\n      return iteratingFunction && utils.isGenerator() && utils.hasYieldValue();\n    };\n\n    if (shouldReportYields()) {\n      report(`Missing JSDoc @${preferredYieldTagName} declaration.`);\n    }\n  }\n\n  if (next || nextWithGeneratorTag || forceRequireNext) {\n    const [\n      preferredNextTagName,\n      missingNextTag,\n    ] = checkTagName(\n      utils, report, 'next',\n    );\n    if (!preferredNextTagName) {\n      return;\n    }\n\n    const shouldReportNext = () => {\n      if (!missingNextTag) {\n        return false;\n      }\n\n      if (\n        nextWithGeneratorTag && utils.hasTag('generator')) {\n        return true;\n      }\n\n      if (\n        !next && !forceRequireNext ||\n        !iteratingFunction ||\n        !utils.isGenerator()\n      ) {\n        return false;\n      }\n\n      return forceRequireNext || utils.hasYieldReturnValue();\n    };\n\n    if (shouldReportNext()) {\n      report(`Missing JSDoc @${preferredNextTagName} declaration.`);\n    }\n  }\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires yields are documented.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields.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          forceRequireNext: {\n            default: false,\n            type: 'boolean',\n          },\n          forceRequireYields: {\n            default: false,\n            type: 'boolean',\n          },\n          next: {\n            default: false,\n            type: 'boolean',\n          },\n          nextWithGeneratorTag: {\n            default: false,\n            type: 'boolean',\n          },\n          withGeneratorTag: {\n            default: true,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;;;;AAUA,MAAM,UAAU,CAAC,UAAU;AACzB,QAAO,MAAM,QAAQ;EAMnB;EACA;EAIA;EACA;EAIA;EAGA;CACD,EAAC,IACA,MAAM,WAAW;AACpB;;;;;;;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,SAAS,GAChB,OAAO,CAAC,qBAAqB,EAAE,iBAAiB,aAAa,CAAC,CAAC;CAIjE,MAAM,CACJ,IACD,GAAG;CACJ,MAAM,aAAa,OAAO,QAAQ,eAAe,QAAQ;AAEzD,QAAO,CACL,kBAAkB,UACnB;AACF;AAED,4BAAeA,6BAAa,CAAC,EAC3B,SACA,QACA,OACD,KAAK;CACJ,MAAM,EACJ,mBAAmB,OACnB,qBAAqB,OACrB,OAAO,OACP,uBAAuB,OACvB,mBAAmB,MACpB,GAAG,QAAQ,QAAQ,MAAM,CAAE;AAI5B,KAAI,QAAQ,MAAM,CAChB;CAGF,MAAM,oBAAoB,MAAM,qBAAqB;CAErD,MAAM,CACJ,uBACA,gBACD,GAAG,aACF,OAAO,QAAQ,SAChB;AACD,KAAI,uBAAuB;EACzB,MAAM,qBAAqB,MAAM;AAC/B,OAAI,CAAC,gBACH,QAAO;AAGT,OACE,oBAAoB,MAAM,OAAO,YAAY,IAC7C,sBAAsB,qBAAqB,MAAM,aAAa,CAE9D,QAAO;AAGT,UAAO,qBAAqB,MAAM,aAAa,IAAI,MAAM,eAAe;EACzE;AAED,MAAI,oBAAoB,EACtB,OAAO,CAAC,eAAe,EAAE,sBAAsB,aAAa,CAAC,CAAC;CAEjE;AAED,KAAI,QAAQ,wBAAwB,kBAAkB;EACpD,MAAM,CACJ,sBACA,eACD,GAAG,aACF,OAAO,QAAQ,OAChB;AACD,MAAI,CAAC,qBACH;EAGF,MAAM,mBAAmB,MAAM;AAC7B,OAAI,CAAC,eACH,QAAO;AAGT,OACE,wBAAwB,MAAM,OAAO,YAAY,CACjD,QAAO;AAGT,OACE,CAAC,QAAQ,CAAC,oBACV,CAAC,qBACD,CAAC,MAAM,aAAa,CAEpB,QAAO;AAGT,UAAO,oBAAoB,MAAM,qBAAqB;EACvD;AAED,MAAI,kBAAkB,EACpB,OAAO,CAAC,eAAe,EAAE,qBAAqB,aAAa,CAAC,CAAC;CAEhE;AACF,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;IACD,kBAAkB;KAChB,SAAS;KACT,MAAM;IACP;IACD,oBAAoB;KAClB,SAAS;KACT,MAAM;IACP;IACD,MAAM;KACJ,SAAS;KACT,MAAM;IACP;IACD,sBAAsB;KACpB,SAAS;KACT,MAAM;IACP;IACD,kBAAkB;KAChB,SAAS;KACT,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}
+{"version":3,"file":"requireYields.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","canSkip","utils","hasATag","avoidDocs","checkTagName","report","tagName","preferredTagName","getPreferredTagName","tags","getTags","length","tag","missingTag","_default","exports","iterateJsdoc","context","forceRequireNext","forceRequireYields","next","nextWithGeneratorTag","withGeneratorTag","options","iteratingFunction","isIteratingFunction","preferredYieldTagName","missingYieldTag","shouldReportYields","hasTag","isGenerator","hasYieldValue","preferredNextTagName","missingNextTag","shouldReportNext","hasYieldReturnValue","contextDefaults","meta","docs","description","url","schema","additionalProperties","properties","contexts","items","anyOf","type","comment","exemptedBy","module"],"sources":["../../src/rules/requireYields.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * We can skip checking for a yield value, in case the documentation is inherited\n * or the method has a constructor or abstract tag.\n *\n * In either of these cases the yield value is optional or not defined.\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 an error if it declares a yield value but does not implement it.\n    'abstract',\n    'virtual',\n\n    // Constructors do not have a yield value\n    // so we can bail out here, too.\n    'class',\n    'constructor',\n\n    // Yield (and any `next`) type is specified accompanying the targeted\n    //   @type\n    'type',\n\n    // This seems to imply a class as well\n    'interface',\n  ]) ||\n    utils.avoidDocs();\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, missingTag?: boolean]}\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 > 1) {\n    report(`Found more than one @${preferredTagName} declaration.`);\n  }\n\n  // In case the code yields something, we expect a yields value in JSDoc.\n  const [\n    tag,\n  ] = tags;\n  const missingTag = typeof tag === 'undefined' || tag === null;\n\n  return [\n    preferredTagName, missingTag,\n  ];\n};\n\nexport default iterateJsdoc(({\n  context,\n  report,\n  utils,\n}) => {\n  const {\n    forceRequireNext = false,\n    forceRequireYields = false,\n    next = false,\n    nextWithGeneratorTag = false,\n    withGeneratorTag = true,\n  } = context.options[0] || {};\n\n  // A preflight check. We do not need to run a deep check\n  // in case the @yield comment is optional or undefined.\n  if (canSkip(utils)) {\n    return;\n  }\n\n  const iteratingFunction = utils.isIteratingFunction();\n\n  const [\n    preferredYieldTagName,\n    missingYieldTag,\n  ] = checkTagName(\n    utils, report, 'yields',\n  );\n  if (preferredYieldTagName) {\n    const shouldReportYields = () => {\n      if (!missingYieldTag) {\n        return false;\n      }\n\n      if (\n        withGeneratorTag && utils.hasTag('generator') ||\n        forceRequireYields && iteratingFunction && utils.isGenerator()\n      ) {\n        return true;\n      }\n\n      return iteratingFunction && utils.isGenerator() && utils.hasYieldValue();\n    };\n\n    if (shouldReportYields()) {\n      report(`Missing JSDoc @${preferredYieldTagName} declaration.`);\n    }\n  }\n\n  if (next || nextWithGeneratorTag || forceRequireNext) {\n    const [\n      preferredNextTagName,\n      missingNextTag,\n    ] = checkTagName(\n      utils, report, 'next',\n    );\n    if (!preferredNextTagName) {\n      return;\n    }\n\n    const shouldReportNext = () => {\n      if (!missingNextTag) {\n        return false;\n      }\n\n      if (\n        nextWithGeneratorTag && utils.hasTag('generator')) {\n        return true;\n      }\n\n      if (\n        !next && !forceRequireNext ||\n        !iteratingFunction ||\n        !utils.isGenerator()\n      ) {\n        return false;\n      }\n\n      return forceRequireNext || utils.hasYieldReturnValue();\n    };\n\n    if (shouldReportNext()) {\n      report(`Missing JSDoc @${preferredNextTagName} declaration.`);\n    }\n  }\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires yields are documented.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields.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          forceRequireNext: {\n            default: false,\n            type: 'boolean',\n          },\n          forceRequireYields: {\n            default: false,\n            type: 'boolean',\n          },\n          next: {\n            default: false,\n            type: 'boolean',\n          },\n          nextWithGeneratorTag: {\n            default: false,\n            type: 'boolean',\n          },\n          withGeneratorTag: {\n            default: true,\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;AACA;AACA;AACA,MAAMG,OAAO,GAAIC,KAAK,IAAK;EACzB,OAAOA,KAAK,CAACC,OAAO,CAAC;EACnB;EACA;EACA;EACA;EACA;EACA,UAAU,EACV,SAAS;EAET;EACA;EACA,OAAO,EACP,aAAa;EAEb;EACA;EACA,MAAM;EAEN;EACA,WAAW,CACZ,CAAC,IACAD,KAAK,CAACE,SAAS,CAAC,CAAC;AACrB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,YAAY,GAAGA,CAACH,KAAK,EAAEI,MAAM,EAAEC,OAAO,KAAK;EAC/C,MAAMC,gBAAgB,GAAG,qBAAuBN,KAAK,CAACO,mBAAmB,CAAC;IACxEF;EACF,CAAC,CAAE;EACH,IAAI,CAACC,gBAAgB,EAAE;IACrB,OAAO,EAAE;EACX;EAEA,MAAME,IAAI,GAAGR,KAAK,CAACS,OAAO,CAACH,gBAAgB,CAAC;EAE5C,IAAIE,IAAI,CAACE,MAAM,GAAG,CAAC,EAAE;IACnBN,MAAM,CAAC,wBAAwBE,gBAAgB,eAAe,CAAC;EACjE;;EAEA;EACA,MAAM,CACJK,GAAG,CACJ,GAAGH,IAAI;EACR,MAAMI,UAAU,GAAG,OAAOD,GAAG,KAAK,WAAW,IAAIA,GAAG,KAAK,IAAI;EAE7D,OAAO,CACLL,gBAAgB,EAAEM,UAAU,CAC7B;AACH,CAAC;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAhB,OAAA,GAEa,IAAAiB,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPZ,MAAM;EACNJ;AACF,CAAC,KAAK;EACJ,MAAM;IACJiB,gBAAgB,GAAG,KAAK;IACxBC,kBAAkB,GAAG,KAAK;IAC1BC,IAAI,GAAG,KAAK;IACZC,oBAAoB,GAAG,KAAK;IAC5BC,gBAAgB,GAAG;EACrB,CAAC,GAAGL,OAAO,CAACM,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;EAE5B;EACA;EACA,IAAIvB,OAAO,CAACC,KAAK,CAAC,EAAE;IAClB;EACF;EAEA,MAAMuB,iBAAiB,GAAGvB,KAAK,CAACwB,mBAAmB,CAAC,CAAC;EAErD,MAAM,CACJC,qBAAqB,EACrBC,eAAe,CAChB,GAAGvB,YAAY,CACdH,KAAK,EAAEI,MAAM,EAAE,QACjB,CAAC;EACD,IAAIqB,qBAAqB,EAAE;IACzB,MAAME,kBAAkB,GAAGA,CAAA,KAAM;MAC/B,IAAI,CAACD,eAAe,EAAE;QACpB,OAAO,KAAK;MACd;MAEA,IACEL,gBAAgB,IAAIrB,KAAK,CAAC4B,MAAM,CAAC,WAAW,CAAC,IAC7CV,kBAAkB,IAAIK,iBAAiB,IAAIvB,KAAK,CAAC6B,WAAW,CAAC,CAAC,EAC9D;QACA,OAAO,IAAI;MACb;MAEA,OAAON,iBAAiB,IAAIvB,KAAK,CAAC6B,WAAW,CAAC,CAAC,IAAI7B,KAAK,CAAC8B,aAAa,CAAC,CAAC;IAC1E,CAAC;IAED,IAAIH,kBAAkB,CAAC,CAAC,EAAE;MACxBvB,MAAM,CAAC,kBAAkBqB,qBAAqB,eAAe,CAAC;IAChE;EACF;EAEA,IAAIN,IAAI,IAAIC,oBAAoB,IAAIH,gBAAgB,EAAE;IACpD,MAAM,CACJc,oBAAoB,EACpBC,cAAc,CACf,GAAG7B,YAAY,CACdH,KAAK,EAAEI,MAAM,EAAE,MACjB,CAAC;IACD,IAAI,CAAC2B,oBAAoB,EAAE;MACzB;IACF;IAEA,MAAME,gBAAgB,GAAGA,CAAA,KAAM;MAC7B,IAAI,CAACD,cAAc,EAAE;QACnB,OAAO,KAAK;MACd;MAEA,IACEZ,oBAAoB,IAAIpB,KAAK,CAAC4B,MAAM,CAAC,WAAW,CAAC,EAAE;QACnD,OAAO,IAAI;MACb;MAEA,IACE,CAACT,IAAI,IAAI,CAACF,gBAAgB,IAC1B,CAACM,iBAAiB,IAClB,CAACvB,KAAK,CAAC6B,WAAW,CAAC,CAAC,EACpB;QACA,OAAO,KAAK;MACd;MAEA,OAAOZ,gBAAgB,IAAIjB,KAAK,CAACkC,mBAAmB,CAAC,CAAC;IACxD,CAAC;IAED,IAAID,gBAAgB,CAAC,CAAC,EAAE;MACtB7B,MAAM,CAAC,kBAAkB2B,oBAAoB,eAAe,CAAC;IAC/D;EACF;AACF,CAAC,EAAE;EACDI,eAAe,EAAE,IAAI;EACrBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,iCAAiC;MAC9CC,GAAG,EAAE;IACP,CAAC;IACDC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVC,QAAQ,EAAE;UACRC,KAAK,EAAE;YACLC,KAAK,EAAE,CACL;cACEC,IAAI,EAAE;YACR,CAAC,EACD;cACEL,oBAAoB,EAAE,KAAK;cAC3BC,UAAU,EAAE;gBACVK,OAAO,EAAE;kBACPD,IAAI,EAAE;gBACR,CAAC;gBACD9B,OAAO,EAAE;kBACP8B,IAAI,EAAE;gBACR;cACF,CAAC;cACDA,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACDE,UAAU,EAAE;UACVJ,KAAK,EAAE;YACLE,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACD7B,gBAAgB,EAAE;UAChBnB,OAAO,EAAE,KAAK;UACdgD,IAAI,EAAE;QACR,CAAC;QACD5B,kBAAkB,EAAE;UAClBpB,OAAO,EAAE,KAAK;UACdgD,IAAI,EAAE;QACR,CAAC;QACD3B,IAAI,EAAE;UACJrB,OAAO,EAAE,KAAK;UACdgD,IAAI,EAAE;QACR,CAAC;QACD1B,oBAAoB,EAAE;UACpBtB,OAAO,EAAE,KAAK;UACdgD,IAAI,EAAE;QACR,CAAC;QACDzB,gBAAgB,EAAE;UAChBvB,OAAO,EAAE,IAAI;UACbgD,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAG,MAAA,CAAAnC,OAAA,GAAAA,OAAA,CAAAhB,OAAA","ignoreList":[]}

package/dist/rules/requireYieldsCheck.cjs

@@ -1,105 +1,161 @@
-const require_iterateJsdoc = require('../iterateJsdoc.cjs');
+"use strict";
 
-//#region src/rules/requireYieldsCheck.js
+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 }; }
 /**
-* @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 = [
-		"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");
+  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');
 };
+
 /**
-* @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 = 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 = /** @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]];
 };
-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"
-} });
+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();
+    };
 
-//#endregion
-exports.default = requireYieldsCheck_default;
+    // 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;
 //# sourceMappingURL=requireYieldsCheck.cjs.map