eslint-plugin-jsdoc 52.0.1 → 52.0.3

package/dist/rules/requireParam.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"requireParam.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","rootNamer","desiredRoots","currentIndex","name","idx","incremented","length","base","suffix","shift","_default","exports","iterateJsdoc","context","jsdoc","utils","avoidDocs","hasTag","autoIncrementBase","checkDestructured","checkDestructuredRoots","checkRestProperty","checkTypesPattern","enableFixer","enableRestElementFixer","enableRootFixer","ignoreWhenAllParamsMissing","unnamedRootBase","useDefaultObjectProperties","options","preferredTagName","getPreferredTagName","tagName","functionParameterNames","getFunctionParameterNames","jsdocParameterNames","getJsdocTagsDeep","shallowJsdocParameterNames","filter","tag","includes","map","checkTypesRegex","getRegexFromString","missingTags","flattenedRoots","flattenRoots","names","paramIndex","hasParamIndex","cur","dropPathSegmentQuotes","String","getParamIndex","setParamIndex","entries","findExpectedIndex","jsdocTags","indexAtFunctionParams","remainingRoots","slice","foundIndex","findIndex","newAdd","some","remainingRoot","Array","isArray","tags","tagLineCount","source","tokens","end","nextRootName","namer","thisOffset","functionParameterIdx","functionParameterName","inc","matchedJsdoc","rootName","type","search","hasPropertyRest","hasRestElement","rests","notCheckingNames","paramName","find","fpn","emptyParamIdx","push","remove","fullParamName","notCheckingName","paramType","comparePaths","undefined","startsWith","funcParamName","restElement","fix","createTokens","tagIndex","sourceIndex","spliceCount","number","delimiter","description","lineEnd","postDelimiter","postName","postTag","postType","start","splice","inlineTags","optional","problems","firstNumber","src","offset","expectedIdx","fixer","missingTag","makeMultiline","reportJSDoc","contextDefaults","meta","docs","url","fixable","schema","additionalProperties","properties","checkConstructors","checkGetters","checkSetters","contexts","items","anyOf","comment","exemptedBy","noTracking","module"],"sources":["../../src/rules/requireParam.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @typedef {[string, boolean, () => RootNamerReturn]} RootNamerReturn\n */\n\n/**\n * @param {string[]} desiredRoots\n * @param {number} currentIndex\n * @returns {RootNamerReturn}\n */\nconst rootNamer = (desiredRoots, currentIndex) => {\n  /** @type {string} */\n  let name;\n  let idx = currentIndex;\n  const incremented = desiredRoots.length <= 1;\n  if (incremented) {\n    const base = desiredRoots[0];\n    const suffix = idx++;\n    name = `${base}${suffix}`;\n  } else {\n    name = /** @type {string} */ (desiredRoots.shift());\n  }\n\n  return [\n    name,\n    incremented,\n    () => {\n      return rootNamer(desiredRoots, idx);\n    },\n  ];\n};\n\n/* eslint-disable complexity -- Temporary */\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  /* eslint-enable complexity -- Temporary */\n  if (utils.avoidDocs()) {\n    return;\n  }\n\n  // Param type is specified by type in @type\n  if (utils.hasTag('type')) {\n    return;\n  }\n\n  const {\n    autoIncrementBase = 0,\n    checkDestructured = true,\n    checkDestructuredRoots = true,\n    checkRestProperty = false,\n    checkTypesPattern = '/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/',\n    enableFixer = true,\n    enableRestElementFixer = true,\n    enableRootFixer = true,\n    ignoreWhenAllParamsMissing = false,\n    unnamedRootBase = [\n      'root',\n    ],\n    useDefaultObjectProperties = false,\n  } = context.options[0] || {};\n\n  const preferredTagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'param',\n  }));\n  if (!preferredTagName) {\n    return;\n  }\n\n  const functionParameterNames = utils.getFunctionParameterNames(useDefaultObjectProperties);\n  if (!functionParameterNames.length) {\n    return;\n  }\n\n  const jsdocParameterNames =\n    /**\n     * @type {{\n     *   idx: import('../iterateJsdoc.js').Integer;\n     *   name: string;\n     *   type: string;\n     * }[]}\n     */ (utils.getJsdocTagsDeep(preferredTagName));\n\n  if (ignoreWhenAllParamsMissing && !jsdocParameterNames.length) {\n    return;\n  }\n\n  const shallowJsdocParameterNames = jsdocParameterNames.filter((tag) => {\n    return !tag.name.includes('.');\n  }).map((tag, idx) => {\n    return {\n      ...tag,\n      idx,\n    };\n  });\n\n  const checkTypesRegex = utils.getRegexFromString(checkTypesPattern);\n\n  /**\n   * @type {{\n   *   functionParameterIdx: import('../iterateJsdoc.js').Integer,\n   *   functionParameterName: string,\n   *   inc: boolean|undefined,\n   *   remove?: true,\n   *   type?: string|undefined\n   * }[]}\n   */\n  const missingTags = [];\n  const flattenedRoots = utils.flattenRoots(functionParameterNames).names;\n\n  /**\n   * @type {{\n   *   [key: string]: import('../iterateJsdoc.js').Integer\n   * }}\n   */\n  const paramIndex = {};\n\n  /**\n   * @param {string} cur\n   * @returns {boolean}\n   */\n  const hasParamIndex = (cur) => {\n    return utils.dropPathSegmentQuotes(String(cur)) in paramIndex;\n  };\n\n  /**\n   *\n   * @param {string|number|undefined} cur\n   * @returns {import('../iterateJsdoc.js').Integer}\n   */\n  const getParamIndex = (cur) => {\n    return paramIndex[utils.dropPathSegmentQuotes(String(cur))];\n  };\n\n  /**\n   *\n   * @param {string} cur\n   * @param {import('../iterateJsdoc.js').Integer} idx\n   * @returns {void}\n   */\n  const setParamIndex = (cur, idx) => {\n    paramIndex[utils.dropPathSegmentQuotes(String(cur))] = idx;\n  };\n\n  for (const [\n    idx,\n    cur,\n  ] of flattenedRoots.entries()) {\n    setParamIndex(cur, idx);\n  }\n\n  /**\n   *\n   * @param {(import('@es-joy/jsdoccomment').JsdocTagWithInline & {\n   *   newAdd?: boolean\n   * })[]} jsdocTags\n   * @param {import('../iterateJsdoc.js').Integer} indexAtFunctionParams\n   * @returns {import('../iterateJsdoc.js').Integer}\n   */\n  const findExpectedIndex = (jsdocTags, indexAtFunctionParams) => {\n    const remainingRoots = functionParameterNames.slice(indexAtFunctionParams || 0);\n    const foundIndex = jsdocTags.findIndex(({\n      name,\n      newAdd,\n    }) => {\n      return !newAdd && remainingRoots.some((remainingRoot) => {\n        if (Array.isArray(remainingRoot)) {\n          return (\n            /**\n             * @type {import('../jsdocUtils.js').FlattendRootInfo & {\n             *   annotationParamName?: string|undefined;\n             * }}\n             */ (remainingRoot[1]).names.includes(name)\n          );\n        }\n\n        if (typeof remainingRoot === 'object') {\n          return name === remainingRoot.name;\n        }\n\n        return name === remainingRoot;\n      });\n    });\n\n    const tags = foundIndex > -1 ?\n      jsdocTags.slice(0, foundIndex) :\n      jsdocTags.filter(({\n        tag,\n      }) => {\n        return tag === preferredTagName;\n      });\n\n    let tagLineCount = 0;\n    for (const {\n      source,\n    } of tags) {\n      for (const {\n        tokens: {\n          end,\n        },\n      } of source) {\n        if (!end) {\n          tagLineCount++;\n        }\n      }\n    }\n\n    return tagLineCount;\n  };\n\n  let [\n    nextRootName,\n    incremented,\n    namer,\n  ] = rootNamer([\n    ...unnamedRootBase,\n  ], autoIncrementBase);\n\n  const thisOffset = functionParameterNames[0] === 'this' ? 1 : 0;\n\n  for (const [\n    functionParameterIdx,\n    functionParameterName,\n  ] of functionParameterNames.entries()) {\n    let inc;\n    if (Array.isArray(functionParameterName)) {\n      const matchedJsdoc = shallowJsdocParameterNames[functionParameterIdx - thisOffset];\n\n      /** @type {string} */\n      let rootName;\n      if (functionParameterName[0]) {\n        rootName = functionParameterName[0];\n      } else if (matchedJsdoc && matchedJsdoc.name) {\n        rootName = matchedJsdoc.name;\n        if (matchedJsdoc.type && matchedJsdoc.type.search(checkTypesRegex) === -1) {\n          continue;\n        }\n      } else {\n        rootName = nextRootName;\n        inc = incremented;\n      }\n\n      [\n        nextRootName,\n        incremented,\n        namer,\n      ] = namer();\n\n      const {\n        hasPropertyRest,\n        hasRestElement,\n        names,\n        rests,\n      } = /**\n           * @type {import('../jsdocUtils.js').FlattendRootInfo & {\n           *   annotationParamName?: string | undefined;\n           * }}\n           */ (functionParameterName[1]);\n      const notCheckingNames = [];\n      if (!enableRestElementFixer && hasRestElement) {\n        continue;\n      }\n\n      if (!checkDestructuredRoots) {\n        continue;\n      }\n\n      for (const [\n        idx,\n        paramName,\n      ] of names.entries()) {\n        // Add root if the root name is not in the docs (and is not already\n        //  in the tags to be fixed)\n        if (!jsdocParameterNames.find(({\n          name,\n        }) => {\n          return name === rootName;\n        }) && !missingTags.find(({\n          functionParameterName: fpn,\n        }) => {\n          return fpn === rootName;\n        })) {\n          const emptyParamIdx = jsdocParameterNames.findIndex(({\n            name,\n          }) => {\n            return !name;\n          });\n\n          if (emptyParamIdx > -1) {\n            missingTags.push({\n              functionParameterIdx: emptyParamIdx,\n              functionParameterName: rootName,\n              inc,\n              remove: true,\n            });\n          } else {\n            missingTags.push({\n              functionParameterIdx: hasParamIndex(rootName) ?\n                getParamIndex(rootName) :\n                getParamIndex(paramName),\n              functionParameterName: rootName,\n              inc,\n            });\n          }\n        }\n\n        if (!checkDestructured) {\n          continue;\n        }\n\n        if (!checkRestProperty && rests[idx]) {\n          continue;\n        }\n\n        const fullParamName = `${rootName}.${paramName}`;\n\n        const notCheckingName = jsdocParameterNames.find(({\n          name,\n          type: paramType,\n        }) => {\n          return utils.comparePaths(name)(fullParamName) && paramType.search(checkTypesRegex) === -1 && paramType !== '';\n        });\n\n        if (notCheckingName !== undefined) {\n          notCheckingNames.push(notCheckingName.name);\n        }\n\n        if (notCheckingNames.find((name) => {\n          return fullParamName.startsWith(name);\n        })) {\n          continue;\n        }\n\n        if (jsdocParameterNames && !jsdocParameterNames.find(({\n          name,\n        }) => {\n          return utils.comparePaths(name)(fullParamName);\n        })) {\n          missingTags.push({\n            functionParameterIdx: getParamIndex(\n              functionParameterName[0] ? fullParamName : paramName,\n            ),\n            functionParameterName: fullParamName,\n            inc,\n            type: hasRestElement && !hasPropertyRest ? '{...any}' : undefined,\n          });\n        }\n      }\n\n      continue;\n    }\n\n    /** @type {string} */\n    let funcParamName;\n    let type;\n    if (typeof functionParameterName === 'object') {\n      if (!enableRestElementFixer && functionParameterName.restElement) {\n        continue;\n      }\n\n      funcParamName = /** @type {string} */ (functionParameterName.name);\n      type = '{...any}';\n    } else {\n      funcParamName = /** @type {string} */ (functionParameterName);\n    }\n\n    if (jsdocParameterNames && !jsdocParameterNames.find(({\n      name,\n    }) => {\n      return name === funcParamName;\n    }) && funcParamName !== 'this') {\n      missingTags.push({\n        functionParameterIdx: getParamIndex(funcParamName),\n        functionParameterName: funcParamName,\n        inc,\n        type,\n      });\n    }\n  }\n\n  /**\n   *\n   * @param {{\n   *   functionParameterIdx: import('../iterateJsdoc.js').Integer,\n   *   functionParameterName: string,\n   *   remove?: true,\n   *   inc?: boolean,\n   *   type?: string\n   * }} cfg\n   */\n  const fix = ({\n    functionParameterIdx,\n    functionParameterName,\n    inc,\n    remove,\n    type,\n  }) => {\n    if (inc && !enableRootFixer) {\n      return;\n    }\n\n    /**\n     *\n     * @param {import('../iterateJsdoc.js').Integer} tagIndex\n     * @param {import('../iterateJsdoc.js').Integer} sourceIndex\n     * @param {import('../iterateJsdoc.js').Integer} spliceCount\n     * @returns {void}\n     */\n    const createTokens = (tagIndex, sourceIndex, spliceCount) => {\n      // console.log(sourceIndex, tagIndex, jsdoc.tags, jsdoc.source);\n      const tokens = {\n        number: sourceIndex + 1,\n        source: '',\n        tokens: {\n          delimiter: '*',\n          description: '',\n          end: '',\n          lineEnd: '',\n          name: functionParameterName,\n          newAdd: true,\n          postDelimiter: ' ',\n          postName: '',\n          postTag: ' ',\n          postType: type ? ' ' : '',\n          start: jsdoc.source[sourceIndex].tokens.start,\n          tag: `@${preferredTagName}`,\n          type: type ?? '',\n        },\n      };\n\n      /**\n       * @type {(import('@es-joy/jsdoccomment').JsdocTagWithInline & {\n       *   newAdd?: true\n       * })[]}\n       */ (jsdoc.tags).splice(tagIndex, spliceCount, {\n        description: '',\n        inlineTags: [],\n        name: functionParameterName,\n        newAdd: true,\n        optional: false,\n        problems: [],\n        source: [\n          tokens,\n        ],\n        tag: preferredTagName,\n        type: type ?? '',\n      });\n      const firstNumber = jsdoc.source[0].number;\n      jsdoc.source.splice(sourceIndex, spliceCount, tokens);\n      for (const [\n        idx,\n        src,\n      ] of jsdoc.source.slice(sourceIndex).entries()) {\n        src.number = firstNumber + sourceIndex + idx;\n      }\n    };\n\n    const offset = jsdoc.source.findIndex(({\n      tokens: {\n        end,\n        tag,\n      },\n    }) => {\n      return tag || end;\n    });\n    if (remove) {\n      createTokens(functionParameterIdx, offset + functionParameterIdx, 1);\n    } else {\n      const expectedIdx = findExpectedIndex(jsdoc.tags, functionParameterIdx);\n      createTokens(expectedIdx, offset + expectedIdx, 0);\n    }\n  };\n\n  /**\n   * @returns {void}\n   */\n  const fixer = () => {\n    for (const missingTag of missingTags) {\n      fix(missingTag);\n    }\n  };\n\n  if (missingTags.length && jsdoc.source.length === 1) {\n    utils.makeMultiline();\n  }\n\n  for (const {\n    functionParameterName,\n  } of missingTags) {\n    utils.reportJSDoc(\n      `Missing JSDoc @${preferredTagName} \"${functionParameterName}\" declaration.`,\n      null,\n      enableFixer ? fixer : null,\n    );\n  }\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that all function parameters are documented.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          autoIncrementBase: {\n            default: 0,\n            type: 'integer',\n          },\n          checkConstructors: {\n            default: true,\n            type: 'boolean',\n          },\n          checkDestructured: {\n            default: true,\n            type: 'boolean',\n          },\n          checkDestructuredRoots: {\n            default: true,\n            type: 'boolean',\n          },\n          checkGetters: {\n            default: false,\n            type: 'boolean',\n          },\n          checkRestProperty: {\n            default: false,\n            type: 'boolean',\n          },\n          checkSetters: {\n            default: false,\n            type: 'boolean',\n          },\n          checkTypesPattern: {\n            type: 'string',\n          },\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          enableFixer: {\n            type: 'boolean',\n          },\n          enableRestElementFixer: {\n            type: 'boolean',\n          },\n          enableRootFixer: {\n            type: 'boolean',\n          },\n          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          ignoreWhenAllParamsMissing: {\n            type: 'boolean',\n          },\n          unnamedRootBase: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          useDefaultObjectProperties: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n\n  // We cannot cache comment nodes as the contexts may recur with the\n  //  same comment node but a different JS node, and we may need the different\n  //  JS node to ensure we iterate its context\n  noTracking: true,\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;;AAEA;AACA;AACA;AACA;AACA;AACA,MAAMG,SAAS,GAAGA,CAACC,YAAY,EAAEC,YAAY,KAAK;EAChD;EACA,IAAIC,IAAI;EACR,IAAIC,GAAG,GAAGF,YAAY;EACtB,MAAMG,WAAW,GAAGJ,YAAY,CAACK,MAAM,IAAI,CAAC;EAC5C,IAAID,WAAW,EAAE;IACf,MAAME,IAAI,GAAGN,YAAY,CAAC,CAAC,CAAC;IAC5B,MAAMO,MAAM,GAAGJ,GAAG,EAAE;IACpBD,IAAI,GAAG,GAAGI,IAAI,GAAGC,MAAM,EAAE;EAC3B,CAAC,MAAM;IACLL,IAAI,GAAG,qBAAuBF,YAAY,CAACQ,KAAK,CAAC,CAAE;EACrD;EAEA,OAAO,CACLN,IAAI,EACJE,WAAW,EACX,MAAM;IACJ,OAAOL,SAAS,CAACC,YAAY,EAAEG,GAAG,CAAC;EACrC,CAAC,CACF;AACH,CAAC;;AAED;AAAA,IAAAM,QAAA,GAAAC,OAAA,CAAAZ,OAAA,GACe,IAAAa,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,KAAK;EACLC;AACF,CAAC,KAAK;EACJ;EACA,IAAIA,KAAK,CAACC,SAAS,CAAC,CAAC,EAAE;IACrB;EACF;;EAEA;EACA,IAAID,KAAK,CAACE,MAAM,CAAC,MAAM,CAAC,EAAE;IACxB;EACF;EAEA,MAAM;IACJC,iBAAiB,GAAG,CAAC;IACrBC,iBAAiB,GAAG,IAAI;IACxBC,sBAAsB,GAAG,IAAI;IAC7BC,iBAAiB,GAAG,KAAK;IACzBC,iBAAiB,GAAG,gEAAgE;IACpFC,WAAW,GAAG,IAAI;IAClBC,sBAAsB,GAAG,IAAI;IAC7BC,eAAe,GAAG,IAAI;IACtBC,0BAA0B,GAAG,KAAK;IAClCC,eAAe,GAAG,CAChB,MAAM,CACP;IACDC,0BAA0B,GAAG;EAC/B,CAAC,GAAGf,OAAO,CAACgB,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,MAAMC,gBAAgB,GAAG,qBAAuBf,KAAK,CAACgB,mBAAmB,CAAC;IACxEC,OAAO,EAAE;EACX,CAAC,CAAE;EACH,IAAI,CAACF,gBAAgB,EAAE;IACrB;EACF;EAEA,MAAMG,sBAAsB,GAAGlB,KAAK,CAACmB,yBAAyB,CAACN,0BAA0B,CAAC;EAC1F,IAAI,CAACK,sBAAsB,CAAC3B,MAAM,EAAE;IAClC;EACF;EAEA,MAAM6B,mBAAmB;EACvB;AACJ;AACA;AACA;AACA;AACA;AACA;EAASpB,KAAK,CAACqB,gBAAgB,CAACN,gBAAgB,CAAE;EAEhD,IAAIJ,0BAA0B,IAAI,CAACS,mBAAmB,CAAC7B,MAAM,EAAE;IAC7D;EACF;EAEA,MAAM+B,0BAA0B,GAAGF,mBAAmB,CAACG,MAAM,CAAEC,GAAG,IAAK;IACrE,OAAO,CAACA,GAAG,CAACpC,IAAI,CAACqC,QAAQ,CAAC,GAAG,CAAC;EAChC,CAAC,CAAC,CAACC,GAAG,CAAC,CAACF,GAAG,EAAEnC,GAAG,KAAK;IACnB,OAAO;MACL,GAAGmC,GAAG;MACNnC;IACF,CAAC;EACH,CAAC,CAAC;EAEF,MAAMsC,eAAe,GAAG3B,KAAK,CAAC4B,kBAAkB,CAACrB,iBAAiB,CAAC;;EAEnE;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMsB,WAAW,GAAG,EAAE;EACtB,MAAMC,cAAc,GAAG9B,KAAK,CAAC+B,YAAY,CAACb,sBAAsB,CAAC,CAACc,KAAK;;EAEvE;AACF;AACA;AACA;AACA;EACE,MAAMC,UAAU,GAAG,CAAC,CAAC;;EAErB;AACF;AACA;AACA;EACE,MAAMC,aAAa,GAAIC,GAAG,IAAK;IAC7B,OAAOnC,KAAK,CAACoC,qBAAqB,CAACC,MAAM,CAACF,GAAG,CAAC,CAAC,IAAIF,UAAU;EAC/D,CAAC;;EAED;AACF;AACA;AACA;AACA;EACE,MAAMK,aAAa,GAAIH,GAAG,IAAK;IAC7B,OAAOF,UAAU,CAACjC,KAAK,CAACoC,qBAAqB,CAACC,MAAM,CAACF,GAAG,CAAC,CAAC,CAAC;EAC7D,CAAC;;EAED;AACF;AACA;AACA;AACA;AACA;EACE,MAAMI,aAAa,GAAGA,CAACJ,GAAG,EAAE9C,GAAG,KAAK;IAClC4C,UAAU,CAACjC,KAAK,CAACoC,qBAAqB,CAACC,MAAM,CAACF,GAAG,CAAC,CAAC,CAAC,GAAG9C,GAAG;EAC5D,CAAC;EAED,KAAK,MAAM,CACTA,GAAG,EACH8C,GAAG,CACJ,IAAIL,cAAc,CAACU,OAAO,CAAC,CAAC,EAAE;IAC7BD,aAAa,CAACJ,GAAG,EAAE9C,GAAG,CAAC;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMoD,iBAAiB,GAAGA,CAACC,SAAS,EAAEC,qBAAqB,KAAK;IAC9D,MAAMC,cAAc,GAAG1B,sBAAsB,CAAC2B,KAAK,CAACF,qBAAqB,IAAI,CAAC,CAAC;IAC/E,MAAMG,UAAU,GAAGJ,SAAS,CAACK,SAAS,CAAC,CAAC;MACtC3D,IAAI;MACJ4D;IACF,CAAC,KAAK;MACJ,OAAO,CAACA,MAAM,IAAIJ,cAAc,CAACK,IAAI,CAAEC,aAAa,IAAK;QACvD,IAAIC,KAAK,CAACC,OAAO,CAACF,aAAa,CAAC,EAAE;UAChC;YACE;AACZ;AACA;AACA;AACA;YAAiBA,aAAa,CAAC,CAAC,CAAC,CAAElB,KAAK,CAACP,QAAQ,CAACrC,IAAI;UAAC;QAE/C;QAEA,IAAI,OAAO8D,aAAa,KAAK,QAAQ,EAAE;UACrC,OAAO9D,IAAI,KAAK8D,aAAa,CAAC9D,IAAI;QACpC;QAEA,OAAOA,IAAI,KAAK8D,aAAa;MAC/B,CAAC,CAAC;IACJ,CAAC,CAAC;IAEF,MAAMG,IAAI,GAAGP,UAAU,GAAG,CAAC,CAAC,GAC1BJ,SAAS,CAACG,KAAK,CAAC,CAAC,EAAEC,UAAU,CAAC,GAC9BJ,SAAS,CAACnB,MAAM,CAAC,CAAC;MAChBC;IACF,CAAC,KAAK;MACJ,OAAOA,GAAG,KAAKT,gBAAgB;IACjC,CAAC,CAAC;IAEJ,IAAIuC,YAAY,GAAG,CAAC;IACpB,KAAK,MAAM;MACTC;IACF,CAAC,IAAIF,IAAI,EAAE;MACT,KAAK,MAAM;QACTG,MAAM,EAAE;UACNC;QACF;MACF,CAAC,IAAIF,MAAM,EAAE;QACX,IAAI,CAACE,GAAG,EAAE;UACRH,YAAY,EAAE;QAChB;MACF;IACF;IAEA,OAAOA,YAAY;EACrB,CAAC;EAED,IAAI,CACFI,YAAY,EACZpE,WAAW,EACXqE,KAAK,CACN,GAAG1E,SAAS,CAAC,CACZ,GAAG2B,eAAe,CACnB,EAAET,iBAAiB,CAAC;EAErB,MAAMyD,UAAU,GAAG1C,sBAAsB,CAAC,CAAC,CAAC,KAAK,MAAM,GAAG,CAAC,GAAG,CAAC;EAE/D,KAAK,MAAM,CACT2C,oBAAoB,EACpBC,qBAAqB,CACtB,IAAI5C,sBAAsB,CAACsB,OAAO,CAAC,CAAC,EAAE;IACrC,IAAIuB,GAAG;IACP,IAAIZ,KAAK,CAACC,OAAO,CAACU,qBAAqB,CAAC,EAAE;MACxC,MAAME,YAAY,GAAG1C,0BAA0B,CAACuC,oBAAoB,GAAGD,UAAU,CAAC;;MAElF;MACA,IAAIK,QAAQ;MACZ,IAAIH,qBAAqB,CAAC,CAAC,CAAC,EAAE;QAC5BG,QAAQ,GAAGH,qBAAqB,CAAC,CAAC,CAAC;MACrC,CAAC,MAAM,IAAIE,YAAY,IAAIA,YAAY,CAAC5E,IAAI,EAAE;QAC5C6E,QAAQ,GAAGD,YAAY,CAAC5E,IAAI;QAC5B,IAAI4E,YAAY,CAACE,IAAI,IAAIF,YAAY,CAACE,IAAI,CAACC,MAAM,CAACxC,eAAe,CAAC,KAAK,CAAC,CAAC,EAAE;UACzE;QACF;MACF,CAAC,MAAM;QACLsC,QAAQ,GAAGP,YAAY;QACvBK,GAAG,GAAGzE,WAAW;MACnB;MAEA,CACEoE,YAAY,EACZpE,WAAW,EACXqE,KAAK,CACN,GAAGA,KAAK,CAAC,CAAC;MAEX,MAAM;QACJS,eAAe;QACfC,cAAc;QACdrC,KAAK;QACLsC;MACF,CAAC;MAAG;AACV;AACA;AACA;AACA;MAAeR,qBAAqB,CAAC,CAAC,CAAE;MAClC,MAAMS,gBAAgB,GAAG,EAAE;MAC3B,IAAI,CAAC9D,sBAAsB,IAAI4D,cAAc,EAAE;QAC7C;MACF;MAEA,IAAI,CAAChE,sBAAsB,EAAE;QAC3B;MACF;MAEA,KAAK,MAAM,CACThB,GAAG,EACHmF,SAAS,CACV,IAAIxC,KAAK,CAACQ,OAAO,CAAC,CAAC,EAAE;QACpB;QACA;QACA,IAAI,CAACpB,mBAAmB,CAACqD,IAAI,CAAC,CAAC;UAC7BrF;QACF,CAAC,KAAK;UACJ,OAAOA,IAAI,KAAK6E,QAAQ;QAC1B,CAAC,CAAC,IAAI,CAACpC,WAAW,CAAC4C,IAAI,CAAC,CAAC;UACvBX,qBAAqB,EAAEY;QACzB,CAAC,KAAK;UACJ,OAAOA,GAAG,KAAKT,QAAQ;QACzB,CAAC,CAAC,EAAE;UACF,MAAMU,aAAa,GAAGvD,mBAAmB,CAAC2B,SAAS,CAAC,CAAC;YACnD3D;UACF,CAAC,KAAK;YACJ,OAAO,CAACA,IAAI;UACd,CAAC,CAAC;UAEF,IAAIuF,aAAa,GAAG,CAAC,CAAC,EAAE;YACtB9C,WAAW,CAAC+C,IAAI,CAAC;cACff,oBAAoB,EAAEc,aAAa;cACnCb,qBAAqB,EAAEG,QAAQ;cAC/BF,GAAG;cACHc,MAAM,EAAE;YACV,CAAC,CAAC;UACJ,CAAC,MAAM;YACLhD,WAAW,CAAC+C,IAAI,CAAC;cACff,oBAAoB,EAAE3B,aAAa,CAAC+B,QAAQ,CAAC,GAC3C3B,aAAa,CAAC2B,QAAQ,CAAC,GACvB3B,aAAa,CAACkC,SAAS,CAAC;cAC1BV,qBAAqB,EAAEG,QAAQ;cAC/BF;YACF,CAAC,CAAC;UACJ;QACF;QAEA,IAAI,CAAC3D,iBAAiB,EAAE;UACtB;QACF;QAEA,IAAI,CAACE,iBAAiB,IAAIgE,KAAK,CAACjF,GAAG,CAAC,EAAE;UACpC;QACF;QAEA,MAAMyF,aAAa,GAAG,GAAGb,QAAQ,IAAIO,SAAS,EAAE;QAEhD,MAAMO,eAAe,GAAG3D,mBAAmB,CAACqD,IAAI,CAAC,CAAC;UAChDrF,IAAI;UACJ8E,IAAI,EAAEc;QACR,CAAC,KAAK;UACJ,OAAOhF,KAAK,CAACiF,YAAY,CAAC7F,IAAI,CAAC,CAAC0F,aAAa,CAAC,IAAIE,SAAS,CAACb,MAAM,CAACxC,eAAe,CAAC,KAAK,CAAC,CAAC,IAAIqD,SAAS,KAAK,EAAE;QAChH,CAAC,CAAC;QAEF,IAAID,eAAe,KAAKG,SAAS,EAAE;UACjCX,gBAAgB,CAACK,IAAI,CAACG,eAAe,CAAC3F,IAAI,CAAC;QAC7C;QAEA,IAAImF,gBAAgB,CAACE,IAAI,CAAErF,IAAI,IAAK;UAClC,OAAO0F,aAAa,CAACK,UAAU,CAAC/F,IAAI,CAAC;QACvC,CAAC,CAAC,EAAE;UACF;QACF;QAEA,IAAIgC,mBAAmB,IAAI,CAACA,mBAAmB,CAACqD,IAAI,CAAC,CAAC;UACpDrF;QACF,CAAC,KAAK;UACJ,OAAOY,KAAK,CAACiF,YAAY,CAAC7F,IAAI,CAAC,CAAC0F,aAAa,CAAC;QAChD,CAAC,CAAC,EAAE;UACFjD,WAAW,CAAC+C,IAAI,CAAC;YACff,oBAAoB,EAAEvB,aAAa,CACjCwB,qBAAqB,CAAC,CAAC,CAAC,GAAGgB,aAAa,GAAGN,SAC7C,CAAC;YACDV,qBAAqB,EAAEgB,aAAa;YACpCf,GAAG;YACHG,IAAI,EAAEG,cAAc,IAAI,CAACD,eAAe,GAAG,UAAU,GAAGc;UAC1D,CAAC,CAAC;QACJ;MACF;MAEA;IACF;;IAEA;IACA,IAAIE,aAAa;IACjB,IAAIlB,IAAI;IACR,IAAI,OAAOJ,qBAAqB,KAAK,QAAQ,EAAE;MAC7C,IAAI,CAACrD,sBAAsB,IAAIqD,qBAAqB,CAACuB,WAAW,EAAE;QAChE;MACF;MAEAD,aAAa,GAAG,qBAAuBtB,qBAAqB,CAAC1E,IAAK;MAClE8E,IAAI,GAAG,UAAU;IACnB,CAAC,MAAM;MACLkB,aAAa,GAAG,qBAAuBtB,qBAAsB;IAC/D;IAEA,IAAI1C,mBAAmB,IAAI,CAACA,mBAAmB,CAACqD,IAAI,CAAC,CAAC;MACpDrF;IACF,CAAC,KAAK;MACJ,OAAOA,IAAI,KAAKgG,aAAa;IAC/B,CAAC,CAAC,IAAIA,aAAa,KAAK,MAAM,EAAE;MAC9BvD,WAAW,CAAC+C,IAAI,CAAC;QACff,oBAAoB,EAAEvB,aAAa,CAAC8C,aAAa,CAAC;QAClDtB,qBAAqB,EAAEsB,aAAa;QACpCrB,GAAG;QACHG;MACF,CAAC,CAAC;IACJ;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMoB,GAAG,GAAGA,CAAC;IACXzB,oBAAoB;IACpBC,qBAAqB;IACrBC,GAAG;IACHc,MAAM;IACNX;EACF,CAAC,KAAK;IACJ,IAAIH,GAAG,IAAI,CAACrD,eAAe,EAAE;MAC3B;IACF;;IAEA;AACJ;AACA;AACA;AACA;AACA;AACA;IACI,MAAM6E,YAAY,GAAGA,CAACC,QAAQ,EAAEC,WAAW,EAAEC,WAAW,KAAK;MAC3D;MACA,MAAMlC,MAAM,GAAG;QACbmC,MAAM,EAAEF,WAAW,GAAG,CAAC;QACvBlC,MAAM,EAAE,EAAE;QACVC,MAAM,EAAE;UACNoC,SAAS,EAAE,GAAG;UACdC,WAAW,EAAE,EAAE;UACfpC,GAAG,EAAE,EAAE;UACPqC,OAAO,EAAE,EAAE;UACX1G,IAAI,EAAE0E,qBAAqB;UAC3Bd,MAAM,EAAE,IAAI;UACZ+C,aAAa,EAAE,GAAG;UAClBC,QAAQ,EAAE,EAAE;UACZC,OAAO,EAAE,GAAG;UACZC,QAAQ,EAAEhC,IAAI,GAAG,GAAG,GAAG,EAAE;UACzBiC,KAAK,EAAEpG,KAAK,CAACwD,MAAM,CAACkC,WAAW,CAAC,CAACjC,MAAM,CAAC2C,KAAK;UAC7C3E,GAAG,EAAE,IAAIT,gBAAgB,EAAE;UAC3BmD,IAAI,EAAEA,IAAI,IAAI;QAChB;MACF,CAAC;;MAED;AACN;AACA;AACA;AACA;MAAWnE,KAAK,CAACsD,IAAI,CAAE+C,MAAM,CAACZ,QAAQ,EAAEE,WAAW,EAAE;QAC7CG,WAAW,EAAE,EAAE;QACfQ,UAAU,EAAE,EAAE;QACdjH,IAAI,EAAE0E,qBAAqB;QAC3Bd,MAAM,EAAE,IAAI;QACZsD,QAAQ,EAAE,KAAK;QACfC,QAAQ,EAAE,EAAE;QACZhD,MAAM,EAAE,CACNC,MAAM,CACP;QACDhC,GAAG,EAAET,gBAAgB;QACrBmD,IAAI,EAAEA,IAAI,IAAI;MAChB,CAAC,CAAC;MACF,MAAMsC,WAAW,GAAGzG,KAAK,CAACwD,MAAM,CAAC,CAAC,CAAC,CAACoC,MAAM;MAC1C5F,KAAK,CAACwD,MAAM,CAAC6C,MAAM,CAACX,WAAW,EAAEC,WAAW,EAAElC,MAAM,CAAC;MACrD,KAAK,MAAM,CACTnE,GAAG,EACHoH,GAAG,CACJ,IAAI1G,KAAK,CAACwD,MAAM,CAACV,KAAK,CAAC4C,WAAW,CAAC,CAACjD,OAAO,CAAC,CAAC,EAAE;QAC9CiE,GAAG,CAACd,MAAM,GAAGa,WAAW,GAAGf,WAAW,GAAGpG,GAAG;MAC9C;IACF,CAAC;IAED,MAAMqH,MAAM,GAAG3G,KAAK,CAACwD,MAAM,CAACR,SAAS,CAAC,CAAC;MACrCS,MAAM,EAAE;QACNC,GAAG;QACHjC;MACF;IACF,CAAC,KAAK;MACJ,OAAOA,GAAG,IAAIiC,GAAG;IACnB,CAAC,CAAC;IACF,IAAIoB,MAAM,EAAE;MACVU,YAAY,CAAC1B,oBAAoB,EAAE6C,MAAM,GAAG7C,oBAAoB,EAAE,CAAC,CAAC;IACtE,CAAC,MAAM;MACL,MAAM8C,WAAW,GAAGlE,iBAAiB,CAAC1C,KAAK,CAACsD,IAAI,EAAEQ,oBAAoB,CAAC;MACvE0B,YAAY,CAACoB,WAAW,EAAED,MAAM,GAAGC,WAAW,EAAE,CAAC,CAAC;IACpD;EACF,CAAC;;EAED;AACF;AACA;EACE,MAAMC,KAAK,GAAGA,CAAA,KAAM;IAClB,KAAK,MAAMC,UAAU,IAAIhF,WAAW,EAAE;MACpCyD,GAAG,CAACuB,UAAU,CAAC;IACjB;EACF,CAAC;EAED,IAAIhF,WAAW,CAACtC,MAAM,IAAIQ,KAAK,CAACwD,MAAM,CAAChE,MAAM,KAAK,CAAC,EAAE;IACnDS,KAAK,CAAC8G,aAAa,CAAC,CAAC;EACvB;EAEA,KAAK,MAAM;IACThD;EACF,CAAC,IAAIjC,WAAW,EAAE;IAChB7B,KAAK,CAAC+G,WAAW,CACf,kBAAkBhG,gBAAgB,KAAK+C,qBAAqB,gBAAgB,EAC5E,IAAI,EACJtD,WAAW,GAAGoG,KAAK,GAAG,IACxB,CAAC;EACH;AACF,CAAC,EAAE;EACDI,eAAe,EAAE,IAAI;EACrBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJrB,WAAW,EAAE,uDAAuD;MACpEsB,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVpH,iBAAiB,EAAE;UACjBnB,OAAO,EAAE,CAAC;UACVkF,IAAI,EAAE;QACR,CAAC;QACDsD,iBAAiB,EAAE;UACjBxI,OAAO,EAAE,IAAI;UACbkF,IAAI,EAAE;QACR,CAAC;QACD9D,iBAAiB,EAAE;UACjBpB,OAAO,EAAE,IAAI;UACbkF,IAAI,EAAE;QACR,CAAC;QACD7D,sBAAsB,EAAE;UACtBrB,OAAO,EAAE,IAAI;UACbkF,IAAI,EAAE;QACR,CAAC;QACDuD,YAAY,EAAE;UACZzI,OAAO,EAAE,KAAK;UACdkF,IAAI,EAAE;QACR,CAAC;QACD5D,iBAAiB,EAAE;UACjBtB,OAAO,EAAE,KAAK;UACdkF,IAAI,EAAE;QACR,CAAC;QACDwD,YAAY,EAAE;UACZ1I,OAAO,EAAE,KAAK;UACdkF,IAAI,EAAE;QACR,CAAC;QACD3D,iBAAiB,EAAE;UACjB2D,IAAI,EAAE;QACR,CAAC;QACDyD,QAAQ,EAAE;UACRC,KAAK,EAAE;YACLC,KAAK,EAAE,CACL;cACE3D,IAAI,EAAE;YACR,CAAC,EACD;cACEoD,oBAAoB,EAAE,KAAK;cAC3BC,UAAU,EAAE;gBACVO,OAAO,EAAE;kBACP5D,IAAI,EAAE;gBACR,CAAC;gBACDpE,OAAO,EAAE;kBACPoE,IAAI,EAAE;gBACR;cACF,CAAC;cACDA,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACD1D,WAAW,EAAE;UACX0D,IAAI,EAAE;QACR,CAAC;QACDzD,sBAAsB,EAAE;UACtByD,IAAI,EAAE;QACR,CAAC;QACDxD,eAAe,EAAE;UACfwD,IAAI,EAAE;QACR,CAAC;QACD6D,UAAU,EAAE;UACVH,KAAK,EAAE;YACL1D,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACDvD,0BAA0B,EAAE;UAC1BuD,IAAI,EAAE;QACR,CAAC;QACDtD,eAAe,EAAE;UACfgH,KAAK,EAAE;YACL1D,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACDrD,0BAA0B,EAAE;UAC1BqD,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR,CAAC;EAED;EACA;EACA;EACA8D,UAAU,EAAE;AACd,CAAC,CAAC;AAAAC,MAAA,CAAArI,OAAA,GAAAA,OAAA,CAAAZ,OAAA","ignoreList":[]}
+{"version":3,"file":"requireParam.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/requireParam.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @typedef {[string, boolean, () => RootNamerReturn]} RootNamerReturn\n */\n\n/**\n * @param {string[]} desiredRoots\n * @param {number} currentIndex\n * @returns {RootNamerReturn}\n */\nconst rootNamer = (desiredRoots, currentIndex) => {\n  /** @type {string} */\n  let name;\n  let idx = currentIndex;\n  const incremented = desiredRoots.length <= 1;\n  if (incremented) {\n    const base = desiredRoots[0];\n    const suffix = idx++;\n    name = `${base}${suffix}`;\n  } else {\n    name = /** @type {string} */ (desiredRoots.shift());\n  }\n\n  return [\n    name,\n    incremented,\n    () => {\n      return rootNamer(desiredRoots, idx);\n    },\n  ];\n};\n\n/* eslint-disable complexity -- Temporary */\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  /* eslint-enable complexity -- Temporary */\n  if (utils.avoidDocs()) {\n    return;\n  }\n\n  // Param type is specified by type in @type\n  if (utils.hasTag('type')) {\n    return;\n  }\n\n  const {\n    autoIncrementBase = 0,\n    checkDestructured = true,\n    checkDestructuredRoots = true,\n    checkRestProperty = false,\n    checkTypesPattern = '/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/',\n    enableFixer = true,\n    enableRestElementFixer = true,\n    enableRootFixer = true,\n    ignoreWhenAllParamsMissing = false,\n    unnamedRootBase = [\n      'root',\n    ],\n    useDefaultObjectProperties = false,\n  } = context.options[0] || {};\n\n  const preferredTagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'param',\n  }));\n  if (!preferredTagName) {\n    return;\n  }\n\n  const functionParameterNames = utils.getFunctionParameterNames(useDefaultObjectProperties);\n  if (!functionParameterNames.length) {\n    return;\n  }\n\n  const jsdocParameterNames =\n    /**\n     * @type {{\n     *   idx: import('../iterateJsdoc.js').Integer;\n     *   name: string;\n     *   type: string;\n     * }[]}\n     */ (utils.getJsdocTagsDeep(preferredTagName));\n\n  if (ignoreWhenAllParamsMissing && !jsdocParameterNames.length) {\n    return;\n  }\n\n  const shallowJsdocParameterNames = jsdocParameterNames.filter((tag) => {\n    return !tag.name.includes('.');\n  }).map((tag, idx) => {\n    return {\n      ...tag,\n      idx,\n    };\n  });\n\n  const checkTypesRegex = utils.getRegexFromString(checkTypesPattern);\n\n  /**\n   * @type {{\n   *   functionParameterIdx: import('../iterateJsdoc.js').Integer,\n   *   functionParameterName: string,\n   *   inc: boolean|undefined,\n   *   remove?: true,\n   *   type?: string|undefined\n   * }[]}\n   */\n  const missingTags = [];\n  const flattenedRoots = utils.flattenRoots(functionParameterNames).names;\n\n  /**\n   * @type {{\n   *   [key: string]: import('../iterateJsdoc.js').Integer\n   * }}\n   */\n  const paramIndex = {};\n\n  /**\n   * @param {string} cur\n   * @returns {boolean}\n   */\n  const hasParamIndex = (cur) => {\n    return utils.dropPathSegmentQuotes(String(cur)) in paramIndex;\n  };\n\n  /**\n   *\n   * @param {string|number|undefined} cur\n   * @returns {import('../iterateJsdoc.js').Integer}\n   */\n  const getParamIndex = (cur) => {\n    return paramIndex[utils.dropPathSegmentQuotes(String(cur))];\n  };\n\n  /**\n   *\n   * @param {string} cur\n   * @param {import('../iterateJsdoc.js').Integer} idx\n   * @returns {void}\n   */\n  const setParamIndex = (cur, idx) => {\n    paramIndex[utils.dropPathSegmentQuotes(String(cur))] = idx;\n  };\n\n  for (const [\n    idx,\n    cur,\n  ] of flattenedRoots.entries()) {\n    setParamIndex(cur, idx);\n  }\n\n  /**\n   *\n   * @param {(import('@es-joy/jsdoccomment').JsdocTagWithInline & {\n   *   newAdd?: boolean\n   * })[]} jsdocTags\n   * @param {import('../iterateJsdoc.js').Integer} indexAtFunctionParams\n   * @returns {import('../iterateJsdoc.js').Integer}\n   */\n  const findExpectedIndex = (jsdocTags, indexAtFunctionParams) => {\n    const remainingRoots = functionParameterNames.slice(indexAtFunctionParams || 0);\n    const foundIndex = jsdocTags.findIndex(({\n      name,\n      newAdd,\n    }) => {\n      return !newAdd && remainingRoots.some((remainingRoot) => {\n        if (Array.isArray(remainingRoot)) {\n          return (\n            /**\n             * @type {import('../jsdocUtils.js').FlattendRootInfo & {\n             *   annotationParamName?: string|undefined;\n             * }}\n             */ (remainingRoot[1]).names.includes(name)\n          );\n        }\n\n        if (typeof remainingRoot === 'object') {\n          return name === remainingRoot.name;\n        }\n\n        return name === remainingRoot;\n      });\n    });\n\n    const tags = foundIndex > -1 ?\n      jsdocTags.slice(0, foundIndex) :\n      jsdocTags.filter(({\n        tag,\n      }) => {\n        return tag === preferredTagName;\n      });\n\n    let tagLineCount = 0;\n    for (const {\n      source,\n    } of tags) {\n      for (const {\n        tokens: {\n          end,\n        },\n      } of source) {\n        if (!end) {\n          tagLineCount++;\n        }\n      }\n    }\n\n    return tagLineCount;\n  };\n\n  let [\n    nextRootName,\n    incremented,\n    namer,\n  ] = rootNamer([\n    ...unnamedRootBase,\n  ], autoIncrementBase);\n\n  const thisOffset = functionParameterNames[0] === 'this' ? 1 : 0;\n\n  for (const [\n    functionParameterIdx,\n    functionParameterName,\n  ] of functionParameterNames.entries()) {\n    let inc;\n    if (Array.isArray(functionParameterName)) {\n      const matchedJsdoc = shallowJsdocParameterNames[functionParameterIdx - thisOffset];\n\n      /** @type {string} */\n      let rootName;\n      if (functionParameterName[0]) {\n        rootName = functionParameterName[0];\n      } else if (matchedJsdoc && matchedJsdoc.name) {\n        rootName = matchedJsdoc.name;\n        if (matchedJsdoc.type && matchedJsdoc.type.search(checkTypesRegex) === -1) {\n          continue;\n        }\n      } else {\n        rootName = nextRootName;\n        inc = incremented;\n      }\n\n      [\n        nextRootName,\n        incremented,\n        namer,\n      ] = namer();\n\n      const {\n        hasPropertyRest,\n        hasRestElement,\n        names,\n        rests,\n      } = /**\n           * @type {import('../jsdocUtils.js').FlattendRootInfo & {\n           *   annotationParamName?: string | undefined;\n           * }}\n           */ (functionParameterName[1]);\n      const notCheckingNames = [];\n      if (!enableRestElementFixer && hasRestElement) {\n        continue;\n      }\n\n      if (!checkDestructuredRoots) {\n        continue;\n      }\n\n      for (const [\n        idx,\n        paramName,\n      ] of names.entries()) {\n        // Add root if the root name is not in the docs (and is not already\n        //  in the tags to be fixed)\n        if (!jsdocParameterNames.find(({\n          name,\n        }) => {\n          return name === rootName;\n        }) && !missingTags.find(({\n          functionParameterName: fpn,\n        }) => {\n          return fpn === rootName;\n        })) {\n          const emptyParamIdx = jsdocParameterNames.findIndex(({\n            name,\n          }) => {\n            return !name;\n          });\n\n          if (emptyParamIdx > -1) {\n            missingTags.push({\n              functionParameterIdx: emptyParamIdx,\n              functionParameterName: rootName,\n              inc,\n              remove: true,\n            });\n          } else {\n            missingTags.push({\n              functionParameterIdx: hasParamIndex(rootName) ?\n                getParamIndex(rootName) :\n                getParamIndex(paramName),\n              functionParameterName: rootName,\n              inc,\n            });\n          }\n        }\n\n        if (!checkDestructured) {\n          continue;\n        }\n\n        if (!checkRestProperty && rests[idx]) {\n          continue;\n        }\n\n        const fullParamName = `${rootName}.${paramName}`;\n\n        const notCheckingName = jsdocParameterNames.find(({\n          name,\n          type: paramType,\n        }) => {\n          return utils.comparePaths(name)(fullParamName) && paramType.search(checkTypesRegex) === -1 && paramType !== '';\n        });\n\n        if (notCheckingName !== undefined) {\n          notCheckingNames.push(notCheckingName.name);\n        }\n\n        if (notCheckingNames.find((name) => {\n          return fullParamName.startsWith(name);\n        })) {\n          continue;\n        }\n\n        if (jsdocParameterNames && !jsdocParameterNames.find(({\n          name,\n        }) => {\n          return utils.comparePaths(name)(fullParamName);\n        })) {\n          missingTags.push({\n            functionParameterIdx: getParamIndex(\n              functionParameterName[0] ? fullParamName : paramName,\n            ),\n            functionParameterName: fullParamName,\n            inc,\n            type: hasRestElement && !hasPropertyRest ? '{...any}' : undefined,\n          });\n        }\n      }\n\n      continue;\n    }\n\n    /** @type {string} */\n    let funcParamName;\n    let type;\n    if (typeof functionParameterName === 'object') {\n      if (!enableRestElementFixer && functionParameterName.restElement) {\n        continue;\n      }\n\n      funcParamName = /** @type {string} */ (functionParameterName.name);\n      type = '{...any}';\n    } else {\n      funcParamName = /** @type {string} */ (functionParameterName);\n    }\n\n    if (jsdocParameterNames && !jsdocParameterNames.find(({\n      name,\n    }) => {\n      return name === funcParamName;\n    }) && funcParamName !== 'this') {\n      missingTags.push({\n        functionParameterIdx: getParamIndex(funcParamName),\n        functionParameterName: funcParamName,\n        inc,\n        type,\n      });\n    }\n  }\n\n  /**\n   *\n   * @param {{\n   *   functionParameterIdx: import('../iterateJsdoc.js').Integer,\n   *   functionParameterName: string,\n   *   remove?: true,\n   *   inc?: boolean,\n   *   type?: string\n   * }} cfg\n   */\n  const fix = ({\n    functionParameterIdx,\n    functionParameterName,\n    inc,\n    remove,\n    type,\n  }) => {\n    if (inc && !enableRootFixer) {\n      return;\n    }\n\n    /**\n     *\n     * @param {import('../iterateJsdoc.js').Integer} tagIndex\n     * @param {import('../iterateJsdoc.js').Integer} sourceIndex\n     * @param {import('../iterateJsdoc.js').Integer} spliceCount\n     * @returns {void}\n     */\n    const createTokens = (tagIndex, sourceIndex, spliceCount) => {\n      // console.log(sourceIndex, tagIndex, jsdoc.tags, jsdoc.source);\n      const tokens = {\n        number: sourceIndex + 1,\n        source: '',\n        tokens: {\n          delimiter: '*',\n          description: '',\n          end: '',\n          lineEnd: '',\n          name: functionParameterName,\n          newAdd: true,\n          postDelimiter: ' ',\n          postName: '',\n          postTag: ' ',\n          postType: type ? ' ' : '',\n          start: jsdoc.source[sourceIndex].tokens.start,\n          tag: `@${preferredTagName}`,\n          type: type ?? '',\n        },\n      };\n\n      /**\n       * @type {(import('@es-joy/jsdoccomment').JsdocTagWithInline & {\n       *   newAdd?: true\n       * })[]}\n       */ (jsdoc.tags).splice(tagIndex, spliceCount, {\n        description: '',\n        inlineTags: [],\n        name: functionParameterName,\n        newAdd: true,\n        optional: false,\n        problems: [],\n        source: [\n          tokens,\n        ],\n        tag: preferredTagName,\n        type: type ?? '',\n      });\n      const firstNumber = jsdoc.source[0].number;\n      jsdoc.source.splice(sourceIndex, spliceCount, tokens);\n      for (const [\n        idx,\n        src,\n      ] of jsdoc.source.slice(sourceIndex).entries()) {\n        src.number = firstNumber + sourceIndex + idx;\n      }\n    };\n\n    const offset = jsdoc.source.findIndex(({\n      tokens: {\n        end,\n        tag,\n      },\n    }) => {\n      return tag || end;\n    });\n    if (remove) {\n      createTokens(functionParameterIdx, offset + functionParameterIdx, 1);\n    } else {\n      const expectedIdx = findExpectedIndex(jsdoc.tags, functionParameterIdx);\n      createTokens(expectedIdx, offset + expectedIdx, 0);\n    }\n  };\n\n  /**\n   * @returns {void}\n   */\n  const fixer = () => {\n    for (const missingTag of missingTags) {\n      fix(missingTag);\n    }\n  };\n\n  if (missingTags.length && jsdoc.source.length === 1) {\n    utils.makeMultiline();\n  }\n\n  for (const {\n    functionParameterName,\n  } of missingTags) {\n    utils.reportJSDoc(\n      `Missing JSDoc @${preferredTagName} \"${functionParameterName}\" declaration.`,\n      null,\n      enableFixer ? fixer : null,\n    );\n  }\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that all function parameters are documented.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          autoIncrementBase: {\n            default: 0,\n            type: 'integer',\n          },\n          checkConstructors: {\n            default: true,\n            type: 'boolean',\n          },\n          checkDestructured: {\n            default: true,\n            type: 'boolean',\n          },\n          checkDestructuredRoots: {\n            default: true,\n            type: 'boolean',\n          },\n          checkGetters: {\n            default: false,\n            type: 'boolean',\n          },\n          checkRestProperty: {\n            default: false,\n            type: 'boolean',\n          },\n          checkSetters: {\n            default: false,\n            type: 'boolean',\n          },\n          checkTypesPattern: {\n            type: 'string',\n          },\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          enableFixer: {\n            type: 'boolean',\n          },\n          enableRestElementFixer: {\n            type: 'boolean',\n          },\n          enableRootFixer: {\n            type: 'boolean',\n          },\n          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          ignoreWhenAllParamsMissing: {\n            type: 'boolean',\n          },\n          unnamedRootBase: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          useDefaultObjectProperties: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n\n  // We cannot cache comment nodes as the contexts may recur with the\n  //  same comment node but a different JS node, and we may need the different\n  //  JS node to ensure we iterate its context\n  noTracking: true,\n});\n"],"mappings":";;;;;;;;;;;AAWA,MAAM,YAAY,CAAC,cAAc,iBAAiB;;CAEhD,IAAI;CACJ,IAAI,MAAM;CACV,MAAM,cAAc,aAAa,UAAU;AAC3C,KAAI,aAAa;EACf,MAAM,OAAO,aAAa;EAC1B,MAAM,SAAS;EACf,OAAO,GAAG,OAAO,QAAQ;CAC1B,OACC,OAA8B,aAAa,OAAO;AAGpD,QAAO;EACL;EACA;EACA,MAAM;AACJ,UAAO,UAAU,cAAc,IAAI;EACpC;CACF;AACF;AAGD,2BAAeA,6BAAa,CAAC,EAC3B,SACA,OACA,OACD,KAAK;AAEJ,KAAI,MAAM,WAAW,CACnB;AAIF,KAAI,MAAM,OAAO,OAAO,CACtB;CAGF,MAAM,EACJ,oBAAoB,GACpB,oBAAoB,MACpB,yBAAyB,MACzB,oBAAoB,OACpB,oBAAoB,kEACpB,cAAc,MACd,yBAAyB,MACzB,kBAAkB,MAClB,6BAA6B,OAC7B,kBAAkB,CAChB,MACD,GACD,6BAA6B,OAC9B,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,MAAM,mBAA0C,MAAM,oBAAoB,EACxE,SAAS,QACV,EAAC;AACF,KAAI,CAAC,iBACH;CAGF,MAAM,yBAAyB,MAAM,0BAA0B,2BAA2B;AAC1F,KAAI,CAAC,uBAAuB,OAC1B;CAGF,MAAM,sBAOC,MAAM,iBAAiB,iBAAiB;AAE/C,KAAI,8BAA8B,CAAC,oBAAoB,OACrD;CAGF,MAAM,6BAA6B,oBAAoB,OAAO,CAAC,QAAQ;AACrE,SAAO,CAAC,IAAI,KAAK,SAAS,IAAI;CAC/B,EAAC,CAAC,IAAI,CAAC,KAAK,QAAQ;AACnB,SAAO;GACL,GAAG;GACH;EACD;CACF,EAAC;CAEF,MAAM,kBAAkB,MAAM,mBAAmB,kBAAkB;;;;;;;;;;CAWnE,MAAM,cAAc,CAAE;CACtB,MAAM,iBAAiB,MAAM,aAAa,uBAAuB,CAAC;;;;;;CAOlE,MAAM,aAAa,CAAE;;;;;CAMrB,MAAM,gBAAgB,CAAC,QAAQ;AAC7B,SAAO,MAAM,sBAAsB,OAAO,IAAI,CAAC,IAAI;CACpD;;;;;;CAOD,MAAM,gBAAgB,CAAC,QAAQ;AAC7B,SAAO,WAAW,MAAM,sBAAsB,OAAO,IAAI,CAAC;CAC3D;;;;;;;CAQD,MAAM,gBAAgB,CAAC,KAAK,QAAQ;EAClC,WAAW,MAAM,sBAAsB,OAAO,IAAI,CAAC,IAAI;CACxD;AAED,MAAK,MAAM,CACT,KACA,IACD,IAAI,eAAe,SAAS,EAC3B,cAAc,KAAK,IAAI;;;;;;;;;CAWzB,MAAM,oBAAoB,CAAC,WAAW,0BAA0B;EAC9D,MAAM,iBAAiB,uBAAuB,MAAM,yBAAyB,EAAE;EAC/E,MAAM,aAAa,UAAU,UAAU,CAAC,EACtC,MACA,QACD,KAAK;AACJ,UAAO,CAAC,UAAU,eAAe,KAAK,CAAC,kBAAkB;AACvD,QAAI,MAAM,QAAQ,cAAc,CAC9B,QAKO,cAAc,GAAI,MAAM,SAAS,KAAK;AAI/C,QAAI,OAAO,kBAAkB,SAC3B,QAAO,SAAS,cAAc;AAGhC,WAAO,SAAS;GACjB,EAAC;EACH,EAAC;EAEF,MAAM,OAAO,aAAa,KACxB,UAAU,MAAM,GAAG,WAAW,GAC9B,UAAU,OAAO,CAAC,EAChB,KACD,KAAK;AACJ,UAAO,QAAQ;EAChB,EAAC;EAEJ,IAAI,eAAe;AACnB,OAAK,MAAM,EACT,QACD,IAAI,KACH,MAAK,MAAM,EACT,QAAQ,EACN,KACD,EACF,IAAI,OACH,KAAI,CAAC,KACH;AAKN,SAAO;CACR;CAED,IAAI,CACF,cACA,aACA,MACD,GAAG,UAAU,CACZ,GAAG,eACJ,GAAE,kBAAkB;CAErB,MAAM,aAAa,uBAAuB,OAAO,SAAS,IAAI;AAE9D,MAAK,MAAM,CACT,sBACA,sBACD,IAAI,uBAAuB,SAAS,EAAE;EACrC,IAAI;AACJ,MAAI,MAAM,QAAQ,sBAAsB,EAAE;GACxC,MAAM,eAAe,2BAA2B,uBAAuB;;GAGvE,IAAI;AACJ,OAAI,sBAAsB,IACxB,WAAW,sBAAsB;YACxB,gBAAgB,aAAa,MAAM;IAC5C,WAAW,aAAa;AACxB,QAAI,aAAa,QAAQ,aAAa,KAAK,OAAO,gBAAgB,KAAK,GACrE;GAEH,OAAM;IACL,WAAW;IACX,MAAM;GACP;GAED,CACE,cACA,aACA,MACD,GAAG,OAAO;GAEX,MAAM,EACJ,iBACA,gBACA,OACA,OACD,GAIQ,sBAAsB;GAC/B,MAAM,mBAAmB,CAAE;AAC3B,OAAI,CAAC,0BAA0B,eAC7B;AAGF,OAAI,CAAC,uBACH;AAGF,QAAK,MAAM,CACT,KACA,UACD,IAAI,MAAM,SAAS,EAAE;AAGpB,QAAI,CAAC,oBAAoB,KAAK,CAAC,EAC7B,MACD,KAAK;AACJ,YAAO,SAAS;IACjB,EAAC,IAAI,CAAC,YAAY,KAAK,CAAC,EACvB,uBAAuB,KACxB,KAAK;AACJ,YAAO,QAAQ;IAChB,EAAC,EAAE;KACF,MAAM,gBAAgB,oBAAoB,UAAU,CAAC,EACnD,MACD,KAAK;AACJ,aAAO,CAAC;KACT,EAAC;AAEF,SAAI,gBAAgB,IAClB,YAAY,KAAK;MACf,sBAAsB;MACtB,uBAAuB;MACvB;MACA,QAAQ;KACT,EAAC;UAEF,YAAY,KAAK;MACf,sBAAsB,cAAc,SAAS,GAC3C,cAAc,SAAS,GACvB,cAAc,UAAU;MAC1B,uBAAuB;MACvB;KACD,EAAC;IAEL;AAED,QAAI,CAAC,kBACH;AAGF,QAAI,CAAC,qBAAqB,MAAM,KAC9B;IAGF,MAAM,gBAAgB,GAAG,SAAS,CAAC,EAAE,WAAW;IAEhD,MAAM,kBAAkB,oBAAoB,KAAK,CAAC,EAChD,MACA,MAAM,WACP,KAAK;AACJ,YAAO,MAAM,aAAa,KAAK,CAAC,cAAc,IAAI,UAAU,OAAO,gBAAgB,KAAK,MAAM,cAAc;IAC7G,EAAC;AAEF,QAAI,oBAAoB,QACtB,iBAAiB,KAAK,gBAAgB,KAAK;AAG7C,QAAI,iBAAiB,KAAK,CAAC,SAAS;AAClC,YAAO,cAAc,WAAW,KAAK;IACtC,EAAC,CACA;AAGF,QAAI,uBAAuB,CAAC,oBAAoB,KAAK,CAAC,EACpD,MACD,KAAK;AACJ,YAAO,MAAM,aAAa,KAAK,CAAC,cAAc;IAC/C,EAAC,EACA,YAAY,KAAK;KACf,sBAAsB,cACpB,sBAAsB,KAAK,gBAAgB,UAC5C;KACD,uBAAuB;KACvB;KACA,MAAM,kBAAkB,CAAC,kBAAkB,aAAa;IACzD,EAAC;GAEL;AAED;EACD;;EAGD,IAAI;EACJ,IAAI;AACJ,MAAI,OAAO,0BAA0B,UAAU;AAC7C,OAAI,CAAC,0BAA0B,sBAAsB,YACnD;GAGF,gBAAuC,sBAAsB;GAC7D,OAAO;EACR,OACC,gBAAuC;AAGzC,MAAI,uBAAuB,CAAC,oBAAoB,KAAK,CAAC,EACpD,MACD,KAAK;AACJ,UAAO,SAAS;EACjB,EAAC,IAAI,kBAAkB,QACtB,YAAY,KAAK;GACf,sBAAsB,cAAc,cAAc;GAClD,uBAAuB;GACvB;GACA;EACD,EAAC;CAEL;;;;;;;;;;;CAYD,MAAM,MAAM,CAAC,EACX,sBACA,uBACA,KACA,QACA,MACD,KAAK;AACJ,MAAI,OAAO,CAAC,gBACV;;;;;;;;EAUF,MAAM,eAAe,CAAC,UAAU,aAAa,gBAAgB;GAE3D,MAAM,SAAS;IACb,QAAQ,cAAc;IACtB,QAAQ;IACR,QAAQ;KACN,WAAW;KACX,aAAa;KACb,KAAK;KACL,SAAS;KACT,MAAM;KACN,QAAQ;KACR,eAAe;KACf,UAAU;KACV,SAAS;KACT,UAAU,OAAO,MAAM;KACvB,OAAO,MAAM,OAAO,aAAa,OAAO;KACxC,KAAK,CAAC,CAAC,EAAE,kBAAkB;KAC3B,MAAM,QAAQ;IACf;GACF;;;;;MAMI,MAAM,KAAM,OAAO,UAAU,aAAa;IAC7C,aAAa;IACb,YAAY,CAAE;IACd,MAAM;IACN,QAAQ;IACR,UAAU;IACV,UAAU,CAAE;IACZ,QAAQ,CACN,MACD;IACD,KAAK;IACL,MAAM,QAAQ;GACf,EAAC;GACF,MAAM,cAAc,MAAM,OAAO,GAAG;GACpC,MAAM,OAAO,OAAO,aAAa,aAAa,OAAO;AACrD,QAAK,MAAM,CACT,KACA,IACD,IAAI,MAAM,OAAO,MAAM,YAAY,CAAC,SAAS,EAC5C,IAAI,SAAS,cAAc,cAAc;EAE5C;EAED,MAAM,SAAS,MAAM,OAAO,UAAU,CAAC,EACrC,QAAQ,EACN,KACA,KACD,EACF,KAAK;AACJ,UAAO,OAAO;EACf,EAAC;AACF,MAAI,QACF,aAAa,sBAAsB,SAAS,sBAAsB,EAAE;OAC/D;GACL,MAAM,cAAc,kBAAkB,MAAM,MAAM,qBAAqB;GACvE,aAAa,aAAa,SAAS,aAAa,EAAE;EACnD;CACF;;;;CAKD,MAAM,QAAQ,MAAM;AAClB,OAAK,MAAM,cAAc,aACvB,IAAI,WAAW;CAElB;AAED,KAAI,YAAY,UAAU,MAAM,OAAO,WAAW,GAChD,MAAM,eAAe;AAGvB,MAAK,MAAM,EACT,uBACD,IAAI,aACH,MAAM,YACJ,CAAC,eAAe,EAAE,iBAAiB,EAAE,EAAE,sBAAsB,cAAc,CAAC,EAC5E,MACA,cAAc,QAAQ,KACvB;AAEJ,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,mBAAmB;KACjB,SAAS;KACT,MAAM;IACP;IACD,mBAAmB;KACjB,SAAS;KACT,MAAM;IACP;IACD,mBAAmB;KACjB,SAAS;KACT,MAAM;IACP;IACD,wBAAwB;KACtB,SAAS;KACT,MAAM;IACP;IACD,cAAc;KACZ,SAAS;KACT,MAAM;IACP;IACD,mBAAmB;KACjB,SAAS;KACT,MAAM;IACP;IACD,cAAc;KACZ,SAAS;KACT,MAAM;IACP;IACD,mBAAmB,EACjB,MAAM,SACP;IACD,UAAU;KACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;MACE,sBAAsB;MACtB,YAAY;OACV,SAAS,EACP,MAAM,SACP;OACD,SAAS,EACP,MAAM,SACP;MACF;MACD,MAAM;KACP,CACF,EACF;KACD,MAAM;IACP;IACD,aAAa,EACX,MAAM,UACP;IACD,wBAAwB,EACtB,MAAM,UACP;IACD,iBAAiB,EACf,MAAM,UACP;IACD,YAAY;KACV,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,4BAA4B,EAC1B,MAAM,UACP;IACD,iBAAiB;KACf,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,4BAA4B,EAC1B,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;CAKD,YAAY;AACb,EAAC"}

