eslint-plugin-jsdoc 62.9.0 → 63.0.1

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 (not including `void`/`undefined` type returns).',\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            description: `Set this to an array of strings representing the AST context (or an object with\noptional \\`context\\` and \\`comment\\` properties) where you wish the 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\nSee the [\"AST and Selectors\"](../#advanced-ast-and-selectors)\nsection of our Advanced docs for more on the expected format.`,\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,6GAA6G;MAC1HI,GAAG,EAAE;IACP,CAAC;IACDC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVC,QAAQ,EAAE;UACRR,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,8DAA8D;UAClDS,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","_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 (not including `void`/`undefined` type returns).',\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            description: `Set this to an array of strings representing the AST context (or an object with\noptional \\`context\\` and \\`comment\\` properties) where you wish the 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\nSee the [\"AST and Selectors\"](../advanced.md#ast-and-selectors)\nsection of our Advanced docs for more on the expected format.`,\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,6GAA6G;MAC1HI,GAAG,EAAE;IACP,CAAC;IACDC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVC,QAAQ,EAAE;UACRR,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,8DAA8D;UAClDS,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":[]}

package/dist/rules/requireReturnsType.cjs

@@ -38,7 +38,7 @@ 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\`).
 
-See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
 section of our Advanced docs for more on the expected format.`,
           items: {
             anyOf: [{

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 (in curly brackets).',\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            description: `Set this to an array of strings representing the AST context (or an object with\noptional \\`context\\` and \\`comment\\` properties) where you wish the 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\nSee the [\"AST and Selectors\"](../#advanced-ast-and-selectors)\nsection of our Advanced docs for more on the expected format.`,\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,kEAAkE;MAC/EC,GAAG,EAAE;IACP,CAAC;IACDC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVC,QAAQ,EAAE;UACRL,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,8DAA8D;UAClDM,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","_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 (in curly brackets).',\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            description: `Set this to an array of strings representing the AST context (or an object with\noptional \\`context\\` and \\`comment\\` properties) where you wish the 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\nSee the [\"AST and Selectors\"](../advanced.md#ast-and-selectors)\nsection of our Advanced docs for more on the expected format.`,\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,kEAAkE;MAC/EC,GAAG,EAAE;IACP,CAAC;IACDC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVC,QAAQ,EAAE;UACRL,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,8DAA8D;UAClDM,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":[]}

package/dist/rules/requireThrows.cjs

@@ -21,7 +21,7 @@ const canSkip = utils => {
   // so it is not necessary to document that they throw an error.
   'abstract', 'virtual',
   // The designated type can itself document `@throws`
-  'type']) || utils.avoidDocs();
+  'type']) || utils.avoidDocs(false);
 };
 var _default = exports.default = (0, _iterateJsdoc.default)(({
   report,

package/dist/rules/requireThrows.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"requireThrows.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","canSkip","utils","hasATag","avoidDocs","_default","exports","iterateJsdoc","report","tagName","getPreferredTagName","tags","getTags","iteratingFunction","isIteratingFunction","tag","missingThrowsTag","shouldReport","type","trim","hasThrowValue","contextDefaults","meta","docs","description","url","schema","additionalProperties","properties","contexts","items","anyOf","comment","context","exemptedBy","module"],"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();\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,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE9C;AACA;AACA;AACA;AACA;AACA;AACA,MAAMG,OAAO,GAAIC,KAAK,IAAK;EACzB,OAAOA,KAAK,CAACC,OAAO,CAAC;EACnB;EACA;EACA;EACA;EACA;EACA,UAAU,EACV,SAAS;EAET;EACA,MAAM,CACP,CAAC,IACAD,KAAK,CAACE,SAAS,CAAC,CAAC;AACrB,CAAC;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAN,OAAA,GAEa,IAAAO,qBAAY,EAAC,CAAC;EAC3BC,MAAM;EACNN;AACF,CAAC,KAAK;EACJ;EACA;EACA,IAAID,OAAO,CAACC,KAAK,CAAC,EAAE;IAClB;EACF;EAEA,MAAMO,OAAO,GAAG,qBAAuBP,KAAK,CAACQ,mBAAmB,CAAC;IAC/DD,OAAO,EAAE;EACX,CAAC,CAAE;EACH,IAAI,CAACA,OAAO,EAAE;IACZ;EACF;EAEA,MAAME,IAAI,GAAGT,KAAK,CAACU,OAAO,CAACH,OAAO,CAAC;EACnC,MAAMI,iBAAiB,GAAGX,KAAK,CAACY,mBAAmB,CAAC,CAAC;;EAErD;EACA,MAAM,CACJC,GAAG,CACJ,GAAGJ,IAAI;EACR,MAAMK,gBAAgB,GAAG,OAAOD,GAAG,KAAK,WAAW,IAAIA,GAAG,KAAK,IAAI;EAEnE,MAAME,YAAY,GAAGA,CAAA,KAAM;IACzB,IAAI,CAACD,gBAAgB,EAAE;MACrB,IAAID,GAAG,CAACG,IAAI,CAACC,IAAI,CAAC,CAAC,KAAK,OAAO,IAAIN,iBAAiB,IAAIX,KAAK,CAACkB,aAAa,CAAC,CAAC,EAAE;QAC7EZ,MAAM,CAAC,UAAUC,OAAO,oDAAoD,CAAC;MAC/E;MAEA,OAAO,KAAK;IACd;IAEA,OAAOI,iBAAiB,IAAIX,KAAK,CAACkB,aAAa,CAAC,CAAC;EACnD,CAAC;EAED,IAAIH,YAAY,CAAC,CAAC,EAAE;IAClBT,MAAM,CAAC,kBAAkBC,OAAO,eAAe,CAAC;EAClD;AACF,CAAC,EAAE;EACDY,eAAe,EAAE,IAAI;EACrBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,oEAAoE;MACjFC,GAAG,EAAE;IACP,CAAC;IACDC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVC,QAAQ,EAAE;UACRL,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,kEAAkE;UACtDM,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,CAAC;QACDgB,UAAU,EAAE;UACVV,WAAW,EAAE;AACzB;AACA;AACA;AACA,uBAAuB;UACXM,KAAK,EAAE;YACLZ,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAiB,MAAA,CAAA7B,OAAA,GAAAA,OAAA,CAAAN,OAAA","ignoreList":[]}
+{"version":3,"file":"requireThrows.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","canSkip","utils","hasATag","avoidDocs","_default","exports","iterateJsdoc","report","tagName","getPreferredTagName","tags","getTags","iteratingFunction","isIteratingFunction","tag","missingThrowsTag","shouldReport","type","trim","hasThrowValue","contextDefaults","meta","docs","description","url","schema","additionalProperties","properties","contexts","items","anyOf","comment","context","exemptedBy","module"],"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,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE9C;AACA;AACA;AACA;AACA;AACA;AACA,MAAMG,OAAO,GAAIC,KAAK,IAAK;EACzB,OAAOA,KAAK,CAACC,OAAO,CAAC;EACnB;EACA;EACA;EACA;EACA;EACA,UAAU,EACV,SAAS;EAET;EACA,MAAM,CACP,CAAC,IACAD,KAAK,CAACE,SAAS,CAAC,KAAK,CAAC;AAC1B,CAAC;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAN,OAAA,GAEa,IAAAO,qBAAY,EAAC,CAAC;EAC3BC,MAAM;EACNN;AACF,CAAC,KAAK;EACJ;EACA;EACA,IAAID,OAAO,CAACC,KAAK,CAAC,EAAE;IAClB;EACF;EAEA,MAAMO,OAAO,GAAG,qBAAuBP,KAAK,CAACQ,mBAAmB,CAAC;IAC/DD,OAAO,EAAE;EACX,CAAC,CAAE;EACH,IAAI,CAACA,OAAO,EAAE;IACZ;EACF;EAEA,MAAME,IAAI,GAAGT,KAAK,CAACU,OAAO,CAACH,OAAO,CAAC;EACnC,MAAMI,iBAAiB,GAAGX,KAAK,CAACY,mBAAmB,CAAC,CAAC;;EAErD;EACA,MAAM,CACJC,GAAG,CACJ,GAAGJ,IAAI;EACR,MAAMK,gBAAgB,GAAG,OAAOD,GAAG,KAAK,WAAW,IAAIA,GAAG,KAAK,IAAI;EAEnE,MAAME,YAAY,GAAGA,CAAA,KAAM;IACzB,IAAI,CAACD,gBAAgB,EAAE;MACrB,IAAID,GAAG,CAACG,IAAI,CAACC,IAAI,CAAC,CAAC,KAAK,OAAO,IAAIN,iBAAiB,IAAIX,KAAK,CAACkB,aAAa,CAAC,CAAC,EAAE;QAC7EZ,MAAM,CAAC,UAAUC,OAAO,oDAAoD,CAAC;MAC/E;MAEA,OAAO,KAAK;IACd;IAEA,OAAOI,iBAAiB,IAAIX,KAAK,CAACkB,aAAa,CAAC,CAAC;EACnD,CAAC;EAED,IAAIH,YAAY,CAAC,CAAC,EAAE;IAClBT,MAAM,CAAC,kBAAkBC,OAAO,eAAe,CAAC;EAClD;AACF,CAAC,EAAE;EACDY,eAAe,EAAE,IAAI;EACrBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,oEAAoE;MACjFC,GAAG,EAAE;IACP,CAAC;IACDC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVC,QAAQ,EAAE;UACRL,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,kEAAkE;UACtDM,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,CAAC;QACDgB,UAAU,EAAE;UACVV,WAAW,EAAE;AACzB;AACA;AACA;AACA,uBAAuB;UACXM,KAAK,EAAE;YACLZ,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAiB,MAAA,CAAA7B,OAAA,GAAAA,OAAA,CAAAN,OAAA","ignoreList":[]}

