eslint-plugin-jsdoc 63.3.3 → 64.0.0

package/dist/rules/requireTemplate.cjs

@@ -1,220 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-var _jsdoccomment = require("@es-joy/jsdoccomment");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  context,
-  node,
-  report,
-  settings,
-  utils
-}) => {
-  if (utils.avoidDocs()) {
-    return;
-  }
-  const {
-    requireSeparateTemplates = false
-  } = context.options[0] || {};
-  const {
-    mode
-  } = settings;
-  const usedNames = new Set();
-  const tgName = /** @type {string} */utils.getPreferredTagName({
-    tagName: 'template'
-  });
-  if (!tgName) {
-    return;
-  }
-  const templateTags = utils.getTags(tgName);
-  const templateNames = templateTags.flatMap(tag => {
-    return utils.parseClosureTemplateTag(tag);
-  });
-  if (requireSeparateTemplates) {
-    for (const tag of templateTags) {
-      const names = utils.parseClosureTemplateTag(tag);
-      if (names.length > 1) {
-        report(`Missing separate @${tgName} for ${names[1]}`, null, tag);
-      }
-    }
-  }
-
-  /**
-   * @param {import('@typescript-eslint/types').TSESTree.FunctionDeclaration|
-   *   import('@typescript-eslint/types').TSESTree.ClassDeclaration|
-   *   import('@typescript-eslint/types').TSESTree.TSDeclareFunction|
-   *   import('@typescript-eslint/types').TSESTree.TSInterfaceDeclaration|
-   *   import('@typescript-eslint/types').TSESTree.TSTypeAliasDeclaration} aliasDeclaration
-   */
-  const checkTypeParams = aliasDeclaration => {
-    const {
-      params
-      /* c8 ignore next -- Guard */
-    } = aliasDeclaration.typeParameters ?? {
-      /* c8 ignore next -- Guard */
-      params: []
-    };
-    for (const {
-      name: {
-        name
-      }
-    } of params) {
-      usedNames.add(name);
-    }
-    for (const usedName of usedNames) {
-      if (!templateNames.includes(usedName)) {
-        report(`Missing @${tgName} ${usedName}`);
-      }
-    }
-  };
-  const handleTypes = () => {
-    const nde = /** @type {import('@typescript-eslint/types').TSESTree.Node} */
-    node;
-    if (!nde) {
-      return;
-    }
-    switch (nde.type) {
-      case 'ClassDeclaration':
-      case 'FunctionDeclaration':
-      case 'TSDeclareFunction':
-      case 'TSInterfaceDeclaration':
-      case 'TSTypeAliasDeclaration':
-        checkTypeParams(nde);
-        break;
-      case 'ExportDefaultDeclaration':
-        switch (nde.declaration?.type) {
-          case 'ClassDeclaration':
-          case 'FunctionDeclaration':
-          case 'TSInterfaceDeclaration':
-            checkTypeParams(nde.declaration);
-            break;
-        }
-        break;
-      case 'ExportNamedDeclaration':
-        switch (nde.declaration?.type) {
-          case 'ClassDeclaration':
-          case 'FunctionDeclaration':
-          case 'TSDeclareFunction':
-          case 'TSInterfaceDeclaration':
-          case 'TSTypeAliasDeclaration':
-            checkTypeParams(nde.declaration);
-            break;
-        }
-        break;
-    }
-  };
-  const usedNameToTag = new Map();
-
-  /**
-   * @param {import('comment-parser').Spec} potentialTag
-   */
-  const checkForUsedTypes = potentialTag => {
-    let parsedType;
-    try {
-      parsedType = mode === 'permissive' ? (0, _jsdoccomment.tryParse)(/** @type {string} */potentialTag.type) : (0, _jsdoccomment.parse)(/** @type {string} */potentialTag.type, mode);
-    } catch {
-      return;
-    }
-    (0, _jsdoccomment.traverse)(parsedType, nde => {
-      if (nde.type === 'JsdocTypeTypeParameter') {
-        templateNames.push(nde.name.value);
-        return;
-      }
-      if (nde.type === 'JsdocTypeInfer') {
-        templateNames.push(nde.element.value);
-        return;
-      }
-      const {
-        type,
-        value
-      } = /** @type {import('jsdoc-type-pratt-parser').NameResult} */nde;
-      if (type === 'JsdocTypeName' && /^[A-Z]$/v.test(value)) {
-        usedNames.add(value);
-        if (!usedNameToTag.has(value)) {
-          usedNameToTag.set(value, potentialTag);
-        }
-      }
-    });
-  };
-
-  /**
-   * @param {string[]} tagNames
-   */
-  const checkTagsAndTemplates = tagNames => {
-    for (const tagName of tagNames) {
-      const preferredTagName = /** @type {string} */utils.getPreferredTagName({
-        tagName
-      });
-      const matchingTags = utils.getTags(preferredTagName);
-      for (const matchingTag of matchingTags) {
-        checkForUsedTypes(matchingTag);
-      }
-    }
-
-    // Could check against whitelist/blacklist
-    for (const usedName of usedNames) {
-      if (!templateNames.includes(usedName)) {
-        report(`Missing @${tgName} ${usedName}`, null, usedNameToTag.get(usedName));
-      }
-    }
-  };
-  const callbackTags = utils.getTags('callback');
-  const functionTags = utils.getTags('function');
-  if (callbackTags.length || functionTags.length) {
-    checkTagsAndTemplates(['param', 'returns']);
-    return;
-  }
-  const typedefTags = utils.getTags('typedef');
-  if (!typedefTags.length || typedefTags.length >= 2) {
-    handleTypes();
-    return;
-  }
-  const potentialTypedef = typedefTags[0];
-  checkForUsedTypes(potentialTypedef);
-  checkTagsAndTemplates(['property']);
-}, {
-  iterateAllJsdocs: true,
-  meta: {
-    docs: {
-      description: 'Requires `@template` tags be present when type parameters are used.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-template.md#repos-sticky-header'
-    },
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        exemptedBy: {
-          description: `Array of tags (e.g., \`['type']\`) whose presence on the document
-block avoids the need for a \`@template\`. Defaults to an array with
-\`inheritdoc\`. If you set this array, it will overwrite the default,
-so be sure to add back \`inheritdoc\` if you wish its presence to cause
-exemption of the rule.`,
-          items: {
-            type: 'string'
-          },
-          type: 'array'
-        },
-        requireSeparateTemplates: {
-          description: `Requires that each template have its own separate line, i.e., preventing
-templates of this format:
-
-\`\`\`js
-/**
- * @template T, U, V
- */
-\`\`\`
-
-Defaults to \`false\`.`,
-          type: 'boolean'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'suggestion'
-  }
-});
-module.exports = exports.default;
-//# sourceMappingURL=requireTemplate.cjs.map