package/dist/rules/requireParam.js

@@ -0,0 +1,344 @@
+import iterateJsdoc from "../iterateJsdoc.js";
+
+//#region src/rules/requireParam.js
+/**
+* @typedef {[string, boolean, () => RootNamerReturn]} RootNamerReturn
+*/
+/**
+* @param {string[]} desiredRoots
+* @param {number} currentIndex
+* @returns {RootNamerReturn}
+*/
+const rootNamer = (desiredRoots, currentIndex) => {
+	/** @type {string} */
+	let name;
+	let idx = currentIndex;
+	const incremented = desiredRoots.length <= 1;
+	if (incremented) {
+		const base = desiredRoots[0];
+		const suffix = idx++;
+		name = `${base}${suffix}`;
+	} else name = desiredRoots.shift();
+	return [
+		name,
+		incremented,
+		() => {
+			return rootNamer(desiredRoots, idx);
+		}
+	];
+};
+var requireParam_default = iterateJsdoc(({ context, jsdoc, utils }) => {
+	if (utils.avoidDocs()) return;
+	if (utils.hasTag("type")) return;
+	const { autoIncrementBase = 0, checkDestructured = true, checkDestructuredRoots = true, checkRestProperty = false, checkTypesPattern = "/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/", enableFixer = true, enableRestElementFixer = true, enableRootFixer = true, ignoreWhenAllParamsMissing = false, unnamedRootBase = ["root"], useDefaultObjectProperties = false } = context.options[0] || {};
+	const preferredTagName = utils.getPreferredTagName({ tagName: "param" });
+	if (!preferredTagName) return;
+	const functionParameterNames = utils.getFunctionParameterNames(useDefaultObjectProperties);
+	if (!functionParameterNames.length) return;
+	const jsdocParameterNames = utils.getJsdocTagsDeep(preferredTagName);
+	if (ignoreWhenAllParamsMissing && !jsdocParameterNames.length) return;
+	const shallowJsdocParameterNames = jsdocParameterNames.filter((tag) => {
+		return !tag.name.includes(".");
+	}).map((tag, idx) => {
+		return {
+			...tag,
+			idx
+		};
+	});
+	const checkTypesRegex = utils.getRegexFromString(checkTypesPattern);
+	/**
+	* @type {{
+	*   functionParameterIdx: import('../iterateJsdoc.js').Integer,
+	*   functionParameterName: string,
+	*   inc: boolean|undefined,
+	*   remove?: true,
+	*   type?: string|undefined
+	* }[]}
+	*/
+	const missingTags = [];
+	const flattenedRoots = utils.flattenRoots(functionParameterNames).names;
+	/**
+	* @type {{
+	*   [key: string]: import('../iterateJsdoc.js').Integer
+	* }}
+	*/
+	const paramIndex = {};
+	/**
+	* @param {string} cur
+	* @returns {boolean}
+	*/
+	const hasParamIndex = (cur) => {
+		return utils.dropPathSegmentQuotes(String(cur)) in paramIndex;
+	};
+	/**
+	*
+	* @param {string|number|undefined} cur
+	* @returns {import('../iterateJsdoc.js').Integer}
+	*/
+	const getParamIndex = (cur) => {
+		return paramIndex[utils.dropPathSegmentQuotes(String(cur))];
+	};
+	/**
+	*
+	* @param {string} cur
+	* @param {import('../iterateJsdoc.js').Integer} idx
+	* @returns {void}
+	*/
+	const setParamIndex = (cur, idx) => {
+		paramIndex[utils.dropPathSegmentQuotes(String(cur))] = idx;
+	};
+	for (const [idx, cur] of flattenedRoots.entries()) setParamIndex(cur, idx);
+	/**
+	*
+	* @param {(import('@es-joy/jsdoccomment').JsdocTagWithInline & {
+	*   newAdd?: boolean
+	* })[]} jsdocTags
+	* @param {import('../iterateJsdoc.js').Integer} indexAtFunctionParams
+	* @returns {import('../iterateJsdoc.js').Integer}
+	*/
+	const findExpectedIndex = (jsdocTags, indexAtFunctionParams) => {
+		const remainingRoots = functionParameterNames.slice(indexAtFunctionParams || 0);
+		const foundIndex = jsdocTags.findIndex(({ name, newAdd }) => {
+			return !newAdd && remainingRoots.some((remainingRoot) => {
+				if (Array.isArray(remainingRoot)) return remainingRoot[1].names.includes(name);
+				if (typeof remainingRoot === "object") return name === remainingRoot.name;
+				return name === remainingRoot;
+			});
+		});
+		const tags = foundIndex > -1 ? jsdocTags.slice(0, foundIndex) : jsdocTags.filter(({ tag }) => {
+			return tag === preferredTagName;
+		});
+		let tagLineCount = 0;
+		for (const { source } of tags) for (const { tokens: { end } } of source) if (!end) tagLineCount++;
+		return tagLineCount;
+	};
+	let [nextRootName, incremented, namer] = rootNamer([...unnamedRootBase], autoIncrementBase);
+	const thisOffset = functionParameterNames[0] === "this" ? 1 : 0;
+	for (const [functionParameterIdx, functionParameterName] of functionParameterNames.entries()) {
+		let inc;
+		if (Array.isArray(functionParameterName)) {
+			const matchedJsdoc = shallowJsdocParameterNames[functionParameterIdx - thisOffset];
+			/** @type {string} */
+			let rootName;
+			if (functionParameterName[0]) rootName = functionParameterName[0];
+			else if (matchedJsdoc && matchedJsdoc.name) {
+				rootName = matchedJsdoc.name;
+				if (matchedJsdoc.type && matchedJsdoc.type.search(checkTypesRegex) === -1) continue;
+			} else {
+				rootName = nextRootName;
+				inc = incremented;
+			}
+			[nextRootName, incremented, namer] = namer();
+			const { hasPropertyRest, hasRestElement, names, rests } = functionParameterName[1];
+			const notCheckingNames = [];
+			if (!enableRestElementFixer && hasRestElement) continue;
+			if (!checkDestructuredRoots) continue;
+			for (const [idx, paramName] of names.entries()) {
+				if (!jsdocParameterNames.find(({ name }) => {
+					return name === rootName;
+				}) && !missingTags.find(({ functionParameterName: fpn }) => {
+					return fpn === rootName;
+				})) {
+					const emptyParamIdx = jsdocParameterNames.findIndex(({ name }) => {
+						return !name;
+					});
+					if (emptyParamIdx > -1) missingTags.push({
+						functionParameterIdx: emptyParamIdx,
+						functionParameterName: rootName,
+						inc,
+						remove: true
+					});
+					else missingTags.push({
+						functionParameterIdx: hasParamIndex(rootName) ? getParamIndex(rootName) : getParamIndex(paramName),
+						functionParameterName: rootName,
+						inc
+					});
+				}
+				if (!checkDestructured) continue;
+				if (!checkRestProperty && rests[idx]) continue;
+				const fullParamName = `${rootName}.${paramName}`;
+				const notCheckingName = jsdocParameterNames.find(({ name, type: paramType }) => {
+					return utils.comparePaths(name)(fullParamName) && paramType.search(checkTypesRegex) === -1 && paramType !== "";
+				});
+				if (notCheckingName !== void 0) notCheckingNames.push(notCheckingName.name);
+				if (notCheckingNames.find((name) => {
+					return fullParamName.startsWith(name);
+				})) continue;
+				if (jsdocParameterNames && !jsdocParameterNames.find(({ name }) => {
+					return utils.comparePaths(name)(fullParamName);
+				})) missingTags.push({
+					functionParameterIdx: getParamIndex(functionParameterName[0] ? fullParamName : paramName),
+					functionParameterName: fullParamName,
+					inc,
+					type: hasRestElement && !hasPropertyRest ? "{...any}" : void 0
+				});
+			}
+			continue;
+		}
+		/** @type {string} */
+		let funcParamName;
+		let type;
+		if (typeof functionParameterName === "object") {
+			if (!enableRestElementFixer && functionParameterName.restElement) continue;
+			funcParamName = functionParameterName.name;
+			type = "{...any}";
+		} else funcParamName = functionParameterName;
+		if (jsdocParameterNames && !jsdocParameterNames.find(({ name }) => {
+			return name === funcParamName;
+		}) && funcParamName !== "this") missingTags.push({
+			functionParameterIdx: getParamIndex(funcParamName),
+			functionParameterName: funcParamName,
+			inc,
+			type
+		});
+	}
+	/**
+	*
+	* @param {{
+	*   functionParameterIdx: import('../iterateJsdoc.js').Integer,
+	*   functionParameterName: string,
+	*   remove?: true,
+	*   inc?: boolean,
+	*   type?: string
+	* }} cfg
+	*/
+	const fix = ({ functionParameterIdx, functionParameterName, inc, remove, type }) => {
+		if (inc && !enableRootFixer) return;
+		/**
+		*
+		* @param {import('../iterateJsdoc.js').Integer} tagIndex
+		* @param {import('../iterateJsdoc.js').Integer} sourceIndex
+		* @param {import('../iterateJsdoc.js').Integer} spliceCount
+		* @returns {void}
+		*/
+		const createTokens = (tagIndex, sourceIndex, spliceCount) => {
+			const tokens = {
+				number: sourceIndex + 1,
+				source: "",
+				tokens: {
+					delimiter: "*",
+					description: "",
+					end: "",
+					lineEnd: "",
+					name: functionParameterName,
+					newAdd: true,
+					postDelimiter: " ",
+					postName: "",
+					postTag: " ",
+					postType: type ? " " : "",
+					start: jsdoc.source[sourceIndex].tokens.start,
+					tag: `@${preferredTagName}`,
+					type: type ?? ""
+				}
+			};
+			/**
+			* @type {(import('@es-joy/jsdoccomment').JsdocTagWithInline & {
+			*   newAdd?: true
+			* })[]}
+			*/ jsdoc.tags.splice(tagIndex, spliceCount, {
+				description: "",
+				inlineTags: [],
+				name: functionParameterName,
+				newAdd: true,
+				optional: false,
+				problems: [],
+				source: [tokens],
+				tag: preferredTagName,
+				type: type ?? ""
+			});
+			const firstNumber = jsdoc.source[0].number;
+			jsdoc.source.splice(sourceIndex, spliceCount, tokens);
+			for (const [idx, src] of jsdoc.source.slice(sourceIndex).entries()) src.number = firstNumber + sourceIndex + idx;
+		};
+		const offset = jsdoc.source.findIndex(({ tokens: { end, tag } }) => {
+			return tag || end;
+		});
+		if (remove) createTokens(functionParameterIdx, offset + functionParameterIdx, 1);
+		else {
+			const expectedIdx = findExpectedIndex(jsdoc.tags, functionParameterIdx);
+			createTokens(expectedIdx, offset + expectedIdx, 0);
+		}
+	};
+	/**
+	* @returns {void}
+	*/
+	const fixer = () => {
+		for (const missingTag of missingTags) fix(missingTag);
+	};
+	if (missingTags.length && jsdoc.source.length === 1) utils.makeMultiline();
+	for (const { functionParameterName } of missingTags) utils.reportJSDoc(`Missing JSDoc @${preferredTagName} "${functionParameterName}" declaration.`, null, enableFixer ? fixer : null);
+}, {
+	contextDefaults: true,
+	meta: {
+		docs: {
+			description: "Requires that all function parameters are documented.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param.md#repos-sticky-header"
+		},
+		fixable: "code",
+		schema: [{
+			additionalProperties: false,
+			properties: {
+				autoIncrementBase: {
+					default: 0,
+					type: "integer"
+				},
+				checkConstructors: {
+					default: true,
+					type: "boolean"
+				},
+				checkDestructured: {
+					default: true,
+					type: "boolean"
+				},
+				checkDestructuredRoots: {
+					default: true,
+					type: "boolean"
+				},
+				checkGetters: {
+					default: false,
+					type: "boolean"
+				},
+				checkRestProperty: {
+					default: false,
+					type: "boolean"
+				},
+				checkSetters: {
+					default: false,
+					type: "boolean"
+				},
+				checkTypesPattern: { type: "string" },
+				contexts: {
+					items: { anyOf: [{ type: "string" }, {
+						additionalProperties: false,
+						properties: {
+							comment: { type: "string" },
+							context: { type: "string" }
+						},
+						type: "object"
+					}] },
+					type: "array"
+				},
+				enableFixer: { type: "boolean" },
+				enableRestElementFixer: { type: "boolean" },
+				enableRootFixer: { type: "boolean" },
+				exemptedBy: {
+					items: { type: "string" },
+					type: "array"
+				},
+				ignoreWhenAllParamsMissing: { type: "boolean" },
+				unnamedRootBase: {
+					items: { type: "string" },
+					type: "array"
+				},
+				useDefaultObjectProperties: { type: "boolean" }
+			},
+			type: "object"
+		}],
+		type: "suggestion"
+	},
+	noTracking: true
+});
+
+//#endregion
+export { requireParam_default as default };
+//# sourceMappingURL=requireParam.js.map