package/dist/rules.d.ts

@@ -575,7 +575,7 @@ export interface Rules {
            * expression, i.e., `@callback` or `@function` (or its aliases `@func` or
            * `@method`) (including those associated with an `@interface`).
            *
-           * See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+           * See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
            * section of our Advanced docs for more on the expected format.
            */
           contexts?: (
@@ -705,7 +705,7 @@ export interface Rules {
            * `FunctionExpression`). Set to `"any"` if you want the rule to apply to any
            * JSDoc block throughout your files.
            *
-           * See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+           * See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
            * section of our Advanced docs for more on the expected format.
            */
           contexts?: (
@@ -900,7 +900,7 @@ export interface Rules {
             /**
              * AST to confine the allowing or disallowing to JSDoc blocks
              * associated with a particular context. See the
-             * ["AST and Selectors"](../#advanced-ast-and-selectors)
+             * ["AST and Selectors"](../advanced.md#ast-and-selectors)
              * section of our Advanced docs for more on the expected format.
              */
             context?: string;
@@ -1087,7 +1087,7 @@ export interface Rules {
            * expression, i.e., `@callback` or `@function` (or its aliases `@func` or
            * `@method`) (including those associated with an `@interface`).
            *
-           * See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+           * See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
            * section of our Advanced docs for more on the expected format.
            */
           contexts?: (
@@ -1133,7 +1133,7 @@ export interface Rules {
            * function declaration or expression, i.e., `@callback` or `@function` (or its
            * aliases `@func` or `@method`) (including those associated with an `@interface`).
            *
-           * See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+           * See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
            * section of our Advanced docs for more on the expected format.
            */
           contexts?: (
@@ -1215,7 +1215,7 @@ export interface Rules {
            * function declaration or expression, i.e., `@callback` or `@function` (or its
            * aliases `@func` or `@method`) (including those associated with an `@interface`).
            *
-           * See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+           * See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
            * section of our Advanced docs for more on the expected format.
            */
           contexts: (
@@ -1248,7 +1248,7 @@ export interface Rules {
            * expression, i.e., `@callback` or `@function` (or its aliases `@func` or
            * `@method`) (including those associated with an `@interface`).
            *
-           * See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+           * See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
            * section of our Advanced docs for more on the expected format.
            */
           contexts?: (
@@ -1396,7 +1396,7 @@ export interface Rules {
            * expression, i.e., `@callback` or `@function` (or its aliases `@func` or
            * `@method`) (including those associated with an `@interface`).
            *
-           * See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+           * See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
            * section of our Advanced docs for more on the expected format.
            */
           contexts?: (
@@ -1495,7 +1495,7 @@ export interface Rules {
            * `FunctionExpression`). Set to `"any"` if you want the rule to apply to any
            * JSDoc block throughout your files.
            *
-           * See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+           * See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
            * section of our Advanced docs for more on the expected format.
            */
           contexts?: (
@@ -1681,7 +1681,7 @@ export interface Rules {
            * Note that you may need to disable `require` items (e.g., `MethodDefinition`)
            * if you are specifying a more precise form in `contexts` (e.g., `MethodDefinition:not([accessibility="private"] > FunctionExpression`).
            *
-           * See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+           * See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
            * section of our Advanced docs for more on the expected format.
            */
           contexts?: (
@@ -1938,7 +1938,7 @@ export interface Rules {
            * `TSMethodSignature` in TypeScript or restricting the contexts
            * which are checked.
            *
-           * See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+           * See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
            * section of our Advanced docs for more on the expected format.
            */
           contexts?: (
@@ -2090,7 +2090,7 @@ export interface Rules {
            * expression, i.e., `@callback` or `@function` (or its aliases `@func` or
            * `@method`) (including those associated with an `@interface`).
            *
-           * See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+           * See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
            * section of our Advanced docs for more on the expected format.
            */
           contexts?: (
@@ -2134,7 +2134,7 @@ export interface Rules {
            * expression, i.e., `@callback` or `@function` (or its aliases `@func` or
            * `@method`) (including those associated with an `@interface`).
            *
-           * See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+           * See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
            * section of our Advanced docs for more on the expected format.
            */
           contexts?: (
@@ -2165,7 +2165,7 @@ export interface Rules {
            * expression, i.e., `@callback` or `@function` (or its aliases `@func` or
            * `@method`) (including those associated with an `@interface`).
            *
-           * See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+           * See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
            * section of our Advanced docs for more on the expected format.
            */
           contexts?: (
@@ -2394,7 +2394,7 @@ export interface Rules {
            * expression, i.e., `@callback` or `@function` (or its aliases `@func` or
            * `@method`) (including those associated with an `@interface`).
            *
-           * See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+           * See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
            * section of our Advanced docs for more on the expected format.
            */
           contexts?: (
@@ -2425,7 +2425,7 @@ export interface Rules {
            * expression, i.e., `@callback` or `@function` (or its aliases `@func` or
            * `@method`) (including those associated with an `@interface`).
            *
-           * See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+           * See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
            * section of our Advanced docs for more on the expected format.
            */
           contexts?: (

package/package.json

@@ -5,78 +5,78 @@
     "url": "http://gajus.com"
   },
   "dependencies": {
-    "@es-joy/jsdoccomment": "~0.86.0",
+    "@es-joy/jsdoccomment": "~0.87.0",
     "@es-joy/resolve.exports": "1.2.0",
     "are-docs-informative": "^0.0.2",
-    "comment-parser": "1.4.6",
+    "comment-parser": "1.4.7",
     "debug": "^4.4.3",
     "escape-string-regexp": "^4.0.0",
     "espree": "^11.2.0",
     "esquery": "^1.7.0",
     "html-entities": "^2.6.0",
-    "object-deep-merge": "^2.0.0",
+    "object-deep-merge": "^2.0.1",
     "parse-imports-exports": "^0.2.4",
-    "semver": "^7.7.4",
+    "semver": "^7.8.1",
     "spdx-expression-parse": "^4.0.0",
     "to-valid-identifier": "^1.0.0"
   },
   "description": "JSDoc linting rules for ESLint.",
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.2",
-    "@babel/cli": "^7.28.6",
-    "@babel/core": "8.0.0-rc.1",
-    "@babel/eslint-parser": "8.0.0-rc.1",
-    "@babel/plugin-transform-flow-strip-types": "8.0.0-rc.1",
-    "@babel/preset-env": "8.0.0-rc.1",
+    "@babel/cli": "8.0.0-rc.5",
+    "@babel/core": "8.0.0-rc.5",
+    "@babel/eslint-parser": "8.0.0-rc.5",
+    "@babel/plugin-transform-flow-strip-types": "8.0.0-rc.5",
+    "@babel/preset-env": "8.0.0-rc.5",
     "@es-joy/escodegen": "^4.2.0",
     "@es-joy/jsdoc-eslint-parser": "^0.27.0",
-    "@eslint/core": "^1.1.1",
+    "@eslint/core": "^1.2.1",
     "@hkdobrev/run-if-changed": "^0.6.3",
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@semantic-release/commit-analyzer": "^13.0.1",
-    "@semantic-release/github": "^12.0.6",
+    "@semantic-release/github": "^12.0.8",
     "@semantic-release/npm": "^13.1.5",
     "@types/chai": "^5.2.3",
     "@types/debug": "^4.1.13",
     "@types/esquery": "^1.5.4",
-    "@types/estree": "^1.0.8",
+    "@types/estree": "^1.0.9",
     "@types/json-schema": "^7.0.15",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^25.5.0",
+    "@types/node": "^25.9.1",
     "@types/semver": "^7.7.1",
-    "@types/spdx-expression-parse": "^3.0.5",
-    "@typescript-eslint/types": "8.58.0",
+    "@types/spdx-expression-parse": "^4.0.0",
+    "@typescript-eslint/types": "8.59.4",
     "babel-plugin-add-module-exports": "^1.0.4",
-    "babel-plugin-istanbul": "^7.0.1",
+    "babel-plugin-istanbul": "^8.0.0",
     "babel-plugin-transform-import-meta": "^2.3.3",
     "c8": "^11.0.0",
     "camelcase": "^9.0.0",
     "chai": "^6.2.2",
     "decamelize": "^6.0.1",
-    "eslint": "10.1.0",
+    "eslint": "10.4.0",
     "eslint-config-canonical": "^47.4.2",
     "gitdown": "^4.1.1",
     "glob": "^13.0.6",
-    "globals": "^17.4.0",
+    "globals": "^17.6.0",
     "husky": "^9.1.7",
     "jsdoc-type-pratt-parser": "^7.2.0",
     "json-schema": "^0.4.0",
     "json-schema-to-typescript": "^15.0.4",
-    "lint-staged": "^16.4.0",
-    "mocha": "^11.7.5",
+    "lint-staged": "^17.0.5",
+    "mocha": "^11.7.6",
     "open-editor": "^6.0.0",
-    "playwright": "^1.59.0",
+    "playwright": "^1.60.0",
     "replace": "^1.2.2",
     "rimraf": "^6.1.3",
-    "rollup": "^4.60.1",
+    "rollup": "^4.60.4",
     "semantic-release": "^25.0.3",
-    "sinon": "^21.0.3",
+    "sinon": "^22.0.0",
     "ts-api-utils": "^2.5.0",
     "typescript": "5.9.3",
-    "typescript-eslint": "8.58.0"
+    "typescript-eslint": "8.59.4"
   },
   "engines": {
-    "node": "^20.19.0 || ^22.13.0 || >=24"
+    "node": "^22.13.0 || >=24"
   },
   "keywords": [
     "eslint",
@@ -158,18 +158,6 @@
   "run-if-changed": {
     "pnpm-lock.yaml": "pnpm run install-offline"
   },
-  "pnpm": {
-    "overrides": {
-      "@types/eslint": "0.0.0-interferes-with-eslint-now",
-      "eslint-scope": "9.1.0"
-    },
-    "ignoredBuiltDependencies": [
-      "core-js",
-      "core-js-pure",
-      "re2",
-      "unrs-resolver"
-    ]
-  },
   "scripts": {
     "ruleTypes": "node ./src/bin/generateRuleTypes.js",
     "tsc": "tsc",
@@ -182,7 +170,7 @@
     "create-docs": "pnpm run create-options && node ./src/bin/generateDocs.js && pnpm ruleTypes",
     "create-rule": "node ./src/bin/generateRule.js",
     "create-options": "node ./src/bin/generateOptions.js",
-    "install-offline": "pnpm install --prefer-offline",
+    "install-offline": "CI=1 pnpm install --prefer-offline --no-frozen-lockfile",
     "lint": "eslint",
     "lint-fix": "eslint --fix",
     "prepare": "husky",
@@ -191,5 +179,5 @@
     "test-cov": "TIMING=1 c8 --reporter text pnpm run test-no-cov",
     "test-index": "pnpm run test-no-cov test/rules/index.js"
   },
-  "version": "62.9.0"
+  "version": "63.0.1"
 }

package/src/exportParser.js

@@ -282,7 +282,7 @@ const getSymbol = function (node, globals, scope, opt) {
         /* c8 ignore next 8 */
         if (propVal) {
           val.props[
-          /** @type {import('estree').PrivateIdentifier} */
+          /** @type {import('estree').Identifier} */
             (
             /** @type {import('estree').Property} */ (prop).key
             ).name

package/src/iterateJsdoc.js

@@ -337,6 +337,7 @@ import esquery from 'esquery';
 
 /**
  * @callback AvoidDocs
+ * @param {boolean} [exemptSpecialMethods]
  * @returns {boolean}
  */
 
@@ -1462,7 +1463,9 @@ const getUtils = (
   };
 
   /** @type {AvoidDocs} */
-  utils.avoidDocs = () => {
+  utils.avoidDocs = (
+    exemptSpecialMethods = true,
+  ) => {
     if (
       ignoreReplacesDocs !== false &&
         (utils.hasTag('ignore') || utils.classHasTag('ignore')) ||
@@ -1480,7 +1483,7 @@ const getUtils = (
       return true;
     }
 
-    if (jsdocUtils.exemptSpeciaMethods(
+    if (exemptSpecialMethods && jsdocUtils.exemptSpeciaMethods(
       jsdoc,
       node,
       context,

package/src/rules/emptyTags.js

@@ -55,6 +55,14 @@ export default iterateJsdoc(({
       // Allow for JSDoc-block final asterisks
       key !== emptyTags.length - 1 || !(/^\s*\*+$/v).test(content)
     )) {
+      const {
+        tokens: {
+          delimiter,
+          end,
+          postName,
+          start,
+        },
+      } = tag.source[0];
       const fix = () => {
         // By time of call in fixer, `tag` will have `line` added
         utils.setTag(
@@ -63,6 +71,12 @@ export default iterateJsdoc(({
            *   line: import('../iterateJsdoc.js').Integer
            * }}
            */ (tag),
+          {
+            delimiter,
+            end,
+            postName: end ? postName : '',
+            start,
+          },
         );
       };
 

package/src/rules/implementsOnClasses.js

@@ -46,7 +46,7 @@ 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\`).
 
-See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
 section of our Advanced docs for more on the expected format.`,
             items: {
               anyOf: [

package/src/rules/matchDescription.js

@@ -183,7 +183,7 @@ Overrides the default contexts (\`ArrowFunctionExpression\`, \`FunctionDeclarati
 \`FunctionExpression\`). Set to \`"any"\` if you want the rule to apply to any
 JSDoc block throughout your files.
 
-See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
 section of our Advanced docs for more on the expected format.`,
             items: {
               anyOf: [

package/src/rules/matchName.js

@@ -135,7 +135,7 @@ Accepts a string regular expression (optionally wrapped between two
                 context: {
                   description: `AST to confine the allowing or disallowing to JSDoc blocks
 associated with a particular context. See the
-["AST and Selectors"](../#advanced-ast-and-selectors)
+["AST and Selectors"](../advanced.md#ast-and-selectors)
 section of our Advanced docs for more on the expected format.`,
                   type: 'string',
                 },

package/src/rules/noDefaults.js

@@ -64,7 +64,7 @@ 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\`).
 
-See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
 section of our Advanced docs for more on the expected format.`,
             items: {
               anyOf: [

package/src/rules/noMissingSyntax.js

@@ -177,7 +177,7 @@ 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\`).
 
-See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
 section of our Advanced docs for more on the expected format.`,
             items: {
               anyOf: [

package/src/rules/noRestrictedSyntax.js

@@ -35,7 +35,7 @@ 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\`).
 
-See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
 section of our Advanced docs for more on the expected format.`,
           items: {
             anyOf: [

package/src/rules/noTypes.js

@@ -76,7 +76,7 @@ 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\`).
 
-See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
 section of our Advanced docs for more on the expected format.`,
             items: {
               anyOf: [

package/src/rules/requireDescription.js

@@ -138,7 +138,7 @@ 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\`).
 
-See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
 section of our Advanced docs for more on the expected format.`,
             items: {
               anyOf: [

package/src/rules/requireExample.js

@@ -88,7 +88,7 @@ Overrides the default contexts (\`ArrowFunctionExpression\`, \`FunctionDeclarati
 \`FunctionExpression\`). Set to \`"any"\` if you want the rule to apply to any
 JSDoc block throughout your files.
 
-See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
 section of our Advanced docs for more on the expected format.`,
             items: {
               anyOf: [

package/src/rules/requireJsdoc.js

@@ -102,7 +102,7 @@ for it to require documentation.
 Note that you may need to disable \`require\` items (e.g., \`MethodDefinition\`)
 if you are specifying a more precise form in \`contexts\` (e.g., \`MethodDefinition:not([accessibility="private"] > FunctionExpression\`).
 
-See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
 section of our Advanced docs for more on the expected format.`,
       items: {
         anyOf: [

package/src/rules/requireParam.js

@@ -684,7 +684,7 @@ Overrides the default contexts (\`ArrowFunctionExpression\`, \`FunctionDeclarati
 \`TSMethodSignature\` in TypeScript or restricting the contexts
 which are checked.
 
-See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
 section of our Advanced docs for more on the expected format.`,
             items: {
               anyOf: [

package/src/rules/requireParamDescription.js

@@ -65,7 +65,7 @@ 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\`).
 
-See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
 section of our Advanced docs for more on the expected format.`,
             items: {
               anyOf: [

package/src/rules/requireParamName.js

@@ -37,7 +37,7 @@ 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\`).
 
-See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
 section of our Advanced docs for more on the expected format.`,
             items: {
               anyOf: [

package/src/rules/requireParamType.js

@@ -65,7 +65,7 @@ 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\`).
 
-See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
 section of our Advanced docs for more on the expected format.`,
             items: {
               anyOf: [

package/src/rules/requireReturnsDescription.js

@@ -41,7 +41,7 @@ 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\`).
 
-See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
 section of our Advanced docs for more on the expected format.`,
             items: {
               anyOf: [

package/src/rules/requireReturnsType.js

@@ -33,7 +33,7 @@ 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\`).
 
-See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
 section of our Advanced docs for more on the expected format.`,
             items: {
               anyOf: [

package/src/rules/requireThrows.js

@@ -19,7 +19,7 @@ const canSkip = (utils) => {
     // The designated type can itself document `@throws`
     'type',
   ]) ||
-    utils.avoidDocs();
+    utils.avoidDocs(false);
 };
 
 export default iterateJsdoc(({