package/dist/rules/requireTemplate.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireTemplate.cjs","names":["iterateJsdoc","tryParseType","parseType","traverse"],"sources":["../../src/rules/requireTemplate.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  parse as parseType,\n  traverse,\n  tryParse as tryParseType,\n} from '@es-joy/jsdoccomment';\n\nexport default iterateJsdoc(({\n  context,\n  node,\n  report,\n  settings,\n  utils,\n}) => {\n  if (utils.avoidDocs()) {\n    return;\n  }\n\n  const {\n    requireSeparateTemplates = false,\n  } = context.options[0] || {};\n\n  const {\n    mode,\n  } = settings;\n\n  const usedNames = new Set();\n\n  const tgName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'template',\n  }));\n  if (!tgName) {\n    return;\n  }\n\n  const templateTags = utils.getTags(tgName);\n\n  const templateNames = templateTags.flatMap((tag) => {\n    return utils.parseClosureTemplateTag(tag);\n  });\n\n  if (requireSeparateTemplates) {\n    for (const tag of templateTags) {\n      const names = utils.parseClosureTemplateTag(tag);\n      if (names.length > 1) {\n        report(`Missing separate @${tgName} for ${names[1]}`, null, tag);\n      }\n    }\n  }\n\n  /**\n   * @param {import('@typescript-eslint/types').TSESTree.FunctionDeclaration|\n   *   import('@typescript-eslint/types').TSESTree.ClassDeclaration|\n   *   import('@typescript-eslint/types').TSESTree.TSDeclareFunction|\n   *   import('@typescript-eslint/types').TSESTree.TSInterfaceDeclaration|\n   *   import('@typescript-eslint/types').TSESTree.TSTypeAliasDeclaration} aliasDeclaration\n   */\n  const checkTypeParams = (aliasDeclaration) => {\n    const {\n      params,\n      /* c8 ignore next -- Guard */\n    } = aliasDeclaration.typeParameters ?? {\n      /* c8 ignore next -- Guard */\n      params: [],\n    };\n    for (const {\n      name: {\n        name,\n      },\n    } of params) {\n      usedNames.add(name);\n    }\n\n    for (const usedName of usedNames) {\n      if (!templateNames.includes(usedName)) {\n        report(`Missing @${tgName} ${usedName}`);\n      }\n    }\n  };\n\n  const handleTypes = () => {\n    const nde = /** @type {import('@typescript-eslint/types').TSESTree.Node} */ (\n      node\n    );\n    if (!nde) {\n      return;\n    }\n\n    switch (nde.type) {\n      case 'ClassDeclaration':\n      case 'FunctionDeclaration':\n      case 'TSDeclareFunction':\n      case 'TSInterfaceDeclaration':\n      case 'TSTypeAliasDeclaration':\n        checkTypeParams(nde);\n        break;\n      case 'ExportDefaultDeclaration':\n        switch (nde.declaration?.type) {\n          case 'ClassDeclaration':\n          case 'FunctionDeclaration':\n          case 'TSInterfaceDeclaration':\n            checkTypeParams(nde.declaration);\n            break;\n        }\n\n        break;\n      case 'ExportNamedDeclaration':\n        switch (nde.declaration?.type) {\n          case 'ClassDeclaration':\n          case 'FunctionDeclaration':\n          case 'TSDeclareFunction':\n          case 'TSInterfaceDeclaration':\n          case 'TSTypeAliasDeclaration':\n            checkTypeParams(nde.declaration);\n            break;\n        }\n\n        break;\n    }\n  };\n\n  const usedNameToTag = new Map();\n\n  /**\n   * @param {import('comment-parser').Spec} potentialTag\n   */\n  const checkForUsedTypes = (potentialTag) => {\n    let parsedType;\n    try {\n      parsedType = mode === 'permissive' ?\n        tryParseType(/** @type {string} */ (potentialTag.type)) :\n        parseType(/** @type {string} */ (potentialTag.type), mode);\n    } catch {\n      return;\n    }\n\n    traverse(parsedType, (nde) => {\n      if (nde.type === 'JsdocTypeTypeParameter') {\n        templateNames.push(nde.name.value);\n        return;\n      }\n\n      if (nde.type === 'JsdocTypeInfer') {\n        templateNames.push(nde.element.value);\n        return;\n      }\n\n      const {\n        type,\n        value,\n      } = /** @type {import('jsdoc-type-pratt-parser').NameResult} */ (nde);\n\n      if (type === 'JsdocTypeName' && (/^[A-Z]$/v).test(value)) {\n        usedNames.add(value);\n        if (!usedNameToTag.has(value)) {\n          usedNameToTag.set(value, potentialTag);\n        }\n      }\n    });\n  };\n\n  /**\n   * @param {string[]} tagNames\n   */\n  const checkTagsAndTemplates = (tagNames) => {\n    for (const tagName of tagNames) {\n      const preferredTagName = /** @type {string} */ (utils.getPreferredTagName({\n        tagName,\n      }));\n      const matchingTags = utils.getTags(preferredTagName);\n      for (const matchingTag of matchingTags) {\n        checkForUsedTypes(matchingTag);\n      }\n    }\n\n    // Could check against whitelist/blacklist\n    for (const usedName of usedNames) {\n      if (!templateNames.includes(usedName)) {\n        report(`Missing @${tgName} ${usedName}`, null, usedNameToTag.get(usedName));\n      }\n    }\n  };\n\n  const callbackTags = utils.getTags('callback');\n  const functionTags = utils.getTags('function');\n  if (callbackTags.length || functionTags.length) {\n    checkTagsAndTemplates([\n      'param', 'returns',\n    ]);\n    return;\n  }\n\n  const typedefTags = utils.getTags('typedef');\n  if (!typedefTags.length || typedefTags.length >= 2) {\n    handleTypes();\n    return;\n  }\n\n  const potentialTypedef = typedefTags[0];\n  checkForUsedTypes(potentialTypedef);\n\n  checkTagsAndTemplates([\n    'property',\n  ]);\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Requires `@template` tags be present when type parameters are used.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-template.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          exemptedBy: {\n            description: `Array of tags (e.g., \\`['type']\\`) whose presence on the document\nblock avoids the need for a \\`@template\\`. Defaults to an array with\n\\`inheritdoc\\`. If you set this array, it will overwrite the default,\nso be sure to add back \\`inheritdoc\\` if you wish its presence to cause\nexemption of the rule.`,\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          requireSeparateTemplates: {\n            description: `Requires that each template have its own separate line, i.e., preventing\ntemplates of this format:\n\n\\`\\`\\`js\n/**\n * @template T, U, V\n */\n\\`\\`\\`\n\nDefaults to \\`false\\`.`,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA;AACA;AAI8B;AAAA,iCAEf,IAAAA,qBAAY,EAAC,CAAC;EAC3B,OAAO;EACP,IAAI;EACJ,MAAM;EACN,QAAQ;EACR;AACF,CAAC,KAAK;EACJ,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE;IACrB;EACF;EAEA,MAAM;IACJ,wBAAwB,GAAG;EAC7B,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,MAAM;IACJ;EACF,CAAC,GAAG,QAAQ;EAEZ,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC;EAE3B,MAAM,MAAM,GAAG,qBAAuB,KAAK,CAAC,mBAAmB,CAAC;IAC9D,OAAO,EAAE;EACX,CAAC,CAAE;EACH,IAAI,CAAC,MAAM,EAAE;IACX;EACF;EAEA,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;EAE1C,MAAM,aAAa,GAAG,YAAY,CAAC,OAAO,CAAE,GAAG,IAAK;IAClD,OAAO,KAAK,CAAC,uBAAuB,CAAC,GAAG,CAAC;EAC3C,CAAC,CAAC;EAEF,IAAI,wBAAwB,EAAE;IAC5B,KAAK,MAAM,GAAG,IAAI,YAAY,EAAE;MAC9B,MAAM,KAAK,GAAG,KAAK,CAAC,uBAAuB,CAAC,GAAG,CAAC;MAChD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;QACpB,MAAM,CAAC,qBAAqB,MAAM,QAAQ,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC;MAClE;IACF;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACE,MAAM,eAAe,GAAI,gBAAgB,IAAK;IAC5C,MAAM;MACJ;MACA;IACF,CAAC,GAAG,gBAAgB,CAAC,cAAc,IAAI;MACrC;MACA,MAAM,EAAE;IACV,CAAC;IACD,KAAK,MAAM;MACT,IAAI,EAAE;QACJ;MACF;IACF,CAAC,IAAI,MAAM,EAAE;MACX,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC;IACrB;IAEA,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;MAChC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;QACrC,MAAM,CAAC,YAAY,MAAM,IAAI,QAAQ,EAAE,CAAC;MAC1C;IACF;EACF,CAAC;EAED,MAAM,WAAW,GAAG,MAAM;IACxB,MAAM,GAAG,GAAG;IACV,IACD;IACD,IAAI,CAAC,GAAG,EAAE;MACR;IACF;IAEA,QAAQ,GAAG,CAAC,IAAI;MACd,KAAK,kBAAkB;MACvB,KAAK,qBAAqB;MAC1B,KAAK,mBAAmB;MACxB,KAAK,wBAAwB;MAC7B,KAAK,wBAAwB;QAC3B,eAAe,CAAC,GAAG,CAAC;QACpB;MACF,KAAK,0BAA0B;QAC7B,QAAQ,GAAG,CAAC,WAAW,EAAE,IAAI;UAC3B,KAAK,kBAAkB;UACvB,KAAK,qBAAqB;UAC1B,KAAK,wBAAwB;YAC3B,eAAe,CAAC,GAAG,CAAC,WAAW,CAAC;YAChC;QACJ;QAEA;MACF,KAAK,wBAAwB;QAC3B,QAAQ,GAAG,CAAC,WAAW,EAAE,IAAI;UAC3B,KAAK,kBAAkB;UACvB,KAAK,qBAAqB;UAC1B,KAAK,mBAAmB;UACxB,KAAK,wBAAwB;UAC7B,KAAK,wBAAwB;YAC3B,eAAe,CAAC,GAAG,CAAC,WAAW,CAAC;YAChC;QACJ;QAEA;IACJ;EACF,CAAC;EAED,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,CAAC;;EAE/B;AACF;AACA;EACE,MAAM,iBAAiB,GAAI,YAAY,IAAK;IAC1C,IAAI,UAAU;IACd,IAAI;MACF,UAAU,GAAG,IAAI,KAAK,YAAY,GAChC,IAAAC,sBAAY,EAAC,qBAAuB,YAAY,CAAC,IAAK,CAAC,GACvD,IAAAC,mBAAS,EAAC,qBAAuB,YAAY,CAAC,IAAI,EAAG,IAAI,CAAC;IAC9D,CAAC,CAAC,MAAM;MACN;IACF;IAEA,IAAAC,cAAA,QAAQ,EAAC,UAAU,EAAG,GAAG,IAAK;MAC5B,IAAI,GAAG,CAAC,IAAI,KAAK,wBAAwB,EAAE;QACzC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC;QAClC;MACF;MAEA,IAAI,GAAG,CAAC,IAAI,KAAK,gBAAgB,EAAE;QACjC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC;QACrC;MACF;MAEA,MAAM;QACJ,IAAI;QACJ;MACF,CAAC,GAAG,2DAA6D,GAAI;MAErE,IAAI,IAAI,KAAK,eAAe,IAAK,UAAU,CAAE,IAAI,CAAC,KAAK,CAAC,EAAE;QACxD,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC;QACpB,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;UAC7B,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,YAAY,CAAC;QACxC;MACF;IACF,CAAC,CAAC;EACJ,CAAC;;EAED;AACF;AACA;EACE,MAAM,qBAAqB,GAAI,QAAQ,IAAK;IAC1C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;MAC9B,MAAM,gBAAgB,GAAG,qBAAuB,KAAK,CAAC,mBAAmB,CAAC;QACxE;MACF,CAAC,CAAE;MACH,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC;MACpD,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;QACtC,iBAAiB,CAAC,WAAW,CAAC;MAChC;IACF;;IAEA;IACA,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;MAChC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;QACrC,MAAM,CAAC,YAAY,MAAM,IAAI,QAAQ,EAAE,EAAE,IAAI,EAAE,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;MAC7E;IACF;EACF,CAAC;EAED,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC;EAC9C,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC;EAC9C,IAAI,YAAY,CAAC,MAAM,IAAI,YAAY,CAAC,MAAM,EAAE;IAC9C,qBAAqB,CAAC,CACpB,OAAO,EAAE,SAAS,CACnB,CAAC;IACF;EACF;EAEA,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC;EAC5C,IAAI,CAAC,WAAW,CAAC,MAAM,IAAI,WAAW,CAAC,MAAM,IAAI,CAAC,EAAE;IAClD,WAAW,CAAC,CAAC;IACb;EACF;EAEA,MAAM,gBAAgB,GAAG,WAAW,CAAC,CAAC,CAAC;EACvC,iBAAiB,CAAC,gBAAgB,CAAC;EAEnC,qBAAqB,CAAC,CACpB,UAAU,CACX,CAAC;AACJ,CAAC,EAAE;EACD,gBAAgB,EAAE,IAAI;EACtB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,qEAAqE;MAClF,GAAG,EAAE;IACP,CAAC;IACD,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,UAAU,EAAE;UACV,WAAW,EAAE;AACzB;AACA;AACA;AACA,uBAAuB;UACX,KAAK,EAAE;YACL,IAAI,EAAE;UACR,CAAC;UACD,IAAI,EAAE;QACR,CAAC;QACD,wBAAwB,EAAE;UACxB,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,uBAAuB;UACX,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}

package/dist/rules/requireThrows.cjs

@@ -1,118 +0,0 @@
-"use strict";
-
-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 throws value, in case the documentation is inherited
- * or the method is either a constructor or an abstract method.
- * @param {import('../iterateJsdoc.js').Utils} utils a reference to the utils which are used to probe if a tag is present or not.
- * @returns {boolean} true in case deep checking can be skipped; otherwise false.
- */
-const canSkip = utils => {
-  return utils.hasATag([
-  // inheritdoc implies that all documentation is inherited
-  // see https://jsdoc.app/tags-inheritdoc.html
-  //
-  // Abstract methods are by definition incomplete,
-  // so it is not necessary to document that they throw an error.
-  'abstract', 'virtual',
-  // The designated type can itself document `@throws`
-  'type']) || utils.avoidDocs(false);
-};
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  report,
-  utils
-}) => {
-  // A preflight check. We do not need to run a deep check for abstract
-  //  functions.
-  if (canSkip(utils)) {
-    return;
-  }
-  const tagName = /** @type {string} */utils.getPreferredTagName({
-    tagName: 'throws'
-  });
-  if (!tagName) {
-    return;
-  }
-  const tags = utils.getTags(tagName);
-  const iteratingFunction = utils.isIteratingFunction();
-
-  // In case the code returns something, we expect a return value in JSDoc.
-  const [tag] = tags;
-  const missingThrowsTag = typeof tag === 'undefined' || tag === null;
-  const shouldReport = () => {
-    if (!missingThrowsTag) {
-      if (tag.type.trim() === 'never' && iteratingFunction && utils.hasThrowValue()) {
-        report(`JSDoc @${tagName} declaration set to "never" but throw value found.`);
-      }
-      return false;
-    }
-    return iteratingFunction && utils.hasThrowValue();
-  };
-  if (shouldReport()) {
-    report(`Missing JSDoc @${tagName} declaration.`);
-  }
-}, {
-  contextDefaults: true,
-  meta: {
-    docs: {
-      description: 'Requires that throw statements are documented with `@throws` tags.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws.md#repos-sticky-header'
-    },
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        contexts: {
-          description: `Set this to an array of strings representing the AST context
-(or objects with optional \`context\` and \`comment\` properties) where you wish
-the rule to be applied.
-
-\`context\` defaults to \`any\` and \`comment\` defaults to no specific comment context.
-
-Overrides the default contexts (\`ArrowFunctionExpression\`, \`FunctionDeclaration\`,
-\`FunctionExpression\`). Set to \`"any"\` if you want
-the rule to apply to any JSDoc block throughout your files (as is necessary
-for finding function blocks not attached to a function declaration or
-expression, i.e., \`@callback\` or \`@function\` (or its aliases \`@func\` or
-\`@method\`) (including those associated with an \`@interface\`).`,
-          items: {
-            anyOf: [{
-              type: 'string'
-            }, {
-              additionalProperties: false,
-              properties: {
-                comment: {
-                  type: 'string'
-                },
-                context: {
-                  type: 'string'
-                }
-              },
-              type: 'object'
-            }]
-          },
-          type: 'array'
-        },
-        exemptedBy: {
-          description: `Array of tags (e.g., \`['type']\`) whose presence on the
-document block avoids the need for a \`@throws\`. Defaults to an array
-with \`inheritdoc\`. If you set this array, it will overwrite the default,
-so be sure to add back \`inheritdoc\` if you wish its presence to cause
-exemption of the rule.`,
-          items: {
-            type: 'string'
-          },
-          type: 'array'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'suggestion'
-  }
-});
-module.exports = exports.default;
-//# sourceMappingURL=requireThrows.cjs.map

