eslint-plugin-jsdoc 52.0.4 → 53.0.1

package/dist/rules/requireReturnsCheck.cjs

@@ -1,109 +1,66 @@
-"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/requireReturnsCheck.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 return is documented but
-  // not present within the function.
-  // A subclass may inherit the doc and implement the
-  // missing return.
-  'abstract', 'virtual',
-  // A constructor function returns `this` by default, so may be `@returns`
-  //   tag indicating this but no explicit return
-  'class', 'constructor', '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");
 };
+var requireReturnsCheck_default = require_iterateJsdoc.default(({ context, node, report, settings, utils }) => {
+	const { exemptAsync = true, exemptGenerators = settings.mode === "typescript", reportMissingReturnForUndefinedTypes = false } = context.options[0] || {};
+	if (canSkip(utils, settings)) return;
+	if (exemptAsync && utils.isAsync()) return;
+	const tagName = utils.getPreferredTagName({ tagName: "returns" });
+	if (!tagName) return;
+	const tags = utils.getTags(tagName);
+	if (tags.length === 0) return;
+	if (tags.length > 1) {
+		report(`Found more than one @${tagName} declaration.`);
+		return;
+	}
+	const [tag] = tags;
+	const type = tag.type.trim();
+	if (/asserts\s/v.test(type)) return;
+	const returnNever = type === "never";
+	if (returnNever && utils.hasValueOrExecutorHasNonEmptyResolveValue(false)) {
+		report(`JSDoc @${tagName} declaration set with "never" but return expression is present in function.`);
+		return;
+	}
+	if (!returnNever && (reportMissingReturnForUndefinedTypes || !utils.mayBeUndefinedTypeTag(tag)) && (tag.type === "" && !utils.hasValueOrExecutorHasNonEmptyResolveValue(exemptAsync) || tag.type !== "" && !utils.hasValueOrExecutorHasNonEmptyResolveValue(exemptAsync, true)) && Boolean(!exemptGenerators || !node || !("generator" in node) || !node.generator)) report(`JSDoc @${tagName} declaration present but return expression not available in function.`);
+}, { meta: {
+	docs: {
+		description: "Requires a return statement in function body if a `@returns` tag is specified in jsdoc comment.",
+		url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-check.md#repos-sticky-header"
+	},
+	schema: [{
+		additionalProperties: false,
+		properties: {
+			exemptAsync: {
+				default: true,
+				type: "boolean"
+			},
+			exemptGenerators: { type: "boolean" },
+			reportMissingReturnForUndefinedTypes: {
+				default: false,
+				type: "boolean"
+			}
+		},
+		type: "object"
+	}],
+	type: "suggestion"
+} });
 
-// eslint-disable-next-line complexity -- Temporary
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  context,
-  node,
-  report,
-  settings,
-  utils
-}) => {
-  const {
-    exemptAsync = true,
-    exemptGenerators = settings.mode === 'typescript',
-    reportMissingReturnForUndefinedTypes = false
-  } = context.options[0] || {};
-  if (canSkip(utils, settings)) {
-    return;
-  }
-  if (exemptAsync && utils.isAsync()) {
-    return;
-  }
-  const tagName = /** @type {string} */utils.getPreferredTagName({
-    tagName: 'returns'
-  });
-  if (!tagName) {
-    return;
-  }
-  const tags = utils.getTags(tagName);
-  if (tags.length === 0) {
-    return;
-  }
-  if (tags.length > 1) {
-    report(`Found more than one @${tagName} declaration.`);
-    return;
-  }
-  const [tag] = tags;
-  const type = tag.type.trim();
-
-  // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#assertion-functions
-  if (/asserts\s/v.test(type)) {
-    return;
-  }
-  const returnNever = type === 'never';
-  if (returnNever && utils.hasValueOrExecutorHasNonEmptyResolveValue(false)) {
-    report(`JSDoc @${tagName} declaration set with "never" but return expression is present in function.`);
-    return;
-  }
-
-  // In case a return value is declared in JSDoc, we also expect one in the code.
-  if (!returnNever && (reportMissingReturnForUndefinedTypes || !utils.mayBeUndefinedTypeTag(tag)) && (tag.type === '' && !utils.hasValueOrExecutorHasNonEmptyResolveValue(exemptAsync) || tag.type !== '' && !utils.hasValueOrExecutorHasNonEmptyResolveValue(exemptAsync, true)) && Boolean(!exemptGenerators || !node || !('generator' in (/** @type {import('../iterateJsdoc.js').Node} */node)) || !(/** @type {import('@typescript-eslint/types').TSESTree.FunctionDeclaration} */node).generator)) {
-    report(`JSDoc @${tagName} declaration present but return expression not available in function.`);
-  }
-}, {
-  meta: {
-    docs: {
-      description: 'Requires a return statement in function body if a `@returns` tag is specified in jsdoc comment.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-check.md#repos-sticky-header'
-    },
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        exemptAsync: {
-          default: true,
-          type: 'boolean'
-        },
-        exemptGenerators: {
-          type: 'boolean'
-        },
-        reportMissingReturnForUndefinedTypes: {
-          default: false,
-          type: 'boolean'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'suggestion'
-  }
-});
-module.exports = exports.default;
+//#endregion
+exports.default = requireReturnsCheck_default;
 //# sourceMappingURL=requireReturnsCheck.cjs.map

