eslint-plugin-jsdoc 56.1.1 → 57.0.0

package/src/iterateJsdoc.js

@@ -543,8 +543,6 @@ const {
   seedTokens,
 } = util;
 
-// todo: Change these `any` types once importing types properly.
-
 /**
  * Should use ESLint rule's typing.
  * @typedef {import('eslint').Rule.RuleMetaData} EslintRuleMeta
@@ -1749,8 +1747,14 @@ const getUtils = (
  *   mode: import('./jsdocUtils.js').ParserMode,
  *   preferredTypes: PreferredTypes,
  *   structuredTags: StructuredTags,
- *   [name: string]: any,
- *   contexts?: Context[]
+ *   contexts?: Context[],
+ *   augmentsExtendsReplacesDocs?: boolean,
+ *   ignoreReplacesDocs?: boolean,
+ *   implementsReplacesDocs?: boolean,
+ *   overrideReplacesDocs?: boolean,
+ *   ignoreInternal?: boolean,
+ *   ignorePrivate?: boolean,
+ *   exemptDestructuredRootsFromChecks?: boolean,
  * }} Settings
  */
 
@@ -1923,7 +1927,7 @@ const makeReport = (context, commentNode) => {
  *     settings: Settings,
  *     utils: BasicUtils,
  *   }
- * ) => any } JsdocVisitorBasic
+ * ) => void } JsdocVisitorBasic
  */
 /**
  * @typedef {(
@@ -1948,7 +1952,7 @@ const makeReport = (context, commentNode) => {
  *     settings: Settings,
  *     utils: Utils,
  *   }
- * ) => any } JsdocVisitor
+ * ) => void } JsdocVisitor
  */
 
 /**
@@ -2084,6 +2088,7 @@ const getIndentAndJSDoc = function (lines, jsdocNode) {
  * @property {EslintRuleMeta} meta ESLint rule meta
  * @property {import('./jsdocUtils.js').DefaultContexts} [contextDefaults] Any default contexts
  * @property {true} [contextSelected] Whether to force a `contexts` check
+ * @property {(context: import('eslint').Rule.RuleContext) => import('eslint').Rule.RuleContext} [modifyContext] Modify the rule's context object
  * @property {true} [iterateAllJsdocs] Whether to iterate all JSDoc blocks by default
  *   regardless of context
  * @property {true} [checkPrivate] Whether to check `@private` blocks (normally exempted)
@@ -2391,13 +2396,17 @@ export default function iterateJsdoc (iterator, ruleConfig) {
   return {
     /**
      * The entrypoint for the JSDoc rule.
-     * @param {import('eslint').Rule.RuleContext} context
+     * @param {import('eslint').Rule.RuleContext} ctx
      *   a reference to the context which hold all important information
      *   like settings and the sourcecode to check.
      * @returns {import('eslint').Rule.RuleListener}
      *   a listener with parser callback function.
      */
-    create (context) {
+    create (ctx) {
+      const context = ruleConfig.modifyContext ?
+        ruleConfig.modifyContext(ctx) :
+        ctx;
+
       const settings = getSettings(context);
       if (!settings) {
         return {};

package/src/jsdocUtils.js

@@ -1289,9 +1289,7 @@ const hasNonFunctionYield = (node, checkYieldReturnValue) => {
       hasNonFunctionYield(node.property, checkYieldReturnValue);
 
     case 'ObjectExpression':
-    /* eslint-disable no-fallthrough */
     case 'ObjectPattern':
-      /* eslint-enable no-fallthrough */
       return node.properties.some((property) => {
         return hasNonFunctionYield(property, checkYieldReturnValue);
       });
@@ -1414,7 +1412,6 @@ const hasYieldValue = (node, checkYieldReturnValue) => {
  * @param {boolean} [innerFunction]
  * @returns {boolean}
  */
-// eslint-disable-next-line complexity
 const hasThrowValue = (node, innerFunction) => {
   if (!node) {
     return false;

package/src/rules/checkParamNames.js

@@ -315,7 +315,7 @@ const validateParameterNames = (
  *   idx: import('../iterateJsdoc.js').Integer
  * }[]} jsdocParameterNames
  * @param {import('comment-parser').Block} jsdoc
- * @param {Function} report
+ * @param {import('../iterateJsdoc.js').Report} report
  * @returns {boolean}
  */
 const validateParameterNamesDeep = (

package/src/rules/checkPropertyNames.js

@@ -51,7 +51,7 @@ const validatePropertyNames = (
  *   type: string;
  * }[]} jsdocPropertyNames
  * @param {import('comment-parser').Block} jsdoc
- * @param {Function} report
+ * @param {import('../iterateJsdoc.js').Report} report
  */
 const validatePropertyNamesDeep = (
   targetTagName,

package/src/rules/informativeDocs.js

@@ -13,8 +13,6 @@ const defaultUselessWords = [
   'a', 'an', 'i', 'in', 'of', 's', 'the',
 ];
 
-/* eslint-disable complexity -- Temporary */
-
 /**
  * @param {import('eslint').Rule.Node|import('@typescript-eslint/types').TSESTree.Node|null|undefined} node
  * @returns {string[]}
@@ -89,7 +87,6 @@ const getNamesFromNode = (node) => {
       return [];
   }
 };
-/* eslint-enable complexity -- Temporary */
 
 export default iterateJsdoc(({
   context,

package/src/rules/matchName.js

@@ -1,6 +1,5 @@
 import iterateJsdoc from '../iterateJsdoc.js';
 
-// eslint-disable-next-line complexity
 export default iterateJsdoc(({
   context,
   info: {

package/src/rules/noMultiAsterisks.js

@@ -22,7 +22,6 @@ export default iterateJsdoc(({
 
   const middleAsterisks = allowWhitespace ? middleAsterisksNoBlockWS : middleAsterisksBlockWS;
 
-  // eslint-disable-next-line complexity -- Todo
   jsdoc.source.some(({
     number,
     tokens,

package/src/rules/requireReturnsCheck.js

@@ -33,7 +33,6 @@ const canSkip = (utils, settings) => {
     settings.mode === 'closure' && utils.classHasTag('record');
 };
 
-// eslint-disable-next-line complexity -- Temporary
 export default iterateJsdoc(({
   context,
   node,

package/src/rules/sortTags.js

@@ -1,7 +1,6 @@
 import defaultTagOrder from '../defaultTagOrder.js';
 import iterateJsdoc from '../iterateJsdoc.js';
 
-// eslint-disable-next-line complexity -- Temporary
 export default iterateJsdoc(({
   context,
   jsdoc,
@@ -330,7 +329,6 @@ export default iterateJsdoc(({
 
       const ct = countTagEmptyLines(tag);
       if (ct) {
-        // eslint-disable-next-line complexity -- Temporary
         const fixer = () => {
           let foundFirstTag = false;
 

package/src/rules/tagLines.js

@@ -16,7 +16,6 @@ export default iterateJsdoc(({
     } = {},
   ] = context.options;
 
-  // eslint-disable-next-line complexity -- Temporary
   jsdoc.tags.some((tg, tagIdx) => {
     let lastTag;