package/dist/rules/requireThrows.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"requireThrows.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/requireThrows.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * We can skip checking for a throws value, in case the documentation is inherited\n * or the method is either a constructor or an abstract method.\n * @param {import('../iterateJsdoc.js').Utils} utils a reference to the utils which are used to probe if a tag is present or not.\n * @returns {boolean} true in case deep checking can be skipped; otherwise false.\n */\nconst canSkip = (utils) => {\n  return utils.hasATag([\n    // inheritdoc implies that all documentation is inherited\n    // see https://jsdoc.app/tags-inheritdoc.html\n    //\n    // Abstract methods are by definition incomplete,\n    // so it is not necessary to document that they throw an error.\n    'abstract',\n    'virtual',\n\n    // The designated type can itself document `@throws`\n    'type',\n  ]) ||\n    utils.avoidDocs(false);\n};\n\nexport default iterateJsdoc(({\n  report,\n  utils,\n}) => {\n  // A preflight check. We do not need to run a deep check for abstract\n  //  functions.\n  if (canSkip(utils)) {\n    return;\n  }\n\n  const tagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'throws',\n  }));\n  if (!tagName) {\n    return;\n  }\n\n  const tags = utils.getTags(tagName);\n  const iteratingFunction = utils.isIteratingFunction();\n\n  // In case the code returns something, we expect a return value in JSDoc.\n  const [\n    tag,\n  ] = tags;\n  const missingThrowsTag = typeof tag === 'undefined' || tag === null;\n\n  const shouldReport = () => {\n    if (!missingThrowsTag) {\n      if (tag.type.trim() === 'never' && iteratingFunction && utils.hasThrowValue()) {\n        report(`JSDoc @${tagName} declaration set to \"never\" but throw value found.`);\n      }\n\n      return false;\n    }\n\n    return iteratingFunction && utils.hasThrowValue();\n  };\n\n  if (shouldReport()) {\n    report(`Missing JSDoc @${tagName} declaration.`);\n  }\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that throw statements are documented with `@throws` tags.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          contexts: {\n            description: `Set this to an array of strings representing the AST context\n(or objects with optional \\`context\\` and \\`comment\\` properties) where you wish\nthe rule to be applied.\n\n\\`context\\` defaults to \\`any\\` and \\`comment\\` defaults to no specific comment context.\n\nOverrides the default contexts (\\`ArrowFunctionExpression\\`, \\`FunctionDeclaration\\`,\n\\`FunctionExpression\\`). Set to \\`\"any\"\\` if you want\nthe rule to apply to any JSDoc block throughout your files (as is necessary\nfor finding function blocks not attached to a function declaration or\nexpression, i.e., \\`@callback\\` or \\`@function\\` (or its aliases \\`@func\\` or\n\\`@method\\`) (including those associated with an \\`@interface\\`).`,\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            description: `Array of tags (e.g., \\`['type']\\`) whose presence on the\ndocument block avoids the need for a \\`@throws\\`. Defaults to an array\nwith \\`inheritdoc\\`. If you set this array, it will overwrite the default,\nso be sure to add back \\`inheritdoc\\` if you wish its presence to cause\nexemption of the rule.`,\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA;AAA8C;AAE9C;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,OAAO,GAAI,KAAK,IAAK;EACzB,OAAO,KAAK,CAAC,OAAO,CAAC;EACnB;EACA;EACA;EACA;EACA;EACA,UAAU,EACV,SAAS;EAET;EACA,MAAM,CACP,CAAC,IACA,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC;AAC1B,CAAC;AAAC,iCAEa,IAAAA,qBAAY,EAAC,CAAC;EAC3B,MAAM;EACN;AACF,CAAC,KAAK;EACJ;EACA;EACA,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE;IAClB;EACF;EAEA,MAAM,OAAO,GAAG,qBAAuB,KAAK,CAAC,mBAAmB,CAAC;IAC/D,OAAO,EAAE;EACX,CAAC,CAAE;EACH,IAAI,CAAC,OAAO,EAAE;IACZ;EACF;EAEA,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;EACnC,MAAM,iBAAiB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;;EAErD;EACA,MAAM,CACJ,GAAG,CACJ,GAAG,IAAI;EACR,MAAM,gBAAgB,GAAG,OAAO,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI;EAEnE,MAAM,YAAY,GAAG,MAAM;IACzB,IAAI,CAAC,gBAAgB,EAAE;MACrB,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,OAAO,IAAI,iBAAiB,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC,EAAE;QAC7E,MAAM,CAAC,UAAU,OAAO,oDAAoD,CAAC;MAC/E;MAEA,OAAO,KAAK;IACd;IAEA,OAAO,iBAAiB,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;EACnD,CAAC;EAED,IAAI,YAAY,CAAC,CAAC,EAAE;IAClB,MAAM,CAAC,kBAAkB,OAAO,eAAe,CAAC;EAClD;AACF,CAAC,EAAE;EACD,eAAe,EAAE,IAAI;EACrB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,oEAAoE;MACjF,GAAG,EAAE;IACP,CAAC;IACD,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,QAAQ,EAAE;UACR,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,kEAAkE;UACtD,KAAK,EAAE;YACL,KAAK,EAAE,CACL;cACE,IAAI,EAAE;YACR,CAAC,EACD;cACE,oBAAoB,EAAE,KAAK;cAC3B,UAAU,EAAE;gBACV,OAAO,EAAE;kBACP,IAAI,EAAE;gBACR,CAAC;gBACD,OAAO,EAAE;kBACP,IAAI,EAAE;gBACR;cACF,CAAC;cACD,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACD,IAAI,EAAE;QACR,CAAC;QACD,UAAU,EAAE;UACV,WAAW,EAAE;AACzB;AACA;AACA;AACA,uBAAuB;UACX,KAAK,EAAE;YACL,IAAI,EAAE;UACR,CAAC;UACD,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}