package/dist/rules/requireParam.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requireParam.js","names":[],"sources":["../../src/rules/requireParam.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @typedef {[string, boolean, () => RootNamerReturn]} RootNamerReturn\n */\n\n/**\n * @param {string[]} desiredRoots\n * @param {number} currentIndex\n * @returns {RootNamerReturn}\n */\nconst rootNamer = (desiredRoots, currentIndex) => {\n  /** @type {string} */\n  let name;\n  let idx = currentIndex;\n  const incremented = desiredRoots.length <= 1;\n  if (incremented) {\n    const base = desiredRoots[0];\n    const suffix = idx++;\n    name = `${base}${suffix}`;\n  } else {\n    name = /** @type {string} */ (desiredRoots.shift());\n  }\n\n  return [\n    name,\n    incremented,\n    () => {\n      return rootNamer(desiredRoots, idx);\n    },\n  ];\n};\n\n/* eslint-disable complexity -- Temporary */\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  /* eslint-enable complexity -- Temporary */\n  if (utils.avoidDocs()) {\n    return;\n  }\n\n  // Param type is specified by type in @type\n  if (utils.hasTag('type')) {\n    return;\n  }\n\n  const {\n    autoIncrementBase = 0,\n    checkDestructured = true,\n    checkDestructuredRoots = true,\n    checkRestProperty = false,\n    checkTypesPattern = '/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/',\n    enableFixer = true,\n    enableRestElementFixer = true,\n    enableRootFixer = true,\n    ignoreWhenAllParamsMissing = false,\n    unnamedRootBase = [\n      'root',\n    ],\n    useDefaultObjectProperties = false,\n  } = context.options[0] || {};\n\n  const preferredTagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'param',\n  }));\n  if (!preferredTagName) {\n    return;\n  }\n\n  const functionParameterNames = utils.getFunctionParameterNames(useDefaultObjectProperties);\n  if (!functionParameterNames.length) {\n    return;\n  }\n\n  const jsdocParameterNames =\n    /**\n     * @type {{\n     *   idx: import('../iterateJsdoc.js').Integer;\n     *   name: string;\n     *   type: string;\n     * }[]}\n     */ (utils.getJsdocTagsDeep(preferredTagName));\n\n  if (ignoreWhenAllParamsMissing && !jsdocParameterNames.length) {\n    return;\n  }\n\n  const shallowJsdocParameterNames = jsdocParameterNames.filter((tag) => {\n    return !tag.name.includes('.');\n  }).map((tag, idx) => {\n    return {\n      ...tag,\n      idx,\n    };\n  });\n\n  const checkTypesRegex = utils.getRegexFromString(checkTypesPattern);\n\n  /**\n   * @type {{\n   *   functionParameterIdx: import('../iterateJsdoc.js').Integer,\n   *   functionParameterName: string,\n   *   inc: boolean|undefined,\n   *   remove?: true,\n   *   type?: string|undefined\n   * }[]}\n   */\n  const missingTags = [];\n  const flattenedRoots = utils.flattenRoots(functionParameterNames).names;\n\n  /**\n   * @type {{\n   *   [key: string]: import('../iterateJsdoc.js').Integer\n   * }}\n   */\n  const paramIndex = {};\n\n  /**\n   * @param {string} cur\n   * @returns {boolean}\n   */\n  const hasParamIndex = (cur) => {\n    return utils.dropPathSegmentQuotes(String(cur)) in paramIndex;\n  };\n\n  /**\n   *\n   * @param {string|number|undefined} cur\n   * @returns {import('../iterateJsdoc.js').Integer}\n   */\n  const getParamIndex = (cur) => {\n    return paramIndex[utils.dropPathSegmentQuotes(String(cur))];\n  };\n\n  /**\n   *\n   * @param {string} cur\n   * @param {import('../iterateJsdoc.js').Integer} idx\n   * @returns {void}\n   */\n  const setParamIndex = (cur, idx) => {\n    paramIndex[utils.dropPathSegmentQuotes(String(cur))] = idx;\n  };\n\n  for (const [\n    idx,\n    cur,\n  ] of flattenedRoots.entries()) {\n    setParamIndex(cur, idx);\n  }\n\n  /**\n   *\n   * @param {(import('@es-joy/jsdoccomment').JsdocTagWithInline & {\n   *   newAdd?: boolean\n   * })[]} jsdocTags\n   * @param {import('../iterateJsdoc.js').Integer} indexAtFunctionParams\n   * @returns {import('../iterateJsdoc.js').Integer}\n   */\n  const findExpectedIndex = (jsdocTags, indexAtFunctionParams) => {\n    const remainingRoots = functionParameterNames.slice(indexAtFunctionParams || 0);\n    const foundIndex = jsdocTags.findIndex(({\n      name,\n      newAdd,\n    }) => {\n      return !newAdd && remainingRoots.some((remainingRoot) => {\n        if (Array.isArray(remainingRoot)) {\n          return (\n            /**\n             * @type {import('../jsdocUtils.js').FlattendRootInfo & {\n             *   annotationParamName?: string|undefined;\n             * }}\n             */ (remainingRoot[1]).names.includes(name)\n          );\n        }\n\n        if (typeof remainingRoot === 'object') {\n          return name === remainingRoot.name;\n        }\n\n        return name === remainingRoot;\n      });\n    });\n\n    const tags = foundIndex > -1 ?\n      jsdocTags.slice(0, foundIndex) :\n      jsdocTags.filter(({\n        tag,\n      }) => {\n        return tag === preferredTagName;\n      });\n\n    let tagLineCount = 0;\n    for (const {\n      source,\n    } of tags) {\n      for (const {\n        tokens: {\n          end,\n        },\n      } of source) {\n        if (!end) {\n          tagLineCount++;\n        }\n      }\n    }\n\n    return tagLineCount;\n  };\n\n  let [\n    nextRootName,\n    incremented,\n    namer,\n  ] = rootNamer([\n    ...unnamedRootBase,\n  ], autoIncrementBase);\n\n  const thisOffset = functionParameterNames[0] === 'this' ? 1 : 0;\n\n  for (const [\n    functionParameterIdx,\n    functionParameterName,\n  ] of functionParameterNames.entries()) {\n    let inc;\n    if (Array.isArray(functionParameterName)) {\n      const matchedJsdoc = shallowJsdocParameterNames[functionParameterIdx - thisOffset];\n\n      /** @type {string} */\n      let rootName;\n      if (functionParameterName[0]) {\n        rootName = functionParameterName[0];\n      } else if (matchedJsdoc && matchedJsdoc.name) {\n        rootName = matchedJsdoc.name;\n        if (matchedJsdoc.type && matchedJsdoc.type.search(checkTypesRegex) === -1) {\n          continue;\n        }\n      } else {\n        rootName = nextRootName;\n        inc = incremented;\n      }\n\n      [\n        nextRootName,\n        incremented,\n        namer,\n      ] = namer();\n\n      const {\n        hasPropertyRest,\n        hasRestElement,\n        names,\n        rests,\n      } = /**\n           * @type {import('../jsdocUtils.js').FlattendRootInfo & {\n           *   annotationParamName?: string | undefined;\n           * }}\n           */ (functionParameterName[1]);\n      const notCheckingNames = [];\n      if (!enableRestElementFixer && hasRestElement) {\n        continue;\n      }\n\n      if (!checkDestructuredRoots) {\n        continue;\n      }\n\n      for (const [\n        idx,\n        paramName,\n      ] of names.entries()) {\n        // Add root if the root name is not in the docs (and is not already\n        //  in the tags to be fixed)\n        if (!jsdocParameterNames.find(({\n          name,\n        }) => {\n          return name === rootName;\n        }) && !missingTags.find(({\n          functionParameterName: fpn,\n        }) => {\n          return fpn === rootName;\n        })) {\n          const emptyParamIdx = jsdocParameterNames.findIndex(({\n            name,\n          }) => {\n            return !name;\n          });\n\n          if (emptyParamIdx > -1) {\n            missingTags.push({\n              functionParameterIdx: emptyParamIdx,\n              functionParameterName: rootName,\n              inc,\n              remove: true,\n            });\n          } else {\n            missingTags.push({\n              functionParameterIdx: hasParamIndex(rootName) ?\n                getParamIndex(rootName) :\n                getParamIndex(paramName),\n              functionParameterName: rootName,\n              inc,\n            });\n          }\n        }\n\n        if (!checkDestructured) {\n          continue;\n        }\n\n        if (!checkRestProperty && rests[idx]) {\n          continue;\n        }\n\n        const fullParamName = `${rootName}.${paramName}`;\n\n        const notCheckingName = jsdocParameterNames.find(({\n          name,\n          type: paramType,\n        }) => {\n          return utils.comparePaths(name)(fullParamName) && paramType.search(checkTypesRegex) === -1 && paramType !== '';\n        });\n\n        if (notCheckingName !== undefined) {\n          notCheckingNames.push(notCheckingName.name);\n        }\n\n        if (notCheckingNames.find((name) => {\n          return fullParamName.startsWith(name);\n        })) {\n          continue;\n        }\n\n        if (jsdocParameterNames && !jsdocParameterNames.find(({\n          name,\n        }) => {\n          return utils.comparePaths(name)(fullParamName);\n        })) {\n          missingTags.push({\n            functionParameterIdx: getParamIndex(\n              functionParameterName[0] ? fullParamName : paramName,\n            ),\n            functionParameterName: fullParamName,\n            inc,\n            type: hasRestElement && !hasPropertyRest ? '{...any}' : undefined,\n          });\n        }\n      }\n\n      continue;\n    }\n\n    /** @type {string} */\n    let funcParamName;\n    let type;\n    if (typeof functionParameterName === 'object') {\n      if (!enableRestElementFixer && functionParameterName.restElement) {\n        continue;\n      }\n\n      funcParamName = /** @type {string} */ (functionParameterName.name);\n      type = '{...any}';\n    } else {\n      funcParamName = /** @type {string} */ (functionParameterName);\n    }\n\n    if (jsdocParameterNames && !jsdocParameterNames.find(({\n      name,\n    }) => {\n      return name === funcParamName;\n    }) && funcParamName !== 'this') {\n      missingTags.push({\n        functionParameterIdx: getParamIndex(funcParamName),\n        functionParameterName: funcParamName,\n        inc,\n        type,\n      });\n    }\n  }\n\n  /**\n   *\n   * @param {{\n   *   functionParameterIdx: import('../iterateJsdoc.js').Integer,\n   *   functionParameterName: string,\n   *   remove?: true,\n   *   inc?: boolean,\n   *   type?: string\n   * }} cfg\n   */\n  const fix = ({\n    functionParameterIdx,\n    functionParameterName,\n    inc,\n    remove,\n    type,\n  }) => {\n    if (inc && !enableRootFixer) {\n      return;\n    }\n\n    /**\n     *\n     * @param {import('../iterateJsdoc.js').Integer} tagIndex\n     * @param {import('../iterateJsdoc.js').Integer} sourceIndex\n     * @param {import('../iterateJsdoc.js').Integer} spliceCount\n     * @returns {void}\n     */\n    const createTokens = (tagIndex, sourceIndex, spliceCount) => {\n      // console.log(sourceIndex, tagIndex, jsdoc.tags, jsdoc.source);\n      const tokens = {\n        number: sourceIndex + 1,\n        source: '',\n        tokens: {\n          delimiter: '*',\n          description: '',\n          end: '',\n          lineEnd: '',\n          name: functionParameterName,\n          newAdd: true,\n          postDelimiter: ' ',\n          postName: '',\n          postTag: ' ',\n          postType: type ? ' ' : '',\n          start: jsdoc.source[sourceIndex].tokens.start,\n          tag: `@${preferredTagName}`,\n          type: type ?? '',\n        },\n      };\n\n      /**\n       * @type {(import('@es-joy/jsdoccomment').JsdocTagWithInline & {\n       *   newAdd?: true\n       * })[]}\n       */ (jsdoc.tags).splice(tagIndex, spliceCount, {\n        description: '',\n        inlineTags: [],\n        name: functionParameterName,\n        newAdd: true,\n        optional: false,\n        problems: [],\n        source: [\n          tokens,\n        ],\n        tag: preferredTagName,\n        type: type ?? '',\n      });\n      const firstNumber = jsdoc.source[0].number;\n      jsdoc.source.splice(sourceIndex, spliceCount, tokens);\n      for (const [\n        idx,\n        src,\n      ] of jsdoc.source.slice(sourceIndex).entries()) {\n        src.number = firstNumber + sourceIndex + idx;\n      }\n    };\n\n    const offset = jsdoc.source.findIndex(({\n      tokens: {\n        end,\n        tag,\n      },\n    }) => {\n      return tag || end;\n    });\n    if (remove) {\n      createTokens(functionParameterIdx, offset + functionParameterIdx, 1);\n    } else {\n      const expectedIdx = findExpectedIndex(jsdoc.tags, functionParameterIdx);\n      createTokens(expectedIdx, offset + expectedIdx, 0);\n    }\n  };\n\n  /**\n   * @returns {void}\n   */\n  const fixer = () => {\n    for (const missingTag of missingTags) {\n      fix(missingTag);\n    }\n  };\n\n  if (missingTags.length && jsdoc.source.length === 1) {\n    utils.makeMultiline();\n  }\n\n  for (const {\n    functionParameterName,\n  } of missingTags) {\n    utils.reportJSDoc(\n      `Missing JSDoc @${preferredTagName} \"${functionParameterName}\" declaration.`,\n      null,\n      enableFixer ? fixer : null,\n    );\n  }\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires that all function parameters are documented.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          autoIncrementBase: {\n            default: 0,\n            type: 'integer',\n          },\n          checkConstructors: {\n            default: true,\n            type: 'boolean',\n          },\n          checkDestructured: {\n            default: true,\n            type: 'boolean',\n          },\n          checkDestructuredRoots: {\n            default: true,\n            type: 'boolean',\n          },\n          checkGetters: {\n            default: false,\n            type: 'boolean',\n          },\n          checkRestProperty: {\n            default: false,\n            type: 'boolean',\n          },\n          checkSetters: {\n            default: false,\n            type: 'boolean',\n          },\n          checkTypesPattern: {\n            type: 'string',\n          },\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          enableFixer: {\n            type: 'boolean',\n          },\n          enableRestElementFixer: {\n            type: 'boolean',\n          },\n          enableRootFixer: {\n            type: 'boolean',\n          },\n          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          ignoreWhenAllParamsMissing: {\n            type: 'boolean',\n          },\n          unnamedRootBase: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          useDefaultObjectProperties: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n\n  // We cannot cache comment nodes as the contexts may recur with the\n  //  same comment node but a different JS node, and we may need the different\n  //  JS node to ensure we iterate its context\n  noTracking: true,\n});\n"],"mappings":";;;;;;;;;;;AAWA,MAAM,YAAY,CAAC,cAAc,iBAAiB;;CAEhD,IAAI;CACJ,IAAI,MAAM;CACV,MAAM,cAAc,aAAa,UAAU;AAC3C,KAAI,aAAa;EACf,MAAM,OAAO,aAAa;EAC1B,MAAM,SAAS;EACf,OAAO,GAAG,OAAO,QAAQ;CAC1B,OACC,OAA8B,aAAa,OAAO;AAGpD,QAAO;EACL;EACA;EACA,MAAM;AACJ,UAAO,UAAU,cAAc,IAAI;EACpC;CACF;AACF;AAGD,2BAAe,aAAa,CAAC,EAC3B,SACA,OACA,OACD,KAAK;AAEJ,KAAI,MAAM,WAAW,CACnB;AAIF,KAAI,MAAM,OAAO,OAAO,CACtB;CAGF,MAAM,EACJ,oBAAoB,GACpB,oBAAoB,MACpB,yBAAyB,MACzB,oBAAoB,OACpB,oBAAoB,kEACpB,cAAc,MACd,yBAAyB,MACzB,kBAAkB,MAClB,6BAA6B,OAC7B,kBAAkB,CAChB,MACD,GACD,6BAA6B,OAC9B,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,MAAM,mBAA0C,MAAM,oBAAoB,EACxE,SAAS,QACV,EAAC;AACF,KAAI,CAAC,iBACH;CAGF,MAAM,yBAAyB,MAAM,0BAA0B,2BAA2B;AAC1F,KAAI,CAAC,uBAAuB,OAC1B;CAGF,MAAM,sBAOC,MAAM,iBAAiB,iBAAiB;AAE/C,KAAI,8BAA8B,CAAC,oBAAoB,OACrD;CAGF,MAAM,6BAA6B,oBAAoB,OAAO,CAAC,QAAQ;AACrE,SAAO,CAAC,IAAI,KAAK,SAAS,IAAI;CAC/B,EAAC,CAAC,IAAI,CAAC,KAAK,QAAQ;AACnB,SAAO;GACL,GAAG;GACH;EACD;CACF,EAAC;CAEF,MAAM,kBAAkB,MAAM,mBAAmB,kBAAkB;;;;;;;;;;CAWnE,MAAM,cAAc,CAAE;CACtB,MAAM,iBAAiB,MAAM,aAAa,uBAAuB,CAAC;;;;;;CAOlE,MAAM,aAAa,CAAE;;;;;CAMrB,MAAM,gBAAgB,CAAC,QAAQ;AAC7B,SAAO,MAAM,sBAAsB,OAAO,IAAI,CAAC,IAAI;CACpD;;;;;;CAOD,MAAM,gBAAgB,CAAC,QAAQ;AAC7B,SAAO,WAAW,MAAM,sBAAsB,OAAO,IAAI,CAAC;CAC3D;;;;;;;CAQD,MAAM,gBAAgB,CAAC,KAAK,QAAQ;EAClC,WAAW,MAAM,sBAAsB,OAAO,IAAI,CAAC,IAAI;CACxD;AAED,MAAK,MAAM,CACT,KACA,IACD,IAAI,eAAe,SAAS,EAC3B,cAAc,KAAK,IAAI;;;;;;;;;CAWzB,MAAM,oBAAoB,CAAC,WAAW,0BAA0B;EAC9D,MAAM,iBAAiB,uBAAuB,MAAM,yBAAyB,EAAE;EAC/E,MAAM,aAAa,UAAU,UAAU,CAAC,EACtC,MACA,QACD,KAAK;AACJ,UAAO,CAAC,UAAU,eAAe,KAAK,CAAC,kBAAkB;AACvD,QAAI,MAAM,QAAQ,cAAc,CAC9B,QAKO,cAAc,GAAI,MAAM,SAAS,KAAK;AAI/C,QAAI,OAAO,kBAAkB,SAC3B,QAAO,SAAS,cAAc;AAGhC,WAAO,SAAS;GACjB,EAAC;EACH,EAAC;EAEF,MAAM,OAAO,aAAa,KACxB,UAAU,MAAM,GAAG,WAAW,GAC9B,UAAU,OAAO,CAAC,EAChB,KACD,KAAK;AACJ,UAAO,QAAQ;EAChB,EAAC;EAEJ,IAAI,eAAe;AACnB,OAAK,MAAM,EACT,QACD,IAAI,KACH,MAAK,MAAM,EACT,QAAQ,EACN,KACD,EACF,IAAI,OACH,KAAI,CAAC,KACH;AAKN,SAAO;CACR;CAED,IAAI,CACF,cACA,aACA,MACD,GAAG,UAAU,CACZ,GAAG,eACJ,GAAE,kBAAkB;CAErB,MAAM,aAAa,uBAAuB,OAAO,SAAS,IAAI;AAE9D,MAAK,MAAM,CACT,sBACA,sBACD,IAAI,uBAAuB,SAAS,EAAE;EACrC,IAAI;AACJ,MAAI,MAAM,QAAQ,sBAAsB,EAAE;GACxC,MAAM,eAAe,2BAA2B,uBAAuB;;GAGvE,IAAI;AACJ,OAAI,sBAAsB,IACxB,WAAW,sBAAsB;YACxB,gBAAgB,aAAa,MAAM;IAC5C,WAAW,aAAa;AACxB,QAAI,aAAa,QAAQ,aAAa,KAAK,OAAO,gBAAgB,KAAK,GACrE;GAEH,OAAM;IACL,WAAW;IACX,MAAM;GACP;GAED,CACE,cACA,aACA,MACD,GAAG,OAAO;GAEX,MAAM,EACJ,iBACA,gBACA,OACA,OACD,GAIQ,sBAAsB;GAC/B,MAAM,mBAAmB,CAAE;AAC3B,OAAI,CAAC,0BAA0B,eAC7B;AAGF,OAAI,CAAC,uBACH;AAGF,QAAK,MAAM,CACT,KACA,UACD,IAAI,MAAM,SAAS,EAAE;AAGpB,QAAI,CAAC,oBAAoB,KAAK,CAAC,EAC7B,MACD,KAAK;AACJ,YAAO,SAAS;IACjB,EAAC,IAAI,CAAC,YAAY,KAAK,CAAC,EACvB,uBAAuB,KACxB,KAAK;AACJ,YAAO,QAAQ;IAChB,EAAC,EAAE;KACF,MAAM,gBAAgB,oBAAoB,UAAU,CAAC,EACnD,MACD,KAAK;AACJ,aAAO,CAAC;KACT,EAAC;AAEF,SAAI,gBAAgB,IAClB,YAAY,KAAK;MACf,sBAAsB;MACtB,uBAAuB;MACvB;MACA,QAAQ;KACT,EAAC;UAEF,YAAY,KAAK;MACf,sBAAsB,cAAc,SAAS,GAC3C,cAAc,SAAS,GACvB,cAAc,UAAU;MAC1B,uBAAuB;MACvB;KACD,EAAC;IAEL;AAED,QAAI,CAAC,kBACH;AAGF,QAAI,CAAC,qBAAqB,MAAM,KAC9B;IAGF,MAAM,gBAAgB,GAAG,SAAS,CAAC,EAAE,WAAW;IAEhD,MAAM,kBAAkB,oBAAoB,KAAK,CAAC,EAChD,MACA,MAAM,WACP,KAAK;AACJ,YAAO,MAAM,aAAa,KAAK,CAAC,cAAc,IAAI,UAAU,OAAO,gBAAgB,KAAK,MAAM,cAAc;IAC7G,EAAC;AAEF,QAAI,oBAAoB,QACtB,iBAAiB,KAAK,gBAAgB,KAAK;AAG7C,QAAI,iBAAiB,KAAK,CAAC,SAAS;AAClC,YAAO,cAAc,WAAW,KAAK;IACtC,EAAC,CACA;AAGF,QAAI,uBAAuB,CAAC,oBAAoB,KAAK,CAAC,EACpD,MACD,KAAK;AACJ,YAAO,MAAM,aAAa,KAAK,CAAC,cAAc;IAC/C,EAAC,EACA,YAAY,KAAK;KACf,sBAAsB,cACpB,sBAAsB,KAAK,gBAAgB,UAC5C;KACD,uBAAuB;KACvB;KACA,MAAM,kBAAkB,CAAC,kBAAkB,aAAa;IACzD,EAAC;GAEL;AAED;EACD;;EAGD,IAAI;EACJ,IAAI;AACJ,MAAI,OAAO,0BAA0B,UAAU;AAC7C,OAAI,CAAC,0BAA0B,sBAAsB,YACnD;GAGF,gBAAuC,sBAAsB;GAC7D,OAAO;EACR,OACC,gBAAuC;AAGzC,MAAI,uBAAuB,CAAC,oBAAoB,KAAK,CAAC,EACpD,MACD,KAAK;AACJ,UAAO,SAAS;EACjB,EAAC,IAAI,kBAAkB,QACtB,YAAY,KAAK;GACf,sBAAsB,cAAc,cAAc;GAClD,uBAAuB;GACvB;GACA;EACD,EAAC;CAEL;;;;;;;;;;;CAYD,MAAM,MAAM,CAAC,EACX,sBACA,uBACA,KACA,QACA,MACD,KAAK;AACJ,MAAI,OAAO,CAAC,gBACV;;;;;;;;EAUF,MAAM,eAAe,CAAC,UAAU,aAAa,gBAAgB;GAE3D,MAAM,SAAS;IACb,QAAQ,cAAc;IACtB,QAAQ;IACR,QAAQ;KACN,WAAW;KACX,aAAa;KACb,KAAK;KACL,SAAS;KACT,MAAM;KACN,QAAQ;KACR,eAAe;KACf,UAAU;KACV,SAAS;KACT,UAAU,OAAO,MAAM;KACvB,OAAO,MAAM,OAAO,aAAa,OAAO;KACxC,KAAK,CAAC,CAAC,EAAE,kBAAkB;KAC3B,MAAM,QAAQ;IACf;GACF;;;;;MAMI,MAAM,KAAM,OAAO,UAAU,aAAa;IAC7C,aAAa;IACb,YAAY,CAAE;IACd,MAAM;IACN,QAAQ;IACR,UAAU;IACV,UAAU,CAAE;IACZ,QAAQ,CACN,MACD;IACD,KAAK;IACL,MAAM,QAAQ;GACf,EAAC;GACF,MAAM,cAAc,MAAM,OAAO,GAAG;GACpC,MAAM,OAAO,OAAO,aAAa,aAAa,OAAO;AACrD,QAAK,MAAM,CACT,KACA,IACD,IAAI,MAAM,OAAO,MAAM,YAAY,CAAC,SAAS,EAC5C,IAAI,SAAS,cAAc,cAAc;EAE5C;EAED,MAAM,SAAS,MAAM,OAAO,UAAU,CAAC,EACrC,QAAQ,EACN,KACA,KACD,EACF,KAAK;AACJ,UAAO,OAAO;EACf,EAAC;AACF,MAAI,QACF,aAAa,sBAAsB,SAAS,sBAAsB,EAAE;OAC/D;GACL,MAAM,cAAc,kBAAkB,MAAM,MAAM,qBAAqB;GACvE,aAAa,aAAa,SAAS,aAAa,EAAE;EACnD;CACF;;;;CAKD,MAAM,QAAQ,MAAM;AAClB,OAAK,MAAM,cAAc,aACvB,IAAI,WAAW;CAElB;AAED,KAAI,YAAY,UAAU,MAAM,OAAO,WAAW,GAChD,MAAM,eAAe;AAGvB,MAAK,MAAM,EACT,uBACD,IAAI,aACH,MAAM,YACJ,CAAC,eAAe,EAAE,iBAAiB,EAAE,EAAE,sBAAsB,cAAc,CAAC,EAC5E,MACA,cAAc,QAAQ,KACvB;AAEJ,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,mBAAmB;KACjB,SAAS;KACT,MAAM;IACP;IACD,mBAAmB;KACjB,SAAS;KACT,MAAM;IACP;IACD,mBAAmB;KACjB,SAAS;KACT,MAAM;IACP;IACD,wBAAwB;KACtB,SAAS;KACT,MAAM;IACP;IACD,cAAc;KACZ,SAAS;KACT,MAAM;IACP;IACD,mBAAmB;KACjB,SAAS;KACT,MAAM;IACP;IACD,cAAc;KACZ,SAAS;KACT,MAAM;IACP;IACD,mBAAmB,EACjB,MAAM,SACP;IACD,UAAU;KACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;MACE,sBAAsB;MACtB,YAAY;OACV,SAAS,EACP,MAAM,SACP;OACD,SAAS,EACP,MAAM,SACP;MACF;MACD,MAAM;KACP,CACF,EACF;KACD,MAAM;IACP;IACD,aAAa,EACX,MAAM,UACP;IACD,wBAAwB,EACtB,MAAM,UACP;IACD,iBAAiB,EACf,MAAM,UACP;IACD,YAAY;KACV,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,4BAA4B,EAC1B,MAAM,UACP;IACD,iBAAiB;KACf,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,4BAA4B,EAC1B,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;CAKD,YAAY;AACb,EAAC"}