package/dist/rules/requireReturnsCheck.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"requireReturnsCheck.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","canSkip","utils","settings","voidingTags","mode","push","hasATag","isConstructor","classHasTag","_default","exports","iterateJsdoc","context","node","report","exemptAsync","exemptGenerators","reportMissingReturnForUndefinedTypes","options","isAsync","tagName","getPreferredTagName","tags","getTags","length","tag","type","trim","test","returnNever","hasValueOrExecutorHasNonEmptyResolveValue","mayBeUndefinedTypeTag","Boolean","generator","meta","docs","description","url","schema","additionalProperties","properties","module"],"sources":["../../src/rules/requireReturnsCheck.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {import('../iterateJsdoc.js').Settings} settings\n * @returns {boolean}\n */\nconst canSkip = (utils, settings) => {\n  const voidingTags = [\n    // An abstract function is by definition incomplete\n    // so it is perfectly fine if a return is documented but\n    // not present within the function.\n    // A subclass may inherit the doc and implement the\n    // missing return.\n    'abstract',\n    'virtual',\n\n    // A constructor function returns `this` by default, so may be `@returns`\n    //   tag indicating this but no explicit return\n    'class',\n    'constructor',\n    'interface',\n  ];\n\n  if (settings.mode === 'closure') {\n    // Structural Interface in GCC terms, equivalent to @interface tag as far as this rule is concerned\n    voidingTags.push('record');\n  }\n\n  return utils.hasATag(voidingTags) ||\n    utils.isConstructor() ||\n    utils.classHasTag('interface') ||\n    settings.mode === 'closure' && utils.classHasTag('record');\n};\n\n// eslint-disable-next-line complexity -- Temporary\nexport default iterateJsdoc(({\n  context,\n  node,\n  report,\n  settings,\n  utils,\n}) => {\n  const {\n    exemptAsync = true,\n    exemptGenerators = settings.mode === 'typescript',\n    reportMissingReturnForUndefinedTypes = false,\n  } = context.options[0] || {};\n\n  if (canSkip(utils, settings)) {\n    return;\n  }\n\n  if (exemptAsync && utils.isAsync()) {\n    return;\n  }\n\n  const tagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'returns',\n  }));\n  if (!tagName) {\n    return;\n  }\n\n  const tags = utils.getTags(tagName);\n\n  if (tags.length === 0) {\n    return;\n  }\n\n  if (tags.length > 1) {\n    report(`Found more than one @${tagName} declaration.`);\n\n    return;\n  }\n\n  const [\n    tag,\n  ] = tags;\n\n  const type = tag.type.trim();\n\n  // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#assertion-functions\n  if (/asserts\\s/v.test(type)) {\n    return;\n  }\n\n  const returnNever = type === 'never';\n\n  if (returnNever && utils.hasValueOrExecutorHasNonEmptyResolveValue(false)) {\n    report(`JSDoc @${tagName} declaration set with \"never\" but return expression is present in function.`);\n\n    return;\n  }\n\n  // In case a return value is declared in JSDoc, we also expect one in the code.\n  if (\n    !returnNever &&\n    (\n      reportMissingReturnForUndefinedTypes ||\n      !utils.mayBeUndefinedTypeTag(tag)\n    ) &&\n    (tag.type === '' && !utils.hasValueOrExecutorHasNonEmptyResolveValue(\n      exemptAsync,\n    ) ||\n    tag.type !== '' && !utils.hasValueOrExecutorHasNonEmptyResolveValue(\n      exemptAsync,\n      true,\n    )) &&\n    Boolean(\n      !exemptGenerators || !node ||\n      !('generator' in /** @type {import('../iterateJsdoc.js').Node} */ (node)) ||\n      !(/** @type {import('@typescript-eslint/types').TSESTree.FunctionDeclaration} */ (node)).generator,\n    )\n  ) {\n    report(`JSDoc @${tagName} declaration present but return expression not available in function.`);\n  }\n}, {\n  meta: {\n    docs: {\n      description: 'Requires a return statement in function body if a `@returns` tag is specified in jsdoc comment.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-check.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          exemptAsync: {\n            default: true,\n            type: 'boolean',\n          },\n          exemptGenerators: {\n            type: 'boolean',\n          },\n          reportMissingReturnForUndefinedTypes: {\n            default: false,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;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,EACb,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;AAAA,IAAAC,QAAA,GAAAC,OAAA,CAAAX,OAAA,GACe,IAAAY,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,IAAI;EACJC,MAAM;EACNZ,QAAQ;EACRD;AACF,CAAC,KAAK;EACJ,MAAM;IACJc,WAAW,GAAG,IAAI;IAClBC,gBAAgB,GAAGd,QAAQ,CAACE,IAAI,KAAK,YAAY;IACjDa,oCAAoC,GAAG;EACzC,CAAC,GAAGL,OAAO,CAACM,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,IAAIlB,OAAO,CAACC,KAAK,EAAEC,QAAQ,CAAC,EAAE;IAC5B;EACF;EAEA,IAAIa,WAAW,IAAId,KAAK,CAACkB,OAAO,CAAC,CAAC,EAAE;IAClC;EACF;EAEA,MAAMC,OAAO,GAAG,qBAAuBnB,KAAK,CAACoB,mBAAmB,CAAC;IAC/DD,OAAO,EAAE;EACX,CAAC,CAAE;EACH,IAAI,CAACA,OAAO,EAAE;IACZ;EACF;EAEA,MAAME,IAAI,GAAGrB,KAAK,CAACsB,OAAO,CAACH,OAAO,CAAC;EAEnC,IAAIE,IAAI,CAACE,MAAM,KAAK,CAAC,EAAE;IACrB;EACF;EAEA,IAAIF,IAAI,CAACE,MAAM,GAAG,CAAC,EAAE;IACnBV,MAAM,CAAC,wBAAwBM,OAAO,eAAe,CAAC;IAEtD;EACF;EAEA,MAAM,CACJK,GAAG,CACJ,GAAGH,IAAI;EAER,MAAMI,IAAI,GAAGD,GAAG,CAACC,IAAI,CAACC,IAAI,CAAC,CAAC;;EAE5B;EACA,IAAI,YAAY,CAACC,IAAI,CAACF,IAAI,CAAC,EAAE;IAC3B;EACF;EAEA,MAAMG,WAAW,GAAGH,IAAI,KAAK,OAAO;EAEpC,IAAIG,WAAW,IAAI5B,KAAK,CAAC6B,yCAAyC,CAAC,KAAK,CAAC,EAAE;IACzEhB,MAAM,CAAC,UAAUM,OAAO,6EAA6E,CAAC;IAEtG;EACF;;EAEA;EACA,IACE,CAACS,WAAW,KAEVZ,oCAAoC,IACpC,CAAChB,KAAK,CAAC8B,qBAAqB,CAACN,GAAG,CAAC,CAClC,KACAA,GAAG,CAACC,IAAI,KAAK,EAAE,IAAI,CAACzB,KAAK,CAAC6B,yCAAyC,CAClEf,WACF,CAAC,IACDU,GAAG,CAACC,IAAI,KAAK,EAAE,IAAI,CAACzB,KAAK,CAAC6B,yCAAyC,CACjEf,WAAW,EACX,IACF,CAAC,CAAC,IACFiB,OAAO,CACL,CAAChB,gBAAgB,IAAI,CAACH,IAAI,IAC1B,EAAE,WAAW,KAAI,gDAAkDA,IAAI,CAAC,CAAC,IACzE,CAAC,CAAC,8EAAgFA,IAAI,EAAGoB,SAC3F,CAAC,EACD;IACAnB,MAAM,CAAC,UAAUM,OAAO,uEAAuE,CAAC;EAClG;AACF,CAAC,EAAE;EACDc,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,iGAAiG;MAC9GC,GAAG,EAAE;IACP,CAAC;IACDC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVzB,WAAW,EAAE;UACXhB,OAAO,EAAE,IAAI;UACb2B,IAAI,EAAE;QACR,CAAC;QACDV,gBAAgB,EAAE;UAChBU,IAAI,EAAE;QACR,CAAC;QACDT,oCAAoC,EAAE;UACpClB,OAAO,EAAE,KAAK;UACd2B,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAe,MAAA,CAAA/B,OAAA,GAAAA,OAAA,CAAAX,OAAA","ignoreList":[]}
+{"version":3,"file":"requireReturnsCheck.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/requireReturnsCheck.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {import('../iterateJsdoc.js').Settings} settings\n * @returns {boolean}\n */\nconst canSkip = (utils, settings) => {\n  const voidingTags = [\n    // An abstract function is by definition incomplete\n    // so it is perfectly fine if a return is documented but\n    // not present within the function.\n    // A subclass may inherit the doc and implement the\n    // missing return.\n    'abstract',\n    'virtual',\n\n    // A constructor function returns `this` by default, so may be `@returns`\n    //   tag indicating this but no explicit return\n    'class',\n    'constructor',\n    'interface',\n  ];\n\n  if (settings.mode === 'closure') {\n    // Structural Interface in GCC terms, equivalent to @interface tag as far as this rule is concerned\n    voidingTags.push('record');\n  }\n\n  return utils.hasATag(voidingTags) ||\n    utils.isConstructor() ||\n    utils.classHasTag('interface') ||\n    settings.mode === 'closure' && utils.classHasTag('record');\n};\n\n// eslint-disable-next-line complexity -- Temporary\nexport default iterateJsdoc(({\n  context,\n  node,\n  report,\n  settings,\n  utils,\n}) => {\n  const {\n    exemptAsync = true,\n    exemptGenerators = settings.mode === 'typescript',\n    reportMissingReturnForUndefinedTypes = false,\n  } = context.options[0] || {};\n\n  if (canSkip(utils, settings)) {\n    return;\n  }\n\n  if (exemptAsync && utils.isAsync()) {\n    return;\n  }\n\n  const tagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'returns',\n  }));\n  if (!tagName) {\n    return;\n  }\n\n  const tags = utils.getTags(tagName);\n\n  if (tags.length === 0) {\n    return;\n  }\n\n  if (tags.length > 1) {\n    report(`Found more than one @${tagName} declaration.`);\n\n    return;\n  }\n\n  const [\n    tag,\n  ] = tags;\n\n  const type = tag.type.trim();\n\n  // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#assertion-functions\n  if (/asserts\\s/v.test(type)) {\n    return;\n  }\n\n  const returnNever = type === 'never';\n\n  if (returnNever && utils.hasValueOrExecutorHasNonEmptyResolveValue(false)) {\n    report(`JSDoc @${tagName} declaration set with \"never\" but return expression is present in function.`);\n\n    return;\n  }\n\n  // In case a return value is declared in JSDoc, we also expect one in the code.\n  if (\n    !returnNever &&\n    (\n      reportMissingReturnForUndefinedTypes ||\n      !utils.mayBeUndefinedTypeTag(tag)\n    ) &&\n    (tag.type === '' && !utils.hasValueOrExecutorHasNonEmptyResolveValue(\n      exemptAsync,\n    ) ||\n    tag.type !== '' && !utils.hasValueOrExecutorHasNonEmptyResolveValue(\n      exemptAsync,\n      true,\n    )) &&\n    Boolean(\n      !exemptGenerators || !node ||\n      !('generator' in /** @type {import('../iterateJsdoc.js').Node} */ (node)) ||\n      !(/** @type {import('@typescript-eslint/types').TSESTree.FunctionDeclaration} */ (node)).generator,\n    )\n  ) {\n    report(`JSDoc @${tagName} declaration present but return expression not available in function.`);\n  }\n}, {\n  meta: {\n    docs: {\n      description: 'Requires a return statement in function body if a `@returns` tag is specified in jsdoc comment.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-check.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          exemptAsync: {\n            default: true,\n            type: 'boolean',\n          },\n          exemptGenerators: {\n            type: 'boolean',\n          },\n          reportMissingReturnForUndefinedTypes: {\n            default: false,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;AAOA,MAAM,UAAU,CAAC,OAAO,aAAa;CACnC,MAAM,cAAc;EAMlB;EACA;EAIA;EACA;EACA;CACD;AAED,KAAI,SAAS,SAAS,WAEpB,YAAY,KAAK,SAAS;AAG5B,QAAO,MAAM,QAAQ,YAAY,IAC/B,MAAM,eAAe,IACrB,MAAM,YAAY,YAAY,IAC9B,SAAS,SAAS,aAAa,MAAM,YAAY,SAAS;AAC7D;AAGD,kCAAeA,6BAAa,CAAC,EAC3B,SACA,MACA,QACA,UACA,OACD,KAAK;CACJ,MAAM,EACJ,cAAc,MACd,mBAAmB,SAAS,SAAS,cACrC,uCAAuC,OACxC,GAAG,QAAQ,QAAQ,MAAM,CAAE;AAE5B,KAAI,QAAQ,OAAO,SAAS,CAC1B;AAGF,KAAI,eAAe,MAAM,SAAS,CAChC;CAGF,MAAM,UAAiC,MAAM,oBAAoB,EAC/D,SAAS,UACV,EAAC;AACF,KAAI,CAAC,QACH;CAGF,MAAM,OAAO,MAAM,QAAQ,QAAQ;AAEnC,KAAI,KAAK,WAAW,EAClB;AAGF,KAAI,KAAK,SAAS,GAAG;EACnB,OAAO,CAAC,qBAAqB,EAAE,QAAQ,aAAa,CAAC,CAAC;AAEtD;CACD;CAED,MAAM,CACJ,IACD,GAAG;CAEJ,MAAM,OAAO,IAAI,KAAK,MAAM;AAG5B,KAAI,aAAa,KAAK,KAAK,CACzB;CAGF,MAAM,cAAc,SAAS;AAE7B,KAAI,eAAe,MAAM,0CAA0C,MAAM,EAAE;EACzE,OAAO,CAAC,OAAO,EAAE,QAAQ,2EAA2E,CAAC,CAAC;AAEtG;CACD;AAGD,KACE,CAAC,gBAEC,wCACA,CAAC,MAAM,sBAAsB,IAAI,MAElC,IAAI,SAAS,MAAM,CAAC,MAAM,0CACzB,YACD,IACD,IAAI,SAAS,MAAM,CAAC,MAAM,0CACxB,aACA,KACD,KACD,QACE,CAAC,oBAAoB,CAAC,QACtB,EAAE,eAAiE,SACnE,CAAkF,KAAO,UAC1F,EAED,OAAO,CAAC,OAAO,EAAE,QAAQ,qEAAqE,CAAC,CAAC;AAEnG,GAAE,EACD,MAAM;CACJ,MAAM;EACJ,aAAa;EACb,KAAK;CACN;CACD,QAAQ,CACN;EACE,sBAAsB;EACtB,YAAY;GACV,aAAa;IACX,SAAS;IACT,MAAM;GACP;GACD,kBAAkB,EAChB,MAAM,UACP;GACD,sCAAsC;IACpC,SAAS;IACT,MAAM;GACP;EACF;EACD,MAAM;CACP,CACF;CACD,MAAM;AACP,EACF,EAAC"}