package/dist/rules/requireYields.cjs

@@ -1,224 +0,0 @@
-"use strict";
-
-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([
-  // 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]}
- */
-const checkTagName = (utils, report, tagName) => {
-  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 _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 with `@yields` tags.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields.md#repos-sticky-header'
-    },
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        contexts: {
-          description: `Set this to an array of strings representing the AST context
-(or objects with optional \`context\` and \`comment\` properties) where you wish
-the rule to be applied.
-
-\`context\` defaults to \`any\` and \`comment\` defaults to no specific comment context.
-
-Overrides the default contexts (\`ArrowFunctionExpression\`, \`FunctionDeclaration\`,
-\`FunctionExpression\`). Set to \`"any"\` if you want
-the rule to apply to any JSDoc block throughout your files (as is necessary
-for finding function blocks not attached to a function declaration or
-expression, i.e., \`@callback\` or \`@function\` (or its aliases \`@func\` or
-\`@method\`) (including those associated with an \`@interface\`). This
-rule will only apply on non-default contexts when there is such a tag
-present and the \`forceRequireYields\` option is set or if the
-\`withGeneratorTag\` option is set with a present \`@generator\` tag
-(since we are not checking against the actual \`yield\` values in these
-cases).`,
-          items: {
-            anyOf: [{
-              type: 'string'
-            }, {
-              additionalProperties: false,
-              properties: {
-                comment: {
-                  type: 'string'
-                },
-                context: {
-                  type: 'string'
-                }
-              },
-              type: 'object'
-            }]
-          },
-          type: 'array'
-        },
-        exemptedBy: {
-          description: `Array of tags (e.g., \`['type']\`) whose presence on the
-document block avoids the need for a \`@yields\`. Defaults to an array
-with \`inheritdoc\`. If you set this array, it will overwrite the default,
-so be sure to add back \`inheritdoc\` if you wish its presence to cause
-exemption of the rule.`,
-          items: {
-            type: 'string'
-          },
-          type: 'array'
-        },
-        forceRequireNext: {
-          default: false,
-          description: `Set to \`true\` to always insist on
-\`@next\` documentation even if there are no \`yield\` statements in the
-function or none return values. May be desired to flag that a project is
-aware of the expected yield return being \`undefined\`. Defaults to \`false\`.`,
-          type: 'boolean'
-        },
-        forceRequireYields: {
-          default: false,
-          description: `Set to \`true\` to always insist on
-\`@yields\` documentation for generators even if there are only
-expressionless \`yield\` statements in the function. May be desired to flag
-that a project is aware of an \`undefined\`/\`void\` yield. Defaults to
-\`false\`.`,
-          type: 'boolean'
-        },
-        next: {
-          default: false,
-          description: `If \`true\`, this option will insist that any use of a \`yield\` return
-value (e.g., \`const rv = yield;\` or \`const rv = yield value;\`) has a
-(non-standard) \`@next\` tag (in addition to any \`@yields\` tag) so as to be
-able to document the type expected to be supplied into the iterator
-(the \`Generator\` iterator that is returned by the call to the generator
-function) to the iterator (e.g., \`it.next(value)\`). The tag will not be
-expected if the generator function body merely has plain \`yield;\` or
-\`yield value;\` statements without returning the values. Defaults to
-\`false\`.`,
-          type: 'boolean'
-        },
-        nextWithGeneratorTag: {
-          default: false,
-          description: `If a \`@generator\` tag is present on a block, require
-(non-standard ) \`@next\` (see \`next\` option). This will require using \`void\`
-or \`undefined\` in cases where generators do not use the \`next()\`-supplied
-incoming \`yield\`-returned value. Defaults to \`false\`. See \`contexts\` to
-\`any\` if you want to catch \`@generator\` with \`@callback\` or such not
-attached to a function.`,
-          type: 'boolean'
-        },
-        withGeneratorTag: {
-          default: true,
-          description: `If a \`@generator\` tag is present on a block, require
-\`@yields\`/\`@yield\`. Defaults to \`true\`. See \`contexts\` to \`any\` if you want
-to catch \`@generator\` with \`@callback\` or such not attached to a function.`,
-          type: 'boolean'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'suggestion'
-  }
-});
-module.exports = exports.default;
-//# sourceMappingURL=requireYields.cjs.map

package/dist/rules/requireYields.cjs.map

@@ -1 +0,0 @@
-{"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 with `@yields` tags.',\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            description: `Set this to an array of strings representing the AST context\n(or objects with optional \\`context\\` and \\`comment\\` properties) where you wish\nthe rule to be applied.\n\n\\`context\\` defaults to \\`any\\` and \\`comment\\` defaults to no specific comment context.\n\nOverrides the default contexts (\\`ArrowFunctionExpression\\`, \\`FunctionDeclaration\\`,\n\\`FunctionExpression\\`). Set to \\`\"any\"\\` if you want\nthe rule to apply to any JSDoc block throughout your files (as is necessary\nfor finding function blocks not attached to a function declaration or\nexpression, i.e., \\`@callback\\` or \\`@function\\` (or its aliases \\`@func\\` or\n\\`@method\\`) (including those associated with an \\`@interface\\`). This\nrule will only apply on non-default contexts when there is such a tag\npresent and the \\`forceRequireYields\\` option is set or if the\n\\`withGeneratorTag\\` option is set with a present \\`@generator\\` tag\n(since we are not checking against the actual \\`yield\\` values in these\ncases).`,\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            description: `Array of tags (e.g., \\`['type']\\`) whose presence on the\ndocument block avoids the need for a \\`@yields\\`. Defaults to an array\nwith \\`inheritdoc\\`. If you set this array, it will overwrite the default,\nso be sure to add back \\`inheritdoc\\` if you wish its presence to cause\nexemption of the rule.`,\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          forceRequireNext: {\n            default: false,\n            description: `Set to \\`true\\` to always insist on\n\\`@next\\` documentation even if there are no \\`yield\\` statements in the\nfunction or none return values. May be desired to flag that a project is\naware of the expected yield return being \\`undefined\\`. Defaults to \\`false\\`.`,\n            type: 'boolean',\n          },\n          forceRequireYields: {\n            default: false,\n            description: `Set to \\`true\\` to always insist on\n\\`@yields\\` documentation for generators even if there are only\nexpressionless \\`yield\\` statements in the function. May be desired to flag\nthat a project is aware of an \\`undefined\\`/\\`void\\` yield. Defaults to\n\\`false\\`.`,\n            type: 'boolean',\n          },\n          next: {\n            default: false,\n            description: `If \\`true\\`, this option will insist that any use of a \\`yield\\` return\nvalue (e.g., \\`const rv = yield;\\` or \\`const rv = yield value;\\`) has a\n(non-standard) \\`@next\\` tag (in addition to any \\`@yields\\` tag) so as to be\nable to document the type expected to be supplied into the iterator\n(the \\`Generator\\` iterator that is returned by the call to the generator\nfunction) to the iterator (e.g., \\`it.next(value)\\`). The tag will not be\nexpected if the generator function body merely has plain \\`yield;\\` or\n\\`yield value;\\` statements without returning the values. Defaults to\n\\`false\\`.`,\n            type: 'boolean',\n          },\n          nextWithGeneratorTag: {\n            default: false,\n            description: `If a \\`@generator\\` tag is present on a block, require\n(non-standard ) \\`@next\\` (see \\`next\\` option). This will require using \\`void\\`\nor \\`undefined\\` in cases where generators do not use the \\`next()\\`-supplied\nincoming \\`yield\\`-returned value. Defaults to \\`false\\`. See \\`contexts\\` to\n\\`any\\` if you want to catch \\`@generator\\` with \\`@callback\\` or such not\nattached to a function.`,\n            type: 'boolean',\n          },\n          withGeneratorTag: {\n            default: true,\n            description: `If a \\`@generator\\` tag is present on a block, require\n\\`@yields\\`/\\`@yield\\`. Defaults to \\`true\\`. See \\`contexts\\` to \\`any\\` if you want\nto catch \\`@generator\\` with \\`@callback\\` or such not attached to a function.`,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA;AAA8C;AAE9C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,OAAO,GAAI,KAAK,IAAK;EACzB,OAAO,KAAK,CAAC,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,IACA,KAAK,CAAC,SAAS,CAAC,CAAC;AACrB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,YAAY,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,KAAK;EAC/C,MAAM,gBAAgB,GAAG,qBAAuB,KAAK,CAAC,mBAAmB,CAAC;IACxE;EACF,CAAC,CAAE;EACH,IAAI,CAAC,gBAAgB,EAAE;IACrB,OAAO,EAAE;EACX;EAEA,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC;EAE5C,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;IACnB,MAAM,CAAC,wBAAwB,gBAAgB,eAAe,CAAC;EACjE;;EAEA;EACA,MAAM,CACJ,GAAG,CACJ,GAAG,IAAI;EACR,MAAM,UAAU,GAAG,OAAO,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI;EAE7D,OAAO,CACL,gBAAgB,EAAE,UAAU,CAC7B;AACH,CAAC;AAAC,iCAEa,IAAAA,qBAAY,EAAC,CAAC;EAC3B,OAAO;EACP,MAAM;EACN;AACF,CAAC,KAAK;EACJ,MAAM;IACJ,gBAAgB,GAAG,KAAK;IACxB,kBAAkB,GAAG,KAAK;IAC1B,IAAI,GAAG,KAAK;IACZ,oBAAoB,GAAG,KAAK;IAC5B,gBAAgB,GAAG;EACrB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;EAE5B;EACA;EACA,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE;IAClB;EACF;EAEA,MAAM,iBAAiB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;EAErD,MAAM,CACJ,qBAAqB,EACrB,eAAe,CAChB,GAAG,YAAY,CACd,KAAK,EAAE,MAAM,EAAE,QACjB,CAAC;EACD,IAAI,qBAAqB,EAAE;IACzB,MAAM,kBAAkB,GAAG,MAAM;MAC/B,IAAI,CAAC,eAAe,EAAE;QACpB,OAAO,KAAK;MACd;MAEA,IACE,gBAAgB,IAAI,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,IAC7C,kBAAkB,IAAI,iBAAiB,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC,EAC9D;QACA,OAAO,IAAI;MACb;MAEA,OAAO,iBAAiB,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;IAC1E,CAAC;IAED,IAAI,kBAAkB,CAAC,CAAC,EAAE;MACxB,MAAM,CAAC,kBAAkB,qBAAqB,eAAe,CAAC;IAChE;EACF;EAEA,IAAI,IAAI,IAAI,oBAAoB,IAAI,gBAAgB,EAAE;IACpD,MAAM,CACJ,oBAAoB,EACpB,cAAc,CACf,GAAG,YAAY,CACd,KAAK,EAAE,MAAM,EAAE,MACjB,CAAC;IACD,IAAI,CAAC,oBAAoB,EAAE;MACzB;IACF;IAEA,MAAM,gBAAgB,GAAG,MAAM;MAC7B,IAAI,CAAC,cAAc,EAAE;QACnB,OAAO,KAAK;MACd;MAEA,IACE,oBAAoB,IAAI,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE;QACnD,OAAO,IAAI;MACb;MAEA,IACE,CAAC,IAAI,IAAI,CAAC,gBAAgB,IAC1B,CAAC,iBAAiB,IAClB,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,EACpB;QACA,OAAO,KAAK;MACd;MAEA,OAAO,gBAAgB,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,gBAAgB,CAAC,CAAC,EAAE;MACtB,MAAM,CAAC,kBAAkB,oBAAoB,eAAe,CAAC;IAC/D;EACF;AACF,CAAC,EAAE;EACD,eAAe,EAAE,IAAI;EACrB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,qDAAqD;MAClE,GAAG,EAAE;IACP,CAAC;IACD,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,QAAQ,EAAE;UACR,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,QAAQ;UACI,KAAK,EAAE;YACL,KAAK,EAAE,CACL;cACE,IAAI,EAAE;YACR,CAAC,EACD;cACE,oBAAoB,EAAE,KAAK;cAC3B,UAAU,EAAE;gBACV,OAAO,EAAE;kBACP,IAAI,EAAE;gBACR,CAAC;gBACD,OAAO,EAAE;kBACP,IAAI,EAAE;gBACR;cACF,CAAC;cACD,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACD,IAAI,EAAE;QACR,CAAC;QACD,UAAU,EAAE;UACV,WAAW,EAAE;AACzB;AACA;AACA;AACA,uBAAuB;UACX,KAAK,EAAE;YACL,IAAI,EAAE;UACR,CAAC;UACD,IAAI,EAAE;QACR,CAAC;QACD,gBAAgB,EAAE;UAChB,OAAO,EAAE,KAAK;UACd,WAAW,EAAE;AACzB;AACA;AACA,+EAA+E;UACnE,IAAI,EAAE;QACR,CAAC;QACD,kBAAkB,EAAE;UAClB,OAAO,EAAE,KAAK;UACd,WAAW,EAAE;AACzB;AACA;AACA;AACA,WAAW;UACC,IAAI,EAAE;QACR,CAAC;QACD,IAAI,EAAE;UACJ,OAAO,EAAE,KAAK;UACd,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA,WAAW;UACC,IAAI,EAAE;QACR,CAAC;QACD,oBAAoB,EAAE;UACpB,OAAO,EAAE,KAAK;UACd,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA,wBAAwB;UACZ,IAAI,EAAE;QACR,CAAC;QACD,gBAAgB,EAAE;UAChB,OAAO,EAAE,IAAI;UACb,WAAW,EAAE;AACzB;AACA,+EAA+E;UACnE,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}