package/dist/rules/requireReturnsCheck.js

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

package/dist/rules/requireReturnsCheck.js.map

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

package/dist/rules/requireReturnsDescription.cjs

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

package/dist/rules/requireReturnsDescription.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"requireReturnsDescription.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","_default","exports","iterateJsdoc","report","utils","forEachPreferredTag","jsdocTag","targetTagName","type","trim","includes","description","contextDefaults","meta","docs","url","schema","additionalProperties","properties","contexts","items","anyOf","comment","context","module"],"sources":["../../src/rules/requireReturnsDescription.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  report,\n  utils,\n}) => {\n  utils.forEachPreferredTag('returns', (jsdocTag, targetTagName) => {\n    const type = jsdocTag.type && jsdocTag.type.trim();\n\n    if ([\n      'Promise<undefined>', 'Promise<void>', 'undefined', 'void',\n    ].includes(type)) {\n      return;\n    }\n\n    if (!jsdocTag.description.trim()) {\n      report(`Missing JSDoc @${targetTagName} description.`, null, jsdocTag);\n    }\n  });\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that the `@returns` tag has a `description` value.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-description.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAF,OAAA,GAE/B,IAAAG,qBAAY,EAAC,CAAC;EAC3BC,MAAM;EACNC;AACF,CAAC,KAAK;EACJA,KAAK,CAACC,mBAAmB,CAAC,SAAS,EAAE,CAACC,QAAQ,EAAEC,aAAa,KAAK;IAChE,MAAMC,IAAI,GAAGF,QAAQ,CAACE,IAAI,IAAIF,QAAQ,CAACE,IAAI,CAACC,IAAI,CAAC,CAAC;IAElD,IAAI,CACF,oBAAoB,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,CAC3D,CAACC,QAAQ,CAACF,IAAI,CAAC,EAAE;MAChB;IACF;IAEA,IAAI,CAACF,QAAQ,CAACK,WAAW,CAACF,IAAI,CAAC,CAAC,EAAE;MAChCN,MAAM,CAAC,kBAAkBI,aAAa,eAAe,EAAE,IAAI,EAAED,QAAQ,CAAC;IACxE;EACF,CAAC,CAAC;AACJ,CAAC,EAAE;EACDM,eAAe,EAAE,IAAI;EACrBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJH,WAAW,EAAE,6DAA6D;MAC1EI,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;cACEb,IAAI,EAAE;YACR,CAAC,EACD;cACES,oBAAoB,EAAE,KAAK;cAC3BC,UAAU,EAAE;gBACVI,OAAO,EAAE;kBACPd,IAAI,EAAE;gBACR,CAAC;gBACDe,OAAO,EAAE;kBACPf,IAAI,EAAE;gBACR;cACF,CAAC;cACDA,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACDA,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAgB,MAAA,CAAAvB,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}
+{"version":3,"file":"requireReturnsDescription.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/requireReturnsDescription.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  report,\n  utils,\n}) => {\n  utils.forEachPreferredTag('returns', (jsdocTag, targetTagName) => {\n    const type = jsdocTag.type && jsdocTag.type.trim();\n\n    if ([\n      'Promise<undefined>', 'Promise<void>', 'undefined', 'void',\n    ].includes(type)) {\n      return;\n    }\n\n    if (!jsdocTag.description.trim()) {\n      report(`Missing JSDoc @${targetTagName} description.`, null, jsdocTag);\n    }\n  });\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that the `@returns` tag has a `description` value.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-description.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,wCAAeA,6BAAa,CAAC,EAC3B,QACA,OACD,KAAK;CACJ,MAAM,oBAAoB,WAAW,CAAC,UAAU,kBAAkB;EAChE,MAAM,OAAO,SAAS,QAAQ,SAAS,KAAK,MAAM;AAElD,MAAI;GACF;GAAsB;GAAiB;GAAa;EACrD,EAAC,SAAS,KAAK,CACd;AAGF,MAAI,CAAC,SAAS,YAAY,MAAM,EAC9B,OAAO,CAAC,eAAe,EAAE,cAAc,aAAa,CAAC,EAAE,MAAM,SAAS;CAEzE,EAAC;AACH,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,UAAU;IACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;KACE,sBAAsB;KACtB,YAAY;MACV,SAAS,EACP,MAAM,SACP;MACD,SAAS,EACP,MAAM,SACP;KACF;KACD,MAAM;IACP,CACF,EACF;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/requireReturnsDescription.js

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

package/dist/rules/requireReturnsDescription.js.map

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

package/dist/rules/requireReturnsType.cjs

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

package/dist/rules/requireReturnsType.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"requireReturnsType.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","_default","exports","iterateJsdoc","report","utils","forEachPreferredTag","jsdocTag","targetTagName","type","contextDefaults","meta","docs","description","url","schema","additionalProperties","properties","contexts","items","anyOf","comment","context","module"],"sources":["../../src/rules/requireReturnsType.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  report,\n  utils,\n}) => {\n  utils.forEachPreferredTag('returns', (jsdocTag, targetTagName) => {\n    if (!jsdocTag.type) {\n      report(`Missing JSDoc @${targetTagName} type.`, null, jsdocTag);\n    }\n  });\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that `@returns` tag has `type` value.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-type.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAF,OAAA,GAE/B,IAAAG,qBAAY,EAAC,CAAC;EAC3BC,MAAM;EACNC;AACF,CAAC,KAAK;EACJA,KAAK,CAACC,mBAAmB,CAAC,SAAS,EAAE,CAACC,QAAQ,EAAEC,aAAa,KAAK;IAChE,IAAI,CAACD,QAAQ,CAACE,IAAI,EAAE;MAClBL,MAAM,CAAC,kBAAkBI,aAAa,QAAQ,EAAE,IAAI,EAAED,QAAQ,CAAC;IACjE;EACF,CAAC,CAAC;AACJ,CAAC,EAAE;EACDG,eAAe,EAAE,IAAI;EACrBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,gDAAgD;MAC7DC,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;cACEX,IAAI,EAAE;YACR,CAAC,EACD;cACEO,oBAAoB,EAAE,KAAK;cAC3BC,UAAU,EAAE;gBACVI,OAAO,EAAE;kBACPZ,IAAI,EAAE;gBACR,CAAC;gBACDa,OAAO,EAAE;kBACPb,IAAI,EAAE;gBACR;cACF,CAAC;cACDA,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACDA,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAc,MAAA,CAAArB,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}
+{"version":3,"file":"requireReturnsType.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/requireReturnsType.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  report,\n  utils,\n}) => {\n  utils.forEachPreferredTag('returns', (jsdocTag, targetTagName) => {\n    if (!jsdocTag.type) {\n      report(`Missing JSDoc @${targetTagName} type.`, null, jsdocTag);\n    }\n  });\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that `@returns` tag has `type` value.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-type.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,iCAAeA,6BAAa,CAAC,EAC3B,QACA,OACD,KAAK;CACJ,MAAM,oBAAoB,WAAW,CAAC,UAAU,kBAAkB;AAChE,MAAI,CAAC,SAAS,MACZ,OAAO,CAAC,eAAe,EAAE,cAAc,MAAM,CAAC,EAAE,MAAM,SAAS;CAElE,EAAC;AACH,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,UAAU;IACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;KACE,sBAAsB;KACtB,YAAY;MACV,SAAS,EACP,MAAM,SACP;MACD,SAAS,EACP,MAAM,SACP;KACF;KACD,MAAM;IACP,CACF,EACF;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/requireReturnsType.js

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

package/dist/rules/requireReturnsType.js.map

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