eslint-plugin-jsdoc 52.0.4 → 53.0.0

package/dist/rules/checkParamNames.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"checkParamNames.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","validateParameterNames","targetTagName","allowExtraTrailingParamDocs","checkDestructured","checkRestProperty","checkTypesRegex","disableExtraPropertyReporting","disableMissingParamChecks","enableFixer","functionParameterNames","jsdoc","utils","report","paramTags","Object","entries","tags","filter","tag","paramTagsNonNested","name","includes","dotted","thisOffset","some","index","tagsIndex","dupeTagInfo","find","tgsIndex","tg","idx","Number","reportJSDoc","removeTag","functionParameterName","trim","Array","isArray","actualName","expectedName","type","search","parameterName","annotationParamName","hasPropertyRest","names","properties","rests","undefined","tagName","expectedNames","map","actualNames","paramTag","actualTypes","missingProperties","notCheckingNames","notCheckingName","startsWith","actualNameIdx","findIndex","comparePaths","missingIndex","pathDoesNotBeginWith","line","source","number","length","push","tagPlacement","hasMissing","missingProperty","extraProperties","match","prop","split","extraProperty","funcParamName","item","usedExpectedNames","a","toString","usedInOrder","every","restElement","join","validateParameterNamesDeep","_allowExtraTrailingParamDocs","jsdocParameterNames","lastRealParameter","jsdocParameterName","isPropertyPath","pathRootNodeName","slice","indexOf","endsWith","allowedNodes","_default","exports","iterateJsdoc","context","node","checkTypesPattern","useDefaultObjectProperties","options","getRegexFromString","jsdocParameterNamesDeep","getJsdocTagsDeep","getFunctionParameterNames","getPreferredTagName","isError","contextDefaults","meta","docs","description","url","fixable","schema","additionalProperties","module"],"sources":["../../src/rules/checkParamNames.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {string} targetTagName\n * @param {boolean} allowExtraTrailingParamDocs\n * @param {boolean} checkDestructured\n * @param {boolean} checkRestProperty\n * @param {RegExp} checkTypesRegex\n * @param {boolean} disableExtraPropertyReporting\n * @param {boolean} disableMissingParamChecks\n * @param {boolean} enableFixer\n * @param {import('../jsdocUtils.js').ParamNameInfo[]} functionParameterNames\n * @param {import('comment-parser').Block} jsdoc\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {import('../iterateJsdoc.js').Report} report\n * @returns {boolean}\n */\nconst validateParameterNames = (\n  targetTagName,\n  allowExtraTrailingParamDocs,\n  checkDestructured,\n  checkRestProperty,\n  checkTypesRegex,\n  disableExtraPropertyReporting,\n  disableMissingParamChecks,\n  enableFixer,\n  functionParameterNames, jsdoc, utils, report,\n) => {\n  const paramTags = Object.entries(jsdoc.tags).filter(([\n    , tag,\n  ]) => {\n    return tag.tag === targetTagName;\n  });\n  const paramTagsNonNested = paramTags.filter(([\n    , tag,\n  ]) => {\n    return !tag.name.includes('.');\n  });\n\n  let dotted = 0;\n  let thisOffset = 0;\n\n  // eslint-disable-next-line complexity\n  return paramTags.some(([\n    , tag,\n  ], index) => {\n    /** @type {import('../iterateJsdoc.js').Integer} */\n    let tagsIndex;\n    const dupeTagInfo = paramTags.find(([\n      tgsIndex,\n      tg,\n    ], idx) => {\n      tagsIndex = Number(tgsIndex);\n\n      return tg.name === tag.name && idx !== index;\n    });\n    if (dupeTagInfo) {\n      utils.reportJSDoc(`Duplicate @${targetTagName} \"${tag.name}\"`, dupeTagInfo[1], enableFixer ? () => {\n        utils.removeTag(tagsIndex);\n      } : null);\n\n      return true;\n    }\n\n    if (tag.name.includes('.')) {\n      dotted++;\n\n      return false;\n    }\n\n    let functionParameterName = functionParameterNames[index - dotted + thisOffset];\n    if (functionParameterName === 'this' && tag.name.trim() !== 'this') {\n      ++thisOffset;\n      functionParameterName = functionParameterNames[index - dotted + thisOffset];\n    }\n\n    if (!functionParameterName) {\n      if (allowExtraTrailingParamDocs) {\n        return false;\n      }\n\n      report(\n        `@${targetTagName} \"${tag.name}\" does not match an existing function parameter.`,\n        null,\n        tag,\n      );\n\n      return true;\n    }\n\n    if (\n      typeof functionParameterName === 'object' &&\n        'name' in functionParameterName &&\n        Array.isArray(functionParameterName.name)\n    ) {\n      const actualName = tag.name.trim();\n      const expectedName = functionParameterName.name[index];\n      if (actualName === expectedName) {\n        thisOffset--;\n        return false;\n      }\n\n      report(\n        `Expected @${targetTagName} name to be \"${expectedName}\". Got \"${actualName}\".`,\n        null,\n        tag,\n      );\n      return true;\n    }\n\n    if (Array.isArray(functionParameterName)) {\n      if (!checkDestructured) {\n        return false;\n      }\n\n      if (tag.type && tag.type.search(checkTypesRegex) === -1) {\n        return false;\n      }\n\n      const [\n        parameterName,\n        {\n          annotationParamName,\n          hasPropertyRest,\n          names: properties,\n          rests,\n        },\n      ] =\n        /**\n         * @type {[string | undefined, import('../jsdocUtils.js').FlattendRootInfo & {\n         *   annotationParamName?: string | undefined;\n          }]} */ (functionParameterName);\n      if (annotationParamName !== undefined) {\n        const name = tag.name.trim();\n        if (name !== annotationParamName) {\n          report(`@${targetTagName} \"${name}\" does not match parameter name \"${annotationParamName}\"`, null, tag);\n        }\n      }\n\n      const tagName = parameterName === undefined ? tag.name.trim() : parameterName;\n      const expectedNames = properties.map((name) => {\n        return `${tagName}.${name}`;\n      });\n      const actualNames = paramTags.map(([\n        , paramTag,\n      ]) => {\n        return paramTag.name.trim();\n      });\n      const actualTypes = paramTags.map(([\n        , paramTag,\n      ]) => {\n        return paramTag.type;\n      });\n\n      const missingProperties = [];\n\n      /** @type {string[]} */\n      const notCheckingNames = [];\n\n      for (const [\n        idx,\n        name,\n      ] of expectedNames.entries()) {\n        if (notCheckingNames.some((notCheckingName) => {\n          return name.startsWith(notCheckingName);\n        })) {\n          continue;\n        }\n\n        const actualNameIdx = actualNames.findIndex((actualName) => {\n          return utils.comparePaths(name)(actualName);\n        });\n        if (actualNameIdx === -1) {\n          if (!checkRestProperty && rests[idx]) {\n            continue;\n          }\n\n          const missingIndex = actualNames.findIndex((actualName) => {\n            return utils.pathDoesNotBeginWith(name, actualName);\n          });\n          const line = tag.source[0].number - 1 + (missingIndex > -1 ? missingIndex : actualNames.length);\n          missingProperties.push({\n            name,\n            tagPlacement: {\n              line: line === 0 ? 1 : line,\n            },\n          });\n        } else if (actualTypes[actualNameIdx].search(checkTypesRegex) === -1 && actualTypes[actualNameIdx] !== '') {\n          notCheckingNames.push(name);\n        }\n      }\n\n      const hasMissing = missingProperties.length;\n      if (hasMissing) {\n        for (const {\n          name: missingProperty,\n          tagPlacement,\n        } of missingProperties) {\n          report(`Missing @${targetTagName} \"${missingProperty}\"`, null, tagPlacement);\n        }\n      }\n\n      if (!hasPropertyRest || checkRestProperty) {\n        /** @type {[string, import('comment-parser').Spec][]} */\n        const extraProperties = [];\n        for (const [\n          idx,\n          name,\n        ] of actualNames.entries()) {\n          const match = name.startsWith(tag.name.trim() + '.');\n          if (\n            match && !expectedNames.some(\n              utils.comparePaths(name),\n            ) && !utils.comparePaths(name)(tag.name) &&\n            (!disableExtraPropertyReporting || properties.some((prop) => {\n              return prop.split('.').length >= name.split('.').length - 1;\n            }))\n          ) {\n            extraProperties.push([\n              name, paramTags[idx][1],\n            ]);\n          }\n        }\n\n        if (extraProperties.length) {\n          for (const [\n            extraProperty,\n            tg,\n          ] of extraProperties) {\n            report(`@${targetTagName} \"${extraProperty}\" does not exist on ${tag.name}`, null, tg);\n          }\n\n          return true;\n        }\n      }\n\n      return hasMissing;\n    }\n\n    let funcParamName;\n    if (typeof functionParameterName === 'object') {\n      const {\n        name,\n      } = functionParameterName;\n      funcParamName = name;\n    } else {\n      funcParamName = functionParameterName;\n    }\n\n    if (funcParamName !== tag.name.trim()) {\n      // Todo: Improve for array or object child items\n      const actualNames = paramTagsNonNested.map(([\n        , {\n          name,\n        },\n      ]) => {\n        return name.trim();\n      });\n\n      const expectedNames = functionParameterNames.map((item, idx) => {\n        if (/**\n             * @type {[string|undefined, (import('../jsdocUtils.js').FlattendRootInfo & {\n             *   annotationParamName?: string,\n              })]} */ (item)?.[1]?.names) {\n          return actualNames[idx];\n        }\n\n        return item;\n      }).filter((item) => {\n        return item !== 'this';\n      });\n\n      // When disableMissingParamChecks is true tag names can be omitted.\n      // Report when the tag names do not match the expected names or they are used out of order.\n      if (disableMissingParamChecks) {\n        const usedExpectedNames = expectedNames.map((a) => {\n          return a?.toString();\n        }).filter((expectedName) => {\n          return expectedName && actualNames.includes(expectedName);\n        });\n        const usedInOrder = actualNames.every((actualName, idx) => {\n          return actualName === usedExpectedNames[idx];\n        });\n        if (usedInOrder) {\n          return false;\n        }\n      }\n\n      report(\n        `Expected @${targetTagName} names to be \"${\n          expectedNames.map((expectedName) => {\n            return typeof expectedName === 'object' &&\n              'name' in expectedName &&\n              expectedName.restElement ?\n              '...' + expectedName.name :\n              expectedName;\n          }).join(', ')\n        }\". Got \"${actualNames.join(', ')}\".`,\n        null,\n        tag,\n      );\n\n      return true;\n    }\n\n    return false;\n  });\n};\n\n/**\n * @param {string} targetTagName\n * @param {boolean} _allowExtraTrailingParamDocs\n * @param {{\n *   name: string,\n *   idx: import('../iterateJsdoc.js').Integer\n * }[]} jsdocParameterNames\n * @param {import('comment-parser').Block} jsdoc\n * @param {Function} report\n * @returns {boolean}\n */\nconst validateParameterNamesDeep = (\n  targetTagName, _allowExtraTrailingParamDocs,\n  jsdocParameterNames, jsdoc, report,\n) => {\n  /** @type {string} */\n  let lastRealParameter;\n\n  return jsdocParameterNames.some(({\n    idx,\n    name: jsdocParameterName,\n  }) => {\n    const isPropertyPath = jsdocParameterName.includes('.');\n\n    if (isPropertyPath) {\n      if (!lastRealParameter) {\n        report(`@${targetTagName} path declaration (\"${jsdocParameterName}\") appears before any real parameter.`, null, jsdoc.tags[idx]);\n\n        return true;\n      }\n\n      let pathRootNodeName = jsdocParameterName.slice(0, jsdocParameterName.indexOf('.'));\n\n      if (pathRootNodeName.endsWith('[]')) {\n        pathRootNodeName = pathRootNodeName.slice(0, -2);\n      }\n\n      if (pathRootNodeName !== lastRealParameter) {\n        report(\n          `@${targetTagName} path declaration (\"${jsdocParameterName}\") root node name (\"${pathRootNodeName}\") ` +\n          `does not match previous real parameter name (\"${lastRealParameter}\").`,\n          null,\n          jsdoc.tags[idx],\n        );\n\n        return true;\n      }\n    } else {\n      lastRealParameter = jsdocParameterName;\n    }\n\n    return false;\n  });\n};\n\nconst allowedNodes = [\n  'ArrowFunctionExpression', 'FunctionDeclaration', 'FunctionExpression', 'TSDeclareFunction',\n  // Add this to above defaults\n  'TSMethodSignature',\n];\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  node,\n  report,\n  utils,\n}) => {\n  const {\n    allowExtraTrailingParamDocs,\n    checkDestructured = true,\n    checkRestProperty = false,\n    checkTypesPattern = '/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/',\n    disableExtraPropertyReporting = false,\n    disableMissingParamChecks = false,\n    enableFixer = false,\n    useDefaultObjectProperties = false,\n  } = context.options[0] || {};\n\n  // Although we might just remove global settings contexts from applying to\n  //   this rule (as they can cause problems with `getFunctionParameterNames`\n  //   checks if they are not functions but say variables), the user may\n  //   instead wish to narrow contexts in those settings, so this check\n  //   is still useful\n  if (!allowedNodes.includes(/** @type {import('estree').Node} */ (node).type)) {\n    return;\n  }\n\n  const checkTypesRegex = utils.getRegexFromString(checkTypesPattern);\n\n  const jsdocParameterNamesDeep = utils.getJsdocTagsDeep('param');\n  if (!jsdocParameterNamesDeep || !jsdocParameterNamesDeep.length) {\n    return;\n  }\n\n  const functionParameterNames = utils.getFunctionParameterNames(useDefaultObjectProperties);\n\n  const targetTagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'param',\n  }));\n  const isError = validateParameterNames(\n    targetTagName,\n    allowExtraTrailingParamDocs,\n    checkDestructured,\n    checkRestProperty,\n    checkTypesRegex,\n    disableExtraPropertyReporting,\n    disableMissingParamChecks,\n    enableFixer,\n    functionParameterNames,\n    jsdoc,\n    utils,\n    report,\n  );\n\n  if (isError || !checkDestructured) {\n    return;\n  }\n\n  validateParameterNamesDeep(\n    targetTagName, allowExtraTrailingParamDocs, jsdocParameterNamesDeep, jsdoc, report,\n  );\n}, {\n  contextDefaults: allowedNodes,\n  meta: {\n    docs: {\n      description: 'Ensures that parameter names in JSDoc match those in the function declaration.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-param-names.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          allowExtraTrailingParamDocs: {\n            type: 'boolean',\n          },\n          checkDestructured: {\n            type: 'boolean',\n          },\n          checkRestProperty: {\n            type: 'boolean',\n          },\n          checkTypesPattern: {\n            type: 'string',\n          },\n          disableExtraPropertyReporting: {\n            type: 'boolean',\n          },\n          disableMissingParamChecks: {\n            type: 'boolean',\n          },\n          enableFixer: {\n            type: 'boolean',\n          },\n          useDefaultObjectProperties: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE9C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMG,sBAAsB,GAAGA,CAC7BC,aAAa,EACbC,2BAA2B,EAC3BC,iBAAiB,EACjBC,iBAAiB,EACjBC,eAAe,EACfC,6BAA6B,EAC7BC,yBAAyB,EACzBC,WAAW,EACXC,sBAAsB,EAAEC,KAAK,EAAEC,KAAK,EAAEC,MAAM,KACzC;EACH,MAAMC,SAAS,GAAGC,MAAM,CAACC,OAAO,CAACL,KAAK,CAACM,IAAI,CAAC,CAACC,MAAM,CAAC,CAAC,GACjDC,GAAG,CACN,KAAK;IACJ,OAAOA,GAAG,CAACA,GAAG,KAAKjB,aAAa;EAClC,CAAC,CAAC;EACF,MAAMkB,kBAAkB,GAAGN,SAAS,CAACI,MAAM,CAAC,CAAC,GACzCC,GAAG,CACN,KAAK;IACJ,OAAO,CAACA,GAAG,CAACE,IAAI,CAACC,QAAQ,CAAC,GAAG,CAAC;EAChC,CAAC,CAAC;EAEF,IAAIC,MAAM,GAAG,CAAC;EACd,IAAIC,UAAU,GAAG,CAAC;;EAElB;EACA,OAAOV,SAAS,CAACW,IAAI,CAAC,CAAC,GACnBN,GAAG,CACN,EAAEO,KAAK,KAAK;IACX;IACA,IAAIC,SAAS;IACb,MAAMC,WAAW,GAAGd,SAAS,CAACe,IAAI,CAAC,CAAC,CAClCC,QAAQ,EACRC,EAAE,CACH,EAAEC,GAAG,KAAK;MACTL,SAAS,GAAGM,MAAM,CAACH,QAAQ,CAAC;MAE5B,OAAOC,EAAE,CAACV,IAAI,KAAKF,GAAG,CAACE,IAAI,IAAIW,GAAG,KAAKN,KAAK;IAC9C,CAAC,CAAC;IACF,IAAIE,WAAW,EAAE;MACfhB,KAAK,CAACsB,WAAW,CAAC,cAAchC,aAAa,KAAKiB,GAAG,CAACE,IAAI,GAAG,EAAEO,WAAW,CAAC,CAAC,CAAC,EAAEnB,WAAW,GAAG,MAAM;QACjGG,KAAK,CAACuB,SAAS,CAACR,SAAS,CAAC;MAC5B,CAAC,GAAG,IAAI,CAAC;MAET,OAAO,IAAI;IACb;IAEA,IAAIR,GAAG,CAACE,IAAI,CAACC,QAAQ,CAAC,GAAG,CAAC,EAAE;MAC1BC,MAAM,EAAE;MAER,OAAO,KAAK;IACd;IAEA,IAAIa,qBAAqB,GAAG1B,sBAAsB,CAACgB,KAAK,GAAGH,MAAM,GAAGC,UAAU,CAAC;IAC/E,IAAIY,qBAAqB,KAAK,MAAM,IAAIjB,GAAG,CAACE,IAAI,CAACgB,IAAI,CAAC,CAAC,KAAK,MAAM,EAAE;MAClE,EAAEb,UAAU;MACZY,qBAAqB,GAAG1B,sBAAsB,CAACgB,KAAK,GAAGH,MAAM,GAAGC,UAAU,CAAC;IAC7E;IAEA,IAAI,CAACY,qBAAqB,EAAE;MAC1B,IAAIjC,2BAA2B,EAAE;QAC/B,OAAO,KAAK;MACd;MAEAU,MAAM,CACJ,IAAIX,aAAa,KAAKiB,GAAG,CAACE,IAAI,kDAAkD,EAChF,IAAI,EACJF,GACF,CAAC;MAED,OAAO,IAAI;IACb;IAEA,IACE,OAAOiB,qBAAqB,KAAK,QAAQ,IACvC,MAAM,IAAIA,qBAAqB,IAC/BE,KAAK,CAACC,OAAO,CAACH,qBAAqB,CAACf,IAAI,CAAC,EAC3C;MACA,MAAMmB,UAAU,GAAGrB,GAAG,CAACE,IAAI,CAACgB,IAAI,CAAC,CAAC;MAClC,MAAMI,YAAY,GAAGL,qBAAqB,CAACf,IAAI,CAACK,KAAK,CAAC;MACtD,IAAIc,UAAU,KAAKC,YAAY,EAAE;QAC/BjB,UAAU,EAAE;QACZ,OAAO,KAAK;MACd;MAEAX,MAAM,CACJ,aAAaX,aAAa,gBAAgBuC,YAAY,WAAWD,UAAU,IAAI,EAC/E,IAAI,EACJrB,GACF,CAAC;MACD,OAAO,IAAI;IACb;IAEA,IAAImB,KAAK,CAACC,OAAO,CAACH,qBAAqB,CAAC,EAAE;MACxC,IAAI,CAAChC,iBAAiB,EAAE;QACtB,OAAO,KAAK;MACd;MAEA,IAAIe,GAAG,CAACuB,IAAI,IAAIvB,GAAG,CAACuB,IAAI,CAACC,MAAM,CAACrC,eAAe,CAAC,KAAK,CAAC,CAAC,EAAE;QACvD,OAAO,KAAK;MACd;MAEA,MAAM,CACJsC,aAAa,EACb;QACEC,mBAAmB;QACnBC,eAAe;QACfC,KAAK,EAAEC,UAAU;QACjBC;MACF,CAAC,CACF;MACC;AACR;AACA;AACA;MAAkBb,qBAAsB;MAClC,IAAIS,mBAAmB,KAAKK,SAAS,EAAE;QACrC,MAAM7B,IAAI,GAAGF,GAAG,CAACE,IAAI,CAACgB,IAAI,CAAC,CAAC;QAC5B,IAAIhB,IAAI,KAAKwB,mBAAmB,EAAE;UAChChC,MAAM,CAAC,IAAIX,aAAa,KAAKmB,IAAI,oCAAoCwB,mBAAmB,GAAG,EAAE,IAAI,EAAE1B,GAAG,CAAC;QACzG;MACF;MAEA,MAAMgC,OAAO,GAAGP,aAAa,KAAKM,SAAS,GAAG/B,GAAG,CAACE,IAAI,CAACgB,IAAI,CAAC,CAAC,GAAGO,aAAa;MAC7E,MAAMQ,aAAa,GAAGJ,UAAU,CAACK,GAAG,CAAEhC,IAAI,IAAK;QAC7C,OAAO,GAAG8B,OAAO,IAAI9B,IAAI,EAAE;MAC7B,CAAC,CAAC;MACF,MAAMiC,WAAW,GAAGxC,SAAS,CAACuC,GAAG,CAAC,CAAC,GAC/BE,QAAQ,CACX,KAAK;QACJ,OAAOA,QAAQ,CAAClC,IAAI,CAACgB,IAAI,CAAC,CAAC;MAC7B,CAAC,CAAC;MACF,MAAMmB,WAAW,GAAG1C,SAAS,CAACuC,GAAG,CAAC,CAAC,GAC/BE,QAAQ,CACX,KAAK;QACJ,OAAOA,QAAQ,CAACb,IAAI;MACtB,CAAC,CAAC;MAEF,MAAMe,iBAAiB,GAAG,EAAE;;MAE5B;MACA,MAAMC,gBAAgB,GAAG,EAAE;MAE3B,KAAK,MAAM,CACT1B,GAAG,EACHX,IAAI,CACL,IAAI+B,aAAa,CAACpC,OAAO,CAAC,CAAC,EAAE;QAC5B,IAAI0C,gBAAgB,CAACjC,IAAI,CAAEkC,eAAe,IAAK;UAC7C,OAAOtC,IAAI,CAACuC,UAAU,CAACD,eAAe,CAAC;QACzC,CAAC,CAAC,EAAE;UACF;QACF;QAEA,MAAME,aAAa,GAAGP,WAAW,CAACQ,SAAS,CAAEtB,UAAU,IAAK;UAC1D,OAAO5B,KAAK,CAACmD,YAAY,CAAC1C,IAAI,CAAC,CAACmB,UAAU,CAAC;QAC7C,CAAC,CAAC;QACF,IAAIqB,aAAa,KAAK,CAAC,CAAC,EAAE;UACxB,IAAI,CAACxD,iBAAiB,IAAI4C,KAAK,CAACjB,GAAG,CAAC,EAAE;YACpC;UACF;UAEA,MAAMgC,YAAY,GAAGV,WAAW,CAACQ,SAAS,CAAEtB,UAAU,IAAK;YACzD,OAAO5B,KAAK,CAACqD,oBAAoB,CAAC5C,IAAI,EAAEmB,UAAU,CAAC;UACrD,CAAC,CAAC;UACF,MAAM0B,IAAI,GAAG/C,GAAG,CAACgD,MAAM,CAAC,CAAC,CAAC,CAACC,MAAM,GAAG,CAAC,IAAIJ,YAAY,GAAG,CAAC,CAAC,GAAGA,YAAY,GAAGV,WAAW,CAACe,MAAM,CAAC;UAC/FZ,iBAAiB,CAACa,IAAI,CAAC;YACrBjD,IAAI;YACJkD,YAAY,EAAE;cACZL,IAAI,EAAEA,IAAI,KAAK,CAAC,GAAG,CAAC,GAAGA;YACzB;UACF,CAAC,CAAC;QACJ,CAAC,MAAM,IAAIV,WAAW,CAACK,aAAa,CAAC,CAAClB,MAAM,CAACrC,eAAe,CAAC,KAAK,CAAC,CAAC,IAAIkD,WAAW,CAACK,aAAa,CAAC,KAAK,EAAE,EAAE;UACzGH,gBAAgB,CAACY,IAAI,CAACjD,IAAI,CAAC;QAC7B;MACF;MAEA,MAAMmD,UAAU,GAAGf,iBAAiB,CAACY,MAAM;MAC3C,IAAIG,UAAU,EAAE;QACd,KAAK,MAAM;UACTnD,IAAI,EAAEoD,eAAe;UACrBF;QACF,CAAC,IAAId,iBAAiB,EAAE;UACtB5C,MAAM,CAAC,YAAYX,aAAa,KAAKuE,eAAe,GAAG,EAAE,IAAI,EAAEF,YAAY,CAAC;QAC9E;MACF;MAEA,IAAI,CAACzB,eAAe,IAAIzC,iBAAiB,EAAE;QACzC;QACA,MAAMqE,eAAe,GAAG,EAAE;QAC1B,KAAK,MAAM,CACT1C,GAAG,EACHX,IAAI,CACL,IAAIiC,WAAW,CAACtC,OAAO,CAAC,CAAC,EAAE;UAC1B,MAAM2D,KAAK,GAAGtD,IAAI,CAACuC,UAAU,CAACzC,GAAG,CAACE,IAAI,CAACgB,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;UACpD,IACEsC,KAAK,IAAI,CAACvB,aAAa,CAAC3B,IAAI,CAC1Bb,KAAK,CAACmD,YAAY,CAAC1C,IAAI,CACzB,CAAC,IAAI,CAACT,KAAK,CAACmD,YAAY,CAAC1C,IAAI,CAAC,CAACF,GAAG,CAACE,IAAI,CAAC,KACvC,CAACd,6BAA6B,IAAIyC,UAAU,CAACvB,IAAI,CAAEmD,IAAI,IAAK;YAC3D,OAAOA,IAAI,CAACC,KAAK,CAAC,GAAG,CAAC,CAACR,MAAM,IAAIhD,IAAI,CAACwD,KAAK,CAAC,GAAG,CAAC,CAACR,MAAM,GAAG,CAAC;UAC7D,CAAC,CAAC,CAAC,EACH;YACAK,eAAe,CAACJ,IAAI,CAAC,CACnBjD,IAAI,EAAEP,SAAS,CAACkB,GAAG,CAAC,CAAC,CAAC,CAAC,CACxB,CAAC;UACJ;QACF;QAEA,IAAI0C,eAAe,CAACL,MAAM,EAAE;UAC1B,KAAK,MAAM,CACTS,aAAa,EACb/C,EAAE,CACH,IAAI2C,eAAe,EAAE;YACpB7D,MAAM,CAAC,IAAIX,aAAa,KAAK4E,aAAa,uBAAuB3D,GAAG,CAACE,IAAI,EAAE,EAAE,IAAI,EAAEU,EAAE,CAAC;UACxF;UAEA,OAAO,IAAI;QACb;MACF;MAEA,OAAOyC,UAAU;IACnB;IAEA,IAAIO,aAAa;IACjB,IAAI,OAAO3C,qBAAqB,KAAK,QAAQ,EAAE;MAC7C,MAAM;QACJf;MACF,CAAC,GAAGe,qBAAqB;MACzB2C,aAAa,GAAG1D,IAAI;IACtB,CAAC,MAAM;MACL0D,aAAa,GAAG3C,qBAAqB;IACvC;IAEA,IAAI2C,aAAa,KAAK5D,GAAG,CAACE,IAAI,CAACgB,IAAI,CAAC,CAAC,EAAE;MACrC;MACA,MAAMiB,WAAW,GAAGlC,kBAAkB,CAACiC,GAAG,CAAC,CAAC,GACxC;QACAhC;MACF,CAAC,CACF,KAAK;QACJ,OAAOA,IAAI,CAACgB,IAAI,CAAC,CAAC;MACpB,CAAC,CAAC;MAEF,MAAMe,aAAa,GAAG1C,sBAAsB,CAAC2C,GAAG,CAAC,CAAC2B,IAAI,EAAEhD,GAAG,KAAK;QAC9D;QAAI;AACZ;AACA;AACA;QAAuBgD,IAAI,GAAI,CAAC,CAAC,EAAEjC,KAAK,EAAE;UAChC,OAAOO,WAAW,CAACtB,GAAG,CAAC;QACzB;QAEA,OAAOgD,IAAI;MACb,CAAC,CAAC,CAAC9D,MAAM,CAAE8D,IAAI,IAAK;QAClB,OAAOA,IAAI,KAAK,MAAM;MACxB,CAAC,CAAC;;MAEF;MACA;MACA,IAAIxE,yBAAyB,EAAE;QAC7B,MAAMyE,iBAAiB,GAAG7B,aAAa,CAACC,GAAG,CAAE6B,CAAC,IAAK;UACjD,OAAOA,CAAC,EAAEC,QAAQ,CAAC,CAAC;QACtB,CAAC,CAAC,CAACjE,MAAM,CAAEuB,YAAY,IAAK;UAC1B,OAAOA,YAAY,IAAIa,WAAW,CAAChC,QAAQ,CAACmB,YAAY,CAAC;QAC3D,CAAC,CAAC;QACF,MAAM2C,WAAW,GAAG9B,WAAW,CAAC+B,KAAK,CAAC,CAAC7C,UAAU,EAAER,GAAG,KAAK;UACzD,OAAOQ,UAAU,KAAKyC,iBAAiB,CAACjD,GAAG,CAAC;QAC9C,CAAC,CAAC;QACF,IAAIoD,WAAW,EAAE;UACf,OAAO,KAAK;QACd;MACF;MAEAvE,MAAM,CACJ,aAAaX,aAAa,iBACxBkD,aAAa,CAACC,GAAG,CAAEZ,YAAY,IAAK;QAClC,OAAO,OAAOA,YAAY,KAAK,QAAQ,IACrC,MAAM,IAAIA,YAAY,IACtBA,YAAY,CAAC6C,WAAW,GACxB,KAAK,GAAG7C,YAAY,CAACpB,IAAI,GACzBoB,YAAY;MAChB,CAAC,CAAC,CAAC8C,IAAI,CAAC,IAAI,CAAC,WACJjC,WAAW,CAACiC,IAAI,CAAC,IAAI,CAAC,IAAI,EACrC,IAAI,EACJpE,GACF,CAAC;MAED,OAAO,IAAI;IACb;IAEA,OAAO,KAAK;EACd,CAAC,CAAC;AACJ,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMqE,0BAA0B,GAAGA,CACjCtF,aAAa,EAAEuF,4BAA4B,EAC3CC,mBAAmB,EAAE/E,KAAK,EAAEE,MAAM,KAC/B;EACH;EACA,IAAI8E,iBAAiB;EAErB,OAAOD,mBAAmB,CAACjE,IAAI,CAAC,CAAC;IAC/BO,GAAG;IACHX,IAAI,EAAEuE;EACR,CAAC,KAAK;IACJ,MAAMC,cAAc,GAAGD,kBAAkB,CAACtE,QAAQ,CAAC,GAAG,CAAC;IAEvD,IAAIuE,cAAc,EAAE;MAClB,IAAI,CAACF,iBAAiB,EAAE;QACtB9E,MAAM,CAAC,IAAIX,aAAa,uBAAuB0F,kBAAkB,uCAAuC,EAAE,IAAI,EAAEjF,KAAK,CAACM,IAAI,CAACe,GAAG,CAAC,CAAC;QAEhI,OAAO,IAAI;MACb;MAEA,IAAI8D,gBAAgB,GAAGF,kBAAkB,CAACG,KAAK,CAAC,CAAC,EAAEH,kBAAkB,CAACI,OAAO,CAAC,GAAG,CAAC,CAAC;MAEnF,IAAIF,gBAAgB,CAACG,QAAQ,CAAC,IAAI,CAAC,EAAE;QACnCH,gBAAgB,GAAGA,gBAAgB,CAACC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;MAClD;MAEA,IAAID,gBAAgB,KAAKH,iBAAiB,EAAE;QAC1C9E,MAAM,CACJ,IAAIX,aAAa,uBAAuB0F,kBAAkB,uBAAuBE,gBAAgB,KAAK,GACtG,iDAAiDH,iBAAiB,KAAK,EACvE,IAAI,EACJhF,KAAK,CAACM,IAAI,CAACe,GAAG,CAChB,CAAC;QAED,OAAO,IAAI;MACb;IACF,CAAC,MAAM;MACL2D,iBAAiB,GAAGC,kBAAkB;IACxC;IAEA,OAAO,KAAK;EACd,CAAC,CAAC;AACJ,CAAC;AAED,MAAMM,YAAY,GAAG,CACnB,yBAAyB,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,mBAAmB;AAC3F;AACA,mBAAmB,CACpB;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAApG,OAAA,GAEa,IAAAqG,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACP3F,KAAK;EACL4F,IAAI;EACJ1F,MAAM;EACND;AACF,CAAC,KAAK;EACJ,MAAM;IACJT,2BAA2B;IAC3BC,iBAAiB,GAAG,IAAI;IACxBC,iBAAiB,GAAG,KAAK;IACzBmG,iBAAiB,GAAG,gEAAgE;IACpFjG,6BAA6B,GAAG,KAAK;IACrCC,yBAAyB,GAAG,KAAK;IACjCC,WAAW,GAAG,KAAK;IACnBgG,0BAA0B,GAAG;EAC/B,CAAC,GAAGH,OAAO,CAACI,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;EAE5B;EACA;EACA;EACA;EACA;EACA,IAAI,CAACR,YAAY,CAAC5E,QAAQ,CAAC,oCAAsCiF,IAAI,CAAE7D,IAAI,CAAC,EAAE;IAC5E;EACF;EAEA,MAAMpC,eAAe,GAAGM,KAAK,CAAC+F,kBAAkB,CAACH,iBAAiB,CAAC;EAEnE,MAAMI,uBAAuB,GAAGhG,KAAK,CAACiG,gBAAgB,CAAC,OAAO,CAAC;EAC/D,IAAI,CAACD,uBAAuB,IAAI,CAACA,uBAAuB,CAACvC,MAAM,EAAE;IAC/D;EACF;EAEA,MAAM3D,sBAAsB,GAAGE,KAAK,CAACkG,yBAAyB,CAACL,0BAA0B,CAAC;EAE1F,MAAMvG,aAAa,GAAG,qBAAuBU,KAAK,CAACmG,mBAAmB,CAAC;IACrE5D,OAAO,EAAE;EACX,CAAC,CAAE;EACH,MAAM6D,OAAO,GAAG/G,sBAAsB,CACpCC,aAAa,EACbC,2BAA2B,EAC3BC,iBAAiB,EACjBC,iBAAiB,EACjBC,eAAe,EACfC,6BAA6B,EAC7BC,yBAAyB,EACzBC,WAAW,EACXC,sBAAsB,EACtBC,KAAK,EACLC,KAAK,EACLC,MACF,CAAC;EAED,IAAImG,OAAO,IAAI,CAAC5G,iBAAiB,EAAE;IACjC;EACF;EAEAoF,0BAA0B,CACxBtF,aAAa,EAAEC,2BAA2B,EAAEyG,uBAAuB,EAAEjG,KAAK,EAAEE,MAC9E,CAAC;AACH,CAAC,EAAE;EACDoG,eAAe,EAAEf,YAAY;EAC7BgB,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,gFAAgF;MAC7FC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BxE,UAAU,EAAE;QACV7C,2BAA2B,EAAE;UAC3BuC,IAAI,EAAE;QACR,CAAC;QACDtC,iBAAiB,EAAE;UACjBsC,IAAI,EAAE;QACR,CAAC;QACDrC,iBAAiB,EAAE;UACjBqC,IAAI,EAAE;QACR,CAAC;QACD8D,iBAAiB,EAAE;UACjB9D,IAAI,EAAE;QACR,CAAC;QACDnC,6BAA6B,EAAE;UAC7BmC,IAAI,EAAE;QACR,CAAC;QACDlC,yBAAyB,EAAE;UACzBkC,IAAI,EAAE;QACR,CAAC;QACDjC,WAAW,EAAE;UACXiC,IAAI,EAAE;QACR,CAAC;QACD+D,0BAA0B,EAAE;UAC1B/D,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA+E,MAAA,CAAArB,OAAA,GAAAA,OAAA,CAAApG,OAAA","ignoreList":[]}
+{"version":3,"file":"checkParamNames.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/checkParamNames.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {string} targetTagName\n * @param {boolean} allowExtraTrailingParamDocs\n * @param {boolean} checkDestructured\n * @param {boolean} checkRestProperty\n * @param {RegExp} checkTypesRegex\n * @param {boolean} disableExtraPropertyReporting\n * @param {boolean} disableMissingParamChecks\n * @param {boolean} enableFixer\n * @param {import('../jsdocUtils.js').ParamNameInfo[]} functionParameterNames\n * @param {import('comment-parser').Block} jsdoc\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {import('../iterateJsdoc.js').Report} report\n * @returns {boolean}\n */\nconst validateParameterNames = (\n  targetTagName,\n  allowExtraTrailingParamDocs,\n  checkDestructured,\n  checkRestProperty,\n  checkTypesRegex,\n  disableExtraPropertyReporting,\n  disableMissingParamChecks,\n  enableFixer,\n  functionParameterNames, jsdoc, utils, report,\n) => {\n  const paramTags = Object.entries(jsdoc.tags).filter(([\n    , tag,\n  ]) => {\n    return tag.tag === targetTagName;\n  });\n  const paramTagsNonNested = paramTags.filter(([\n    , tag,\n  ]) => {\n    return !tag.name.includes('.');\n  });\n\n  let dotted = 0;\n  let thisOffset = 0;\n\n  // eslint-disable-next-line complexity\n  return paramTags.some(([\n    , tag,\n  ], index) => {\n    /** @type {import('../iterateJsdoc.js').Integer} */\n    let tagsIndex;\n    const dupeTagInfo = paramTags.find(([\n      tgsIndex,\n      tg,\n    ], idx) => {\n      tagsIndex = Number(tgsIndex);\n\n      return tg.name === tag.name && idx !== index;\n    });\n    if (dupeTagInfo) {\n      utils.reportJSDoc(`Duplicate @${targetTagName} \"${tag.name}\"`, dupeTagInfo[1], enableFixer ? () => {\n        utils.removeTag(tagsIndex);\n      } : null);\n\n      return true;\n    }\n\n    if (tag.name.includes('.')) {\n      dotted++;\n\n      return false;\n    }\n\n    let functionParameterName = functionParameterNames[index - dotted + thisOffset];\n    if (functionParameterName === 'this' && tag.name.trim() !== 'this') {\n      ++thisOffset;\n      functionParameterName = functionParameterNames[index - dotted + thisOffset];\n    }\n\n    if (!functionParameterName) {\n      if (allowExtraTrailingParamDocs) {\n        return false;\n      }\n\n      report(\n        `@${targetTagName} \"${tag.name}\" does not match an existing function parameter.`,\n        null,\n        tag,\n      );\n\n      return true;\n    }\n\n    if (\n      typeof functionParameterName === 'object' &&\n        'name' in functionParameterName &&\n        Array.isArray(functionParameterName.name)\n    ) {\n      const actualName = tag.name.trim();\n      const expectedName = functionParameterName.name[index];\n      if (actualName === expectedName) {\n        thisOffset--;\n        return false;\n      }\n\n      report(\n        `Expected @${targetTagName} name to be \"${expectedName}\". Got \"${actualName}\".`,\n        null,\n        tag,\n      );\n      return true;\n    }\n\n    if (Array.isArray(functionParameterName)) {\n      if (!checkDestructured) {\n        return false;\n      }\n\n      if (tag.type && tag.type.search(checkTypesRegex) === -1) {\n        return false;\n      }\n\n      const [\n        parameterName,\n        {\n          annotationParamName,\n          hasPropertyRest,\n          names: properties,\n          rests,\n        },\n      ] =\n        /**\n         * @type {[string | undefined, import('../jsdocUtils.js').FlattendRootInfo & {\n         *   annotationParamName?: string | undefined;\n          }]} */ (functionParameterName);\n      if (annotationParamName !== undefined) {\n        const name = tag.name.trim();\n        if (name !== annotationParamName) {\n          report(`@${targetTagName} \"${name}\" does not match parameter name \"${annotationParamName}\"`, null, tag);\n        }\n      }\n\n      const tagName = parameterName === undefined ? tag.name.trim() : parameterName;\n      const expectedNames = properties.map((name) => {\n        return `${tagName}.${name}`;\n      });\n      const actualNames = paramTags.map(([\n        , paramTag,\n      ]) => {\n        return paramTag.name.trim();\n      });\n      const actualTypes = paramTags.map(([\n        , paramTag,\n      ]) => {\n        return paramTag.type;\n      });\n\n      const missingProperties = [];\n\n      /** @type {string[]} */\n      const notCheckingNames = [];\n\n      for (const [\n        idx,\n        name,\n      ] of expectedNames.entries()) {\n        if (notCheckingNames.some((notCheckingName) => {\n          return name.startsWith(notCheckingName);\n        })) {\n          continue;\n        }\n\n        const actualNameIdx = actualNames.findIndex((actualName) => {\n          return utils.comparePaths(name)(actualName);\n        });\n        if (actualNameIdx === -1) {\n          if (!checkRestProperty && rests[idx]) {\n            continue;\n          }\n\n          const missingIndex = actualNames.findIndex((actualName) => {\n            return utils.pathDoesNotBeginWith(name, actualName);\n          });\n          const line = tag.source[0].number - 1 + (missingIndex > -1 ? missingIndex : actualNames.length);\n          missingProperties.push({\n            name,\n            tagPlacement: {\n              line: line === 0 ? 1 : line,\n            },\n          });\n        } else if (actualTypes[actualNameIdx].search(checkTypesRegex) === -1 && actualTypes[actualNameIdx] !== '') {\n          notCheckingNames.push(name);\n        }\n      }\n\n      const hasMissing = missingProperties.length;\n      if (hasMissing) {\n        for (const {\n          name: missingProperty,\n          tagPlacement,\n        } of missingProperties) {\n          report(`Missing @${targetTagName} \"${missingProperty}\"`, null, tagPlacement);\n        }\n      }\n\n      if (!hasPropertyRest || checkRestProperty) {\n        /** @type {[string, import('comment-parser').Spec][]} */\n        const extraProperties = [];\n        for (const [\n          idx,\n          name,\n        ] of actualNames.entries()) {\n          const match = name.startsWith(tag.name.trim() + '.');\n          if (\n            match && !expectedNames.some(\n              utils.comparePaths(name),\n            ) && !utils.comparePaths(name)(tag.name) &&\n            (!disableExtraPropertyReporting || properties.some((prop) => {\n              return prop.split('.').length >= name.split('.').length - 1;\n            }))\n          ) {\n            extraProperties.push([\n              name, paramTags[idx][1],\n            ]);\n          }\n        }\n\n        if (extraProperties.length) {\n          for (const [\n            extraProperty,\n            tg,\n          ] of extraProperties) {\n            report(`@${targetTagName} \"${extraProperty}\" does not exist on ${tag.name}`, null, tg);\n          }\n\n          return true;\n        }\n      }\n\n      return hasMissing;\n    }\n\n    let funcParamName;\n    if (typeof functionParameterName === 'object') {\n      const {\n        name,\n      } = functionParameterName;\n      funcParamName = name;\n    } else {\n      funcParamName = functionParameterName;\n    }\n\n    if (funcParamName !== tag.name.trim()) {\n      // Todo: Improve for array or object child items\n      const actualNames = paramTagsNonNested.map(([\n        , {\n          name,\n        },\n      ]) => {\n        return name.trim();\n      });\n\n      const expectedNames = functionParameterNames.map((item, idx) => {\n        if (/**\n             * @type {[string|undefined, (import('../jsdocUtils.js').FlattendRootInfo & {\n             *   annotationParamName?: string,\n              })]} */ (item)?.[1]?.names) {\n          return actualNames[idx];\n        }\n\n        return item;\n      }).filter((item) => {\n        return item !== 'this';\n      });\n\n      // When disableMissingParamChecks is true tag names can be omitted.\n      // Report when the tag names do not match the expected names or they are used out of order.\n      if (disableMissingParamChecks) {\n        const usedExpectedNames = expectedNames.map((a) => {\n          return a?.toString();\n        }).filter((expectedName) => {\n          return expectedName && actualNames.includes(expectedName);\n        });\n        const usedInOrder = actualNames.every((actualName, idx) => {\n          return actualName === usedExpectedNames[idx];\n        });\n        if (usedInOrder) {\n          return false;\n        }\n      }\n\n      report(\n        `Expected @${targetTagName} names to be \"${\n          expectedNames.map((expectedName) => {\n            return typeof expectedName === 'object' &&\n              'name' in expectedName &&\n              expectedName.restElement ?\n              '...' + expectedName.name :\n              expectedName;\n          }).join(', ')\n        }\". Got \"${actualNames.join(', ')}\".`,\n        null,\n        tag,\n      );\n\n      return true;\n    }\n\n    return false;\n  });\n};\n\n/**\n * @param {string} targetTagName\n * @param {boolean} _allowExtraTrailingParamDocs\n * @param {{\n *   name: string,\n *   idx: import('../iterateJsdoc.js').Integer\n * }[]} jsdocParameterNames\n * @param {import('comment-parser').Block} jsdoc\n * @param {Function} report\n * @returns {boolean}\n */\nconst validateParameterNamesDeep = (\n  targetTagName, _allowExtraTrailingParamDocs,\n  jsdocParameterNames, jsdoc, report,\n) => {\n  /** @type {string} */\n  let lastRealParameter;\n\n  return jsdocParameterNames.some(({\n    idx,\n    name: jsdocParameterName,\n  }) => {\n    const isPropertyPath = jsdocParameterName.includes('.');\n\n    if (isPropertyPath) {\n      if (!lastRealParameter) {\n        report(`@${targetTagName} path declaration (\"${jsdocParameterName}\") appears before any real parameter.`, null, jsdoc.tags[idx]);\n\n        return true;\n      }\n\n      let pathRootNodeName = jsdocParameterName.slice(0, jsdocParameterName.indexOf('.'));\n\n      if (pathRootNodeName.endsWith('[]')) {\n        pathRootNodeName = pathRootNodeName.slice(0, -2);\n      }\n\n      if (pathRootNodeName !== lastRealParameter) {\n        report(\n          `@${targetTagName} path declaration (\"${jsdocParameterName}\") root node name (\"${pathRootNodeName}\") ` +\n          `does not match previous real parameter name (\"${lastRealParameter}\").`,\n          null,\n          jsdoc.tags[idx],\n        );\n\n        return true;\n      }\n    } else {\n      lastRealParameter = jsdocParameterName;\n    }\n\n    return false;\n  });\n};\n\nconst allowedNodes = [\n  'ArrowFunctionExpression', 'FunctionDeclaration', 'FunctionExpression', 'TSDeclareFunction',\n  // Add this to above defaults\n  'TSMethodSignature',\n];\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  node,\n  report,\n  utils,\n}) => {\n  const {\n    allowExtraTrailingParamDocs,\n    checkDestructured = true,\n    checkRestProperty = false,\n    checkTypesPattern = '/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/',\n    disableExtraPropertyReporting = false,\n    disableMissingParamChecks = false,\n    enableFixer = false,\n    useDefaultObjectProperties = false,\n  } = context.options[0] || {};\n\n  // Although we might just remove global settings contexts from applying to\n  //   this rule (as they can cause problems with `getFunctionParameterNames`\n  //   checks if they are not functions but say variables), the user may\n  //   instead wish to narrow contexts in those settings, so this check\n  //   is still useful\n  if (!allowedNodes.includes(/** @type {import('estree').Node} */ (node).type)) {\n    return;\n  }\n\n  const checkTypesRegex = utils.getRegexFromString(checkTypesPattern);\n\n  const jsdocParameterNamesDeep = utils.getJsdocTagsDeep('param');\n  if (!jsdocParameterNamesDeep || !jsdocParameterNamesDeep.length) {\n    return;\n  }\n\n  const functionParameterNames = utils.getFunctionParameterNames(useDefaultObjectProperties);\n\n  const targetTagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'param',\n  }));\n  const isError = validateParameterNames(\n    targetTagName,\n    allowExtraTrailingParamDocs,\n    checkDestructured,\n    checkRestProperty,\n    checkTypesRegex,\n    disableExtraPropertyReporting,\n    disableMissingParamChecks,\n    enableFixer,\n    functionParameterNames,\n    jsdoc,\n    utils,\n    report,\n  );\n\n  if (isError || !checkDestructured) {\n    return;\n  }\n\n  validateParameterNamesDeep(\n    targetTagName, allowExtraTrailingParamDocs, jsdocParameterNamesDeep, jsdoc, report,\n  );\n}, {\n  contextDefaults: allowedNodes,\n  meta: {\n    docs: {\n      description: 'Ensures that parameter names in JSDoc match those in the function declaration.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-param-names.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          allowExtraTrailingParamDocs: {\n            type: 'boolean',\n          },\n          checkDestructured: {\n            type: 'boolean',\n          },\n          checkRestProperty: {\n            type: 'boolean',\n          },\n          checkTypesPattern: {\n            type: 'string',\n          },\n          disableExtraPropertyReporting: {\n            type: 'boolean',\n          },\n          disableMissingParamChecks: {\n            type: 'boolean',\n          },\n          enableFixer: {\n            type: 'boolean',\n          },\n          useDefaultObjectProperties: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;AAiBA,MAAM,yBAAyB,CAC7B,eACA,6BACA,mBACA,mBACA,iBACA,+BACA,2BACA,aACA,wBAAwB,OAAO,OAAO,WACnC;CACH,MAAM,YAAY,OAAO,QAAQ,MAAM,KAAK,CAAC,OAAO,CAAC,GACjD,IACH,KAAK;AACJ,SAAO,IAAI,QAAQ;CACpB,EAAC;CACF,MAAM,qBAAqB,UAAU,OAAO,CAAC,GACzC,IACH,KAAK;AACJ,SAAO,CAAC,IAAI,KAAK,SAAS,IAAI;CAC/B,EAAC;CAEF,IAAI,SAAS;CACb,IAAI,aAAa;AAGjB,QAAO,UAAU,KAAK,CAAC,GACnB,IACH,EAAE,UAAU;;EAEX,IAAI;EACJ,MAAM,cAAc,UAAU,KAAK,CAAC,CAClC,UACA,GACD,EAAE,QAAQ;GACT,YAAY,OAAO,SAAS;AAE5B,UAAO,GAAG,SAAS,IAAI,QAAQ,QAAQ;EACxC,EAAC;AACF,MAAI,aAAa;GACf,MAAM,YAAY,CAAC,WAAW,EAAE,cAAc,EAAE,EAAE,IAAI,KAAK,CAAC,CAAC,EAAE,YAAY,IAAI,cAAc,MAAM;IACjG,MAAM,UAAU,UAAU;GAC3B,IAAG,KAAK;AAET,UAAO;EACR;AAED,MAAI,IAAI,KAAK,SAAS,IAAI,EAAE;GAC1B;AAEA,UAAO;EACR;EAED,IAAI,wBAAwB,uBAAuB,QAAQ,SAAS;AACpE,MAAI,0BAA0B,UAAU,IAAI,KAAK,MAAM,KAAK,QAAQ;GAClE,EAAE;GACF,wBAAwB,uBAAuB,QAAQ,SAAS;EACjE;AAED,MAAI,CAAC,uBAAuB;AAC1B,OAAI,4BACF,QAAO;GAGT,OACE,CAAC,CAAC,EAAE,cAAc,EAAE,EAAE,IAAI,KAAK,gDAAgD,CAAC,EAChF,MACA,IACD;AAED,UAAO;EACR;AAED,MACE,OAAO,0BAA0B,YAC/B,UAAU,yBACV,MAAM,QAAQ,sBAAsB,KAAK,EAC3C;GACA,MAAM,aAAa,IAAI,KAAK,MAAM;GAClC,MAAM,eAAe,sBAAsB,KAAK;AAChD,OAAI,eAAe,cAAc;IAC/B;AACA,WAAO;GACR;GAED,OACE,CAAC,UAAU,EAAE,cAAc,aAAa,EAAE,aAAa,QAAQ,EAAE,WAAW,EAAE,CAAC,EAC/E,MACA,IACD;AACD,UAAO;EACR;AAED,MAAI,MAAM,QAAQ,sBAAsB,EAAE;AACxC,OAAI,CAAC,kBACH,QAAO;AAGT,OAAI,IAAI,QAAQ,IAAI,KAAK,OAAO,gBAAgB,KAAK,GACnD,QAAO;GAGT,MAAM,CACJ,eACA,EACE,qBACA,iBACA,OAAO,YACP,OACD,CACF,GAIW;AACZ,OAAI,wBAAwB,QAAW;IACrC,MAAM,OAAO,IAAI,KAAK,MAAM;AAC5B,QAAI,SAAS,qBACX,OAAO,CAAC,CAAC,EAAE,cAAc,EAAE,EAAE,KAAK,iCAAiC,EAAE,oBAAoB,CAAC,CAAC,EAAE,MAAM,IAAI;GAE1G;GAED,MAAM,UAAU,kBAAkB,SAAY,IAAI,KAAK,MAAM,GAAG;GAChE,MAAM,gBAAgB,WAAW,IAAI,CAAC,SAAS;AAC7C,WAAO,GAAG,QAAQ,CAAC,EAAE,MAAM;GAC5B,EAAC;GACF,MAAM,cAAc,UAAU,IAAI,CAAC,GAC/B,SACH,KAAK;AACJ,WAAO,SAAS,KAAK,MAAM;GAC5B,EAAC;GACF,MAAM,cAAc,UAAU,IAAI,CAAC,GAC/B,SACH,KAAK;AACJ,WAAO,SAAS;GACjB,EAAC;GAEF,MAAM,oBAAoB,CAAE;;GAG5B,MAAM,mBAAmB,CAAE;AAE3B,QAAK,MAAM,CACT,KACA,KACD,IAAI,cAAc,SAAS,EAAE;AAC5B,QAAI,iBAAiB,KAAK,CAAC,oBAAoB;AAC7C,YAAO,KAAK,WAAW,gBAAgB;IACxC,EAAC,CACA;IAGF,MAAM,gBAAgB,YAAY,UAAU,CAAC,eAAe;AAC1D,YAAO,MAAM,aAAa,KAAK,CAAC,WAAW;IAC5C,EAAC;AACF,QAAI,kBAAkB,IAAI;AACxB,SAAI,CAAC,qBAAqB,MAAM,KAC9B;KAGF,MAAM,eAAe,YAAY,UAAU,CAAC,eAAe;AACzD,aAAO,MAAM,qBAAqB,MAAM,WAAW;KACpD,EAAC;KACF,MAAM,OAAO,IAAI,OAAO,GAAG,SAAS,KAAK,eAAe,KAAK,eAAe,YAAY;KACxF,kBAAkB,KAAK;MACrB;MACA,cAAc,EACZ,MAAM,SAAS,IAAI,IAAI,KACxB;KACF,EAAC;IACH,WAAU,YAAY,eAAe,OAAO,gBAAgB,KAAK,MAAM,YAAY,mBAAmB,IACrG,iBAAiB,KAAK,KAAK;GAE9B;GAED,MAAM,aAAa,kBAAkB;AACrC,OAAI,WACF,MAAK,MAAM,EACT,MAAM,iBACN,cACD,IAAI,mBACH,OAAO,CAAC,SAAS,EAAE,cAAc,EAAE,EAAE,gBAAgB,CAAC,CAAC,EAAE,MAAM,aAAa;AAIhF,OAAI,CAAC,mBAAmB,mBAAmB;;IAEzC,MAAM,kBAAkB,CAAE;AAC1B,SAAK,MAAM,CACT,KACA,KACD,IAAI,YAAY,SAAS,EAAE;KAC1B,MAAM,QAAQ,KAAK,WAAW,IAAI,KAAK,MAAM,GAAG,IAAI;AACpD,SACE,SAAS,CAAC,cAAc,KACtB,MAAM,aAAa,KAAK,CACzB,IAAI,CAAC,MAAM,aAAa,KAAK,CAAC,IAAI,KAAK,KACvC,CAAC,iCAAiC,WAAW,KAAK,CAAC,SAAS;AAC3D,aAAO,KAAK,MAAM,IAAI,CAAC,UAAU,KAAK,MAAM,IAAI,CAAC,SAAS;KAC3D,EAAC,GAEF,gBAAgB,KAAK,CACnB,MAAM,UAAU,KAAK,EACtB,EAAC;IAEL;AAED,QAAI,gBAAgB,QAAQ;AAC1B,UAAK,MAAM,CACT,eACA,GACD,IAAI,iBACH,OAAO,CAAC,CAAC,EAAE,cAAc,EAAE,EAAE,cAAc,oBAAoB,EAAE,IAAI,MAAM,EAAE,MAAM,GAAG;AAGxF,YAAO;IACR;GACF;AAED,UAAO;EACR;EAED,IAAI;AACJ,MAAI,OAAO,0BAA0B,UAAU;GAC7C,MAAM,EACJ,MACD,GAAG;GACJ,gBAAgB;EACjB,OACC,gBAAgB;AAGlB,MAAI,kBAAkB,IAAI,KAAK,MAAM,EAAE;GAErC,MAAM,cAAc,mBAAmB,IAAI,CAAC,GACxC,EACA,MACD,CACF,KAAK;AACJ,WAAO,KAAK,MAAM;GACnB,EAAC;GAEF,MAAM,gBAAgB,uBAAuB,IAAI,CAAC,MAAM,QAAQ;AAC9D,QAGe,OAAQ,IAAI,MACzB,QAAO,YAAY;AAGrB,WAAO;GACR,EAAC,CAAC,OAAO,CAAC,SAAS;AAClB,WAAO,SAAS;GACjB,EAAC;AAIF,OAAI,2BAA2B;IAC7B,MAAM,oBAAoB,cAAc,IAAI,CAAC,MAAM;AACjD,YAAO,GAAG,UAAU;IACrB,EAAC,CAAC,OAAO,CAAC,iBAAiB;AAC1B,YAAO,gBAAgB,YAAY,SAAS,aAAa;IAC1D,EAAC;IACF,MAAM,cAAc,YAAY,MAAM,CAAC,YAAY,QAAQ;AACzD,YAAO,eAAe,kBAAkB;IACzC,EAAC;AACF,QAAI,YACF,QAAO;GAEV;GAED,OACE,CAAC,UAAU,EAAE,cAAc,cAAc,EACvC,cAAc,IAAI,CAAC,iBAAiB;AAClC,WAAO,OAAO,iBAAiB,YAC7B,UAAU,gBACV,aAAa,cACb,QAAQ,aAAa,OACrB;GACH,EAAC,CAAC,KAAK,KAAK,CACd,QAAQ,EAAE,YAAY,KAAK,KAAK,CAAC,EAAE,CAAC,EACrC,MACA,IACD;AAED,UAAO;EACR;AAED,SAAO;CACR,EAAC;AACH;;;;;;;;;;;;AAaD,MAAM,6BAA6B,CACjC,eAAe,8BACf,qBAAqB,OAAO,WACzB;;CAEH,IAAI;AAEJ,QAAO,oBAAoB,KAAK,CAAC,EAC/B,KACA,MAAM,oBACP,KAAK;EACJ,MAAM,iBAAiB,mBAAmB,SAAS,IAAI;AAEvD,MAAI,gBAAgB;AAClB,OAAI,CAAC,mBAAmB;IACtB,OAAO,CAAC,CAAC,EAAE,cAAc,oBAAoB,EAAE,mBAAmB,qCAAqC,CAAC,EAAE,MAAM,MAAM,KAAK,KAAK;AAEhI,WAAO;GACR;GAED,IAAI,mBAAmB,mBAAmB,MAAM,GAAG,mBAAmB,QAAQ,IAAI,CAAC;AAEnF,OAAI,iBAAiB,SAAS,KAAK,EACjC,mBAAmB,iBAAiB,MAAM,GAAG,GAAG;AAGlD,OAAI,qBAAqB,mBAAmB;IAC1C,OACE,CAAC,CAAC,EAAE,cAAc,oBAAoB,EAAE,mBAAmB,oBAAoB,EAAE,iBAAiB,iDAAG,EACpD,kBAAkB,GAAG,CAAC,EACvE,MACA,MAAM,KAAK,KACZ;AAED,WAAO;GACR;EACF,OACC,oBAAoB;AAGtB,SAAO;CACR,EAAC;AACH;AAED,MAAM,eAAe;CACnB;CAA2B;CAAuB;CAAsB;CAExE;AACD;AAED,8BAAeA,6BAAa,CAAC,EAC3B,SACA,OACA,MACA,QACA,OACD,KAAK;CACJ,MAAM,EACJ,6BACA,oBAAoB,MACpB,oBAAoB,OACpB,oBAAoB,kEACpB,gCAAgC,OAChC,4BAA4B,OAC5B,cAAc,OACd,6BAA6B,OAC9B,GAAG,QAAQ,QAAQ,MAAM,CAAE;AAO5B,KAAI,CAAC,aAAa;;EAA+C,KAAM;EAAK,CAC1E;CAGF,MAAM,kBAAkB,MAAM,mBAAmB,kBAAkB;CAEnE,MAAM,0BAA0B,MAAM,iBAAiB,QAAQ;AAC/D,KAAI,CAAC,2BAA2B,CAAC,wBAAwB,OACvD;CAGF,MAAM,yBAAyB,MAAM,0BAA0B,2BAA2B;CAE1F,MAAM,gBAAuC,MAAM,oBAAoB,EACrE,SAAS,QACV,EAAC;CACF,MAAM,UAAU,uBACd,eACA,6BACA,mBACA,mBACA,iBACA,+BACA,2BACA,aACA,wBACA,OACA,OACA,OACD;AAED,KAAI,WAAW,CAAC,kBACd;CAGF,2BACE,eAAe,6BAA6B,yBAAyB,OAAO,OAC7E;AACF,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,6BAA6B,EAC3B,MAAM,UACP;IACD,mBAAmB,EACjB,MAAM,UACP;IACD,mBAAmB,EACjB,MAAM,UACP;IACD,mBAAmB,EACjB,MAAM,SACP;IACD,+BAA+B,EAC7B,MAAM,UACP;IACD,2BAA2B,EACzB,MAAM,UACP;IACD,aAAa,EACX,MAAM,UACP;IACD,4BAA4B,EAC1B,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/checkParamNames.js

@@ -0,0 +1,237 @@
+import iterateJsdoc from "../iterateJsdoc.js";
+
+//#region src/rules/checkParamNames.js
+/**
+* @param {string} targetTagName
+* @param {boolean} allowExtraTrailingParamDocs
+* @param {boolean} checkDestructured
+* @param {boolean} checkRestProperty
+* @param {RegExp} checkTypesRegex
+* @param {boolean} disableExtraPropertyReporting
+* @param {boolean} disableMissingParamChecks
+* @param {boolean} enableFixer
+* @param {import('../jsdocUtils.js').ParamNameInfo[]} functionParameterNames
+* @param {import('comment-parser').Block} jsdoc
+* @param {import('../iterateJsdoc.js').Utils} utils
+* @param {import('../iterateJsdoc.js').Report} report
+* @returns {boolean}
+*/
+const validateParameterNames = (targetTagName, allowExtraTrailingParamDocs, checkDestructured, checkRestProperty, checkTypesRegex, disableExtraPropertyReporting, disableMissingParamChecks, enableFixer, functionParameterNames, jsdoc, utils, report) => {
+	const paramTags = Object.entries(jsdoc.tags).filter(([, tag]) => {
+		return tag.tag === targetTagName;
+	});
+	const paramTagsNonNested = paramTags.filter(([, tag]) => {
+		return !tag.name.includes(".");
+	});
+	let dotted = 0;
+	let thisOffset = 0;
+	return paramTags.some(([, tag], index) => {
+		/** @type {import('../iterateJsdoc.js').Integer} */
+		let tagsIndex;
+		const dupeTagInfo = paramTags.find(([tgsIndex, tg], idx) => {
+			tagsIndex = Number(tgsIndex);
+			return tg.name === tag.name && idx !== index;
+		});
+		if (dupeTagInfo) {
+			utils.reportJSDoc(`Duplicate @${targetTagName} "${tag.name}"`, dupeTagInfo[1], enableFixer ? () => {
+				utils.removeTag(tagsIndex);
+			} : null);
+			return true;
+		}
+		if (tag.name.includes(".")) {
+			dotted++;
+			return false;
+		}
+		let functionParameterName = functionParameterNames[index - dotted + thisOffset];
+		if (functionParameterName === "this" && tag.name.trim() !== "this") {
+			++thisOffset;
+			functionParameterName = functionParameterNames[index - dotted + thisOffset];
+		}
+		if (!functionParameterName) {
+			if (allowExtraTrailingParamDocs) return false;
+			report(`@${targetTagName} "${tag.name}" does not match an existing function parameter.`, null, tag);
+			return true;
+		}
+		if (typeof functionParameterName === "object" && "name" in functionParameterName && Array.isArray(functionParameterName.name)) {
+			const actualName = tag.name.trim();
+			const expectedName = functionParameterName.name[index];
+			if (actualName === expectedName) {
+				thisOffset--;
+				return false;
+			}
+			report(`Expected @${targetTagName} name to be "${expectedName}". Got "${actualName}".`, null, tag);
+			return true;
+		}
+		if (Array.isArray(functionParameterName)) {
+			if (!checkDestructured) return false;
+			if (tag.type && tag.type.search(checkTypesRegex) === -1) return false;
+			const [parameterName, { annotationParamName, hasPropertyRest, names: properties, rests }] = functionParameterName;
+			if (annotationParamName !== void 0) {
+				const name = tag.name.trim();
+				if (name !== annotationParamName) report(`@${targetTagName} "${name}" does not match parameter name "${annotationParamName}"`, null, tag);
+			}
+			const tagName = parameterName === void 0 ? tag.name.trim() : parameterName;
+			const expectedNames = properties.map((name) => {
+				return `${tagName}.${name}`;
+			});
+			const actualNames = paramTags.map(([, paramTag]) => {
+				return paramTag.name.trim();
+			});
+			const actualTypes = paramTags.map(([, paramTag]) => {
+				return paramTag.type;
+			});
+			const missingProperties = [];
+			/** @type {string[]} */
+			const notCheckingNames = [];
+			for (const [idx, name] of expectedNames.entries()) {
+				if (notCheckingNames.some((notCheckingName) => {
+					return name.startsWith(notCheckingName);
+				})) continue;
+				const actualNameIdx = actualNames.findIndex((actualName) => {
+					return utils.comparePaths(name)(actualName);
+				});
+				if (actualNameIdx === -1) {
+					if (!checkRestProperty && rests[idx]) continue;
+					const missingIndex = actualNames.findIndex((actualName) => {
+						return utils.pathDoesNotBeginWith(name, actualName);
+					});
+					const line = tag.source[0].number - 1 + (missingIndex > -1 ? missingIndex : actualNames.length);
+					missingProperties.push({
+						name,
+						tagPlacement: { line: line === 0 ? 1 : line }
+					});
+				} else if (actualTypes[actualNameIdx].search(checkTypesRegex) === -1 && actualTypes[actualNameIdx] !== "") notCheckingNames.push(name);
+			}
+			const hasMissing = missingProperties.length;
+			if (hasMissing) for (const { name: missingProperty, tagPlacement } of missingProperties) report(`Missing @${targetTagName} "${missingProperty}"`, null, tagPlacement);
+			if (!hasPropertyRest || checkRestProperty) {
+				/** @type {[string, import('comment-parser').Spec][]} */
+				const extraProperties = [];
+				for (const [idx, name] of actualNames.entries()) {
+					const match = name.startsWith(tag.name.trim() + ".");
+					if (match && !expectedNames.some(utils.comparePaths(name)) && !utils.comparePaths(name)(tag.name) && (!disableExtraPropertyReporting || properties.some((prop) => {
+						return prop.split(".").length >= name.split(".").length - 1;
+					}))) extraProperties.push([name, paramTags[idx][1]]);
+				}
+				if (extraProperties.length) {
+					for (const [extraProperty, tg] of extraProperties) report(`@${targetTagName} "${extraProperty}" does not exist on ${tag.name}`, null, tg);
+					return true;
+				}
+			}
+			return hasMissing;
+		}
+		let funcParamName;
+		if (typeof functionParameterName === "object") {
+			const { name } = functionParameterName;
+			funcParamName = name;
+		} else funcParamName = functionParameterName;
+		if (funcParamName !== tag.name.trim()) {
+			const actualNames = paramTagsNonNested.map(([, { name }]) => {
+				return name.trim();
+			});
+			const expectedNames = functionParameterNames.map((item, idx) => {
+				if (item?.[1]?.names) return actualNames[idx];
+				return item;
+			}).filter((item) => {
+				return item !== "this";
+			});
+			if (disableMissingParamChecks) {
+				const usedExpectedNames = expectedNames.map((a) => {
+					return a?.toString();
+				}).filter((expectedName) => {
+					return expectedName && actualNames.includes(expectedName);
+				});
+				const usedInOrder = actualNames.every((actualName, idx) => {
+					return actualName === usedExpectedNames[idx];
+				});
+				if (usedInOrder) return false;
+			}
+			report(`Expected @${targetTagName} names to be "${expectedNames.map((expectedName) => {
+				return typeof expectedName === "object" && "name" in expectedName && expectedName.restElement ? "..." + expectedName.name : expectedName;
+			}).join(", ")}". Got "${actualNames.join(", ")}".`, null, tag);
+			return true;
+		}
+		return false;
+	});
+};
+/**
+* @param {string} targetTagName
+* @param {boolean} _allowExtraTrailingParamDocs
+* @param {{
+*   name: string,
+*   idx: import('../iterateJsdoc.js').Integer
+* }[]} jsdocParameterNames
+* @param {import('comment-parser').Block} jsdoc
+* @param {Function} report
+* @returns {boolean}
+*/
+const validateParameterNamesDeep = (targetTagName, _allowExtraTrailingParamDocs, jsdocParameterNames, jsdoc, report) => {
+	/** @type {string} */
+	let lastRealParameter;
+	return jsdocParameterNames.some(({ idx, name: jsdocParameterName }) => {
+		const isPropertyPath = jsdocParameterName.includes(".");
+		if (isPropertyPath) {
+			if (!lastRealParameter) {
+				report(`@${targetTagName} path declaration ("${jsdocParameterName}") appears before any real parameter.`, null, jsdoc.tags[idx]);
+				return true;
+			}
+			let pathRootNodeName = jsdocParameterName.slice(0, jsdocParameterName.indexOf("."));
+			if (pathRootNodeName.endsWith("[]")) pathRootNodeName = pathRootNodeName.slice(0, -2);
+			if (pathRootNodeName !== lastRealParameter) {
+				report(`@${targetTagName} path declaration ("${jsdocParameterName}") root node name ("${pathRootNodeName}") does not match previous real parameter name ("${lastRealParameter}").`, null, jsdoc.tags[idx]);
+				return true;
+			}
+		} else lastRealParameter = jsdocParameterName;
+		return false;
+	});
+};
+const allowedNodes = [
+	"ArrowFunctionExpression",
+	"FunctionDeclaration",
+	"FunctionExpression",
+	"TSDeclareFunction",
+	"TSMethodSignature"
+];
+var checkParamNames_default = iterateJsdoc(({ context, jsdoc, node, report, utils }) => {
+	const { allowExtraTrailingParamDocs, checkDestructured = true, checkRestProperty = false, checkTypesPattern = "/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/", disableExtraPropertyReporting = false, disableMissingParamChecks = false, enableFixer = false, useDefaultObjectProperties = false } = context.options[0] || {};
+	if (!allowedNodes.includes(
+		/** @type {import('estree').Node} */
+		node.type
+	)) return;
+	const checkTypesRegex = utils.getRegexFromString(checkTypesPattern);
+	const jsdocParameterNamesDeep = utils.getJsdocTagsDeep("param");
+	if (!jsdocParameterNamesDeep || !jsdocParameterNamesDeep.length) return;
+	const functionParameterNames = utils.getFunctionParameterNames(useDefaultObjectProperties);
+	const targetTagName = utils.getPreferredTagName({ tagName: "param" });
+	const isError = validateParameterNames(targetTagName, allowExtraTrailingParamDocs, checkDestructured, checkRestProperty, checkTypesRegex, disableExtraPropertyReporting, disableMissingParamChecks, enableFixer, functionParameterNames, jsdoc, utils, report);
+	if (isError || !checkDestructured) return;
+	validateParameterNamesDeep(targetTagName, allowExtraTrailingParamDocs, jsdocParameterNamesDeep, jsdoc, report);
+}, {
+	contextDefaults: allowedNodes,
+	meta: {
+		docs: {
+			description: "Ensures that parameter names in JSDoc match those in the function declaration.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-param-names.md#repos-sticky-header"
+		},
+		fixable: "code",
+		schema: [{
+			additionalProperties: false,
+			properties: {
+				allowExtraTrailingParamDocs: { type: "boolean" },
+				checkDestructured: { type: "boolean" },
+				checkRestProperty: { type: "boolean" },
+				checkTypesPattern: { type: "string" },
+				disableExtraPropertyReporting: { type: "boolean" },
+				disableMissingParamChecks: { type: "boolean" },
+				enableFixer: { type: "boolean" },
+				useDefaultObjectProperties: { type: "boolean" }
+			},
+			type: "object"
+		}],
+		type: "suggestion"
+	}
+});
+
+//#endregion
+export { checkParamNames_default as default };
+//# sourceMappingURL=checkParamNames.js.map

package/dist/rules/checkParamNames.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkParamNames.js","names":[],"sources":["../../src/rules/checkParamNames.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {string} targetTagName\n * @param {boolean} allowExtraTrailingParamDocs\n * @param {boolean} checkDestructured\n * @param {boolean} checkRestProperty\n * @param {RegExp} checkTypesRegex\n * @param {boolean} disableExtraPropertyReporting\n * @param {boolean} disableMissingParamChecks\n * @param {boolean} enableFixer\n * @param {import('../jsdocUtils.js').ParamNameInfo[]} functionParameterNames\n * @param {import('comment-parser').Block} jsdoc\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {import('../iterateJsdoc.js').Report} report\n * @returns {boolean}\n */\nconst validateParameterNames = (\n  targetTagName,\n  allowExtraTrailingParamDocs,\n  checkDestructured,\n  checkRestProperty,\n  checkTypesRegex,\n  disableExtraPropertyReporting,\n  disableMissingParamChecks,\n  enableFixer,\n  functionParameterNames, jsdoc, utils, report,\n) => {\n  const paramTags = Object.entries(jsdoc.tags).filter(([\n    , tag,\n  ]) => {\n    return tag.tag === targetTagName;\n  });\n  const paramTagsNonNested = paramTags.filter(([\n    , tag,\n  ]) => {\n    return !tag.name.includes('.');\n  });\n\n  let dotted = 0;\n  let thisOffset = 0;\n\n  // eslint-disable-next-line complexity\n  return paramTags.some(([\n    , tag,\n  ], index) => {\n    /** @type {import('../iterateJsdoc.js').Integer} */\n    let tagsIndex;\n    const dupeTagInfo = paramTags.find(([\n      tgsIndex,\n      tg,\n    ], idx) => {\n      tagsIndex = Number(tgsIndex);\n\n      return tg.name === tag.name && idx !== index;\n    });\n    if (dupeTagInfo) {\n      utils.reportJSDoc(`Duplicate @${targetTagName} \"${tag.name}\"`, dupeTagInfo[1], enableFixer ? () => {\n        utils.removeTag(tagsIndex);\n      } : null);\n\n      return true;\n    }\n\n    if (tag.name.includes('.')) {\n      dotted++;\n\n      return false;\n    }\n\n    let functionParameterName = functionParameterNames[index - dotted + thisOffset];\n    if (functionParameterName === 'this' && tag.name.trim() !== 'this') {\n      ++thisOffset;\n      functionParameterName = functionParameterNames[index - dotted + thisOffset];\n    }\n\n    if (!functionParameterName) {\n      if (allowExtraTrailingParamDocs) {\n        return false;\n      }\n\n      report(\n        `@${targetTagName} \"${tag.name}\" does not match an existing function parameter.`,\n        null,\n        tag,\n      );\n\n      return true;\n    }\n\n    if (\n      typeof functionParameterName === 'object' &&\n        'name' in functionParameterName &&\n        Array.isArray(functionParameterName.name)\n    ) {\n      const actualName = tag.name.trim();\n      const expectedName = functionParameterName.name[index];\n      if (actualName === expectedName) {\n        thisOffset--;\n        return false;\n      }\n\n      report(\n        `Expected @${targetTagName} name to be \"${expectedName}\". Got \"${actualName}\".`,\n        null,\n        tag,\n      );\n      return true;\n    }\n\n    if (Array.isArray(functionParameterName)) {\n      if (!checkDestructured) {\n        return false;\n      }\n\n      if (tag.type && tag.type.search(checkTypesRegex) === -1) {\n        return false;\n      }\n\n      const [\n        parameterName,\n        {\n          annotationParamName,\n          hasPropertyRest,\n          names: properties,\n          rests,\n        },\n      ] =\n        /**\n         * @type {[string | undefined, import('../jsdocUtils.js').FlattendRootInfo & {\n         *   annotationParamName?: string | undefined;\n          }]} */ (functionParameterName);\n      if (annotationParamName !== undefined) {\n        const name = tag.name.trim();\n        if (name !== annotationParamName) {\n          report(`@${targetTagName} \"${name}\" does not match parameter name \"${annotationParamName}\"`, null, tag);\n        }\n      }\n\n      const tagName = parameterName === undefined ? tag.name.trim() : parameterName;\n      const expectedNames = properties.map((name) => {\n        return `${tagName}.${name}`;\n      });\n      const actualNames = paramTags.map(([\n        , paramTag,\n      ]) => {\n        return paramTag.name.trim();\n      });\n      const actualTypes = paramTags.map(([\n        , paramTag,\n      ]) => {\n        return paramTag.type;\n      });\n\n      const missingProperties = [];\n\n      /** @type {string[]} */\n      const notCheckingNames = [];\n\n      for (const [\n        idx,\n        name,\n      ] of expectedNames.entries()) {\n        if (notCheckingNames.some((notCheckingName) => {\n          return name.startsWith(notCheckingName);\n        })) {\n          continue;\n        }\n\n        const actualNameIdx = actualNames.findIndex((actualName) => {\n          return utils.comparePaths(name)(actualName);\n        });\n        if (actualNameIdx === -1) {\n          if (!checkRestProperty && rests[idx]) {\n            continue;\n          }\n\n          const missingIndex = actualNames.findIndex((actualName) => {\n            return utils.pathDoesNotBeginWith(name, actualName);\n          });\n          const line = tag.source[0].number - 1 + (missingIndex > -1 ? missingIndex : actualNames.length);\n          missingProperties.push({\n            name,\n            tagPlacement: {\n              line: line === 0 ? 1 : line,\n            },\n          });\n        } else if (actualTypes[actualNameIdx].search(checkTypesRegex) === -1 && actualTypes[actualNameIdx] !== '') {\n          notCheckingNames.push(name);\n        }\n      }\n\n      const hasMissing = missingProperties.length;\n      if (hasMissing) {\n        for (const {\n          name: missingProperty,\n          tagPlacement,\n        } of missingProperties) {\n          report(`Missing @${targetTagName} \"${missingProperty}\"`, null, tagPlacement);\n        }\n      }\n\n      if (!hasPropertyRest || checkRestProperty) {\n        /** @type {[string, import('comment-parser').Spec][]} */\n        const extraProperties = [];\n        for (const [\n          idx,\n          name,\n        ] of actualNames.entries()) {\n          const match = name.startsWith(tag.name.trim() + '.');\n          if (\n            match && !expectedNames.some(\n              utils.comparePaths(name),\n            ) && !utils.comparePaths(name)(tag.name) &&\n            (!disableExtraPropertyReporting || properties.some((prop) => {\n              return prop.split('.').length >= name.split('.').length - 1;\n            }))\n          ) {\n            extraProperties.push([\n              name, paramTags[idx][1],\n            ]);\n          }\n        }\n\n        if (extraProperties.length) {\n          for (const [\n            extraProperty,\n            tg,\n          ] of extraProperties) {\n            report(`@${targetTagName} \"${extraProperty}\" does not exist on ${tag.name}`, null, tg);\n          }\n\n          return true;\n        }\n      }\n\n      return hasMissing;\n    }\n\n    let funcParamName;\n    if (typeof functionParameterName === 'object') {\n      const {\n        name,\n      } = functionParameterName;\n      funcParamName = name;\n    } else {\n      funcParamName = functionParameterName;\n    }\n\n    if (funcParamName !== tag.name.trim()) {\n      // Todo: Improve for array or object child items\n      const actualNames = paramTagsNonNested.map(([\n        , {\n          name,\n        },\n      ]) => {\n        return name.trim();\n      });\n\n      const expectedNames = functionParameterNames.map((item, idx) => {\n        if (/**\n             * @type {[string|undefined, (import('../jsdocUtils.js').FlattendRootInfo & {\n             *   annotationParamName?: string,\n              })]} */ (item)?.[1]?.names) {\n          return actualNames[idx];\n        }\n\n        return item;\n      }).filter((item) => {\n        return item !== 'this';\n      });\n\n      // When disableMissingParamChecks is true tag names can be omitted.\n      // Report when the tag names do not match the expected names or they are used out of order.\n      if (disableMissingParamChecks) {\n        const usedExpectedNames = expectedNames.map((a) => {\n          return a?.toString();\n        }).filter((expectedName) => {\n          return expectedName && actualNames.includes(expectedName);\n        });\n        const usedInOrder = actualNames.every((actualName, idx) => {\n          return actualName === usedExpectedNames[idx];\n        });\n        if (usedInOrder) {\n          return false;\n        }\n      }\n\n      report(\n        `Expected @${targetTagName} names to be \"${\n          expectedNames.map((expectedName) => {\n            return typeof expectedName === 'object' &&\n              'name' in expectedName &&\n              expectedName.restElement ?\n              '...' + expectedName.name :\n              expectedName;\n          }).join(', ')\n        }\". Got \"${actualNames.join(', ')}\".`,\n        null,\n        tag,\n      );\n\n      return true;\n    }\n\n    return false;\n  });\n};\n\n/**\n * @param {string} targetTagName\n * @param {boolean} _allowExtraTrailingParamDocs\n * @param {{\n *   name: string,\n *   idx: import('../iterateJsdoc.js').Integer\n * }[]} jsdocParameterNames\n * @param {import('comment-parser').Block} jsdoc\n * @param {Function} report\n * @returns {boolean}\n */\nconst validateParameterNamesDeep = (\n  targetTagName, _allowExtraTrailingParamDocs,\n  jsdocParameterNames, jsdoc, report,\n) => {\n  /** @type {string} */\n  let lastRealParameter;\n\n  return jsdocParameterNames.some(({\n    idx,\n    name: jsdocParameterName,\n  }) => {\n    const isPropertyPath = jsdocParameterName.includes('.');\n\n    if (isPropertyPath) {\n      if (!lastRealParameter) {\n        report(`@${targetTagName} path declaration (\"${jsdocParameterName}\") appears before any real parameter.`, null, jsdoc.tags[idx]);\n\n        return true;\n      }\n\n      let pathRootNodeName = jsdocParameterName.slice(0, jsdocParameterName.indexOf('.'));\n\n      if (pathRootNodeName.endsWith('[]')) {\n        pathRootNodeName = pathRootNodeName.slice(0, -2);\n      }\n\n      if (pathRootNodeName !== lastRealParameter) {\n        report(\n          `@${targetTagName} path declaration (\"${jsdocParameterName}\") root node name (\"${pathRootNodeName}\") ` +\n          `does not match previous real parameter name (\"${lastRealParameter}\").`,\n          null,\n          jsdoc.tags[idx],\n        );\n\n        return true;\n      }\n    } else {\n      lastRealParameter = jsdocParameterName;\n    }\n\n    return false;\n  });\n};\n\nconst allowedNodes = [\n  'ArrowFunctionExpression', 'FunctionDeclaration', 'FunctionExpression', 'TSDeclareFunction',\n  // Add this to above defaults\n  'TSMethodSignature',\n];\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  node,\n  report,\n  utils,\n}) => {\n  const {\n    allowExtraTrailingParamDocs,\n    checkDestructured = true,\n    checkRestProperty = false,\n    checkTypesPattern = '/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/',\n    disableExtraPropertyReporting = false,\n    disableMissingParamChecks = false,\n    enableFixer = false,\n    useDefaultObjectProperties = false,\n  } = context.options[0] || {};\n\n  // Although we might just remove global settings contexts from applying to\n  //   this rule (as they can cause problems with `getFunctionParameterNames`\n  //   checks if they are not functions but say variables), the user may\n  //   instead wish to narrow contexts in those settings, so this check\n  //   is still useful\n  if (!allowedNodes.includes(/** @type {import('estree').Node} */ (node).type)) {\n    return;\n  }\n\n  const checkTypesRegex = utils.getRegexFromString(checkTypesPattern);\n\n  const jsdocParameterNamesDeep = utils.getJsdocTagsDeep('param');\n  if (!jsdocParameterNamesDeep || !jsdocParameterNamesDeep.length) {\n    return;\n  }\n\n  const functionParameterNames = utils.getFunctionParameterNames(useDefaultObjectProperties);\n\n  const targetTagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'param',\n  }));\n  const isError = validateParameterNames(\n    targetTagName,\n    allowExtraTrailingParamDocs,\n    checkDestructured,\n    checkRestProperty,\n    checkTypesRegex,\n    disableExtraPropertyReporting,\n    disableMissingParamChecks,\n    enableFixer,\n    functionParameterNames,\n    jsdoc,\n    utils,\n    report,\n  );\n\n  if (isError || !checkDestructured) {\n    return;\n  }\n\n  validateParameterNamesDeep(\n    targetTagName, allowExtraTrailingParamDocs, jsdocParameterNamesDeep, jsdoc, report,\n  );\n}, {\n  contextDefaults: allowedNodes,\n  meta: {\n    docs: {\n      description: 'Ensures that parameter names in JSDoc match those in the function declaration.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-param-names.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          allowExtraTrailingParamDocs: {\n            type: 'boolean',\n          },\n          checkDestructured: {\n            type: 'boolean',\n          },\n          checkRestProperty: {\n            type: 'boolean',\n          },\n          checkTypesPattern: {\n            type: 'string',\n          },\n          disableExtraPropertyReporting: {\n            type: 'boolean',\n          },\n          disableMissingParamChecks: {\n            type: 'boolean',\n          },\n          enableFixer: {\n            type: 'boolean',\n          },\n          useDefaultObjectProperties: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;AAiBA,MAAM,yBAAyB,CAC7B,eACA,6BACA,mBACA,mBACA,iBACA,+BACA,2BACA,aACA,wBAAwB,OAAO,OAAO,WACnC;CACH,MAAM,YAAY,OAAO,QAAQ,MAAM,KAAK,CAAC,OAAO,CAAC,GACjD,IACH,KAAK;AACJ,SAAO,IAAI,QAAQ;CACpB,EAAC;CACF,MAAM,qBAAqB,UAAU,OAAO,CAAC,GACzC,IACH,KAAK;AACJ,SAAO,CAAC,IAAI,KAAK,SAAS,IAAI;CAC/B,EAAC;CAEF,IAAI,SAAS;CACb,IAAI,aAAa;AAGjB,QAAO,UAAU,KAAK,CAAC,GACnB,IACH,EAAE,UAAU;;EAEX,IAAI;EACJ,MAAM,cAAc,UAAU,KAAK,CAAC,CAClC,UACA,GACD,EAAE,QAAQ;GACT,YAAY,OAAO,SAAS;AAE5B,UAAO,GAAG,SAAS,IAAI,QAAQ,QAAQ;EACxC,EAAC;AACF,MAAI,aAAa;GACf,MAAM,YAAY,CAAC,WAAW,EAAE,cAAc,EAAE,EAAE,IAAI,KAAK,CAAC,CAAC,EAAE,YAAY,IAAI,cAAc,MAAM;IACjG,MAAM,UAAU,UAAU;GAC3B,IAAG,KAAK;AAET,UAAO;EACR;AAED,MAAI,IAAI,KAAK,SAAS,IAAI,EAAE;GAC1B;AAEA,UAAO;EACR;EAED,IAAI,wBAAwB,uBAAuB,QAAQ,SAAS;AACpE,MAAI,0BAA0B,UAAU,IAAI,KAAK,MAAM,KAAK,QAAQ;GAClE,EAAE;GACF,wBAAwB,uBAAuB,QAAQ,SAAS;EACjE;AAED,MAAI,CAAC,uBAAuB;AAC1B,OAAI,4BACF,QAAO;GAGT,OACE,CAAC,CAAC,EAAE,cAAc,EAAE,EAAE,IAAI,KAAK,gDAAgD,CAAC,EAChF,MACA,IACD;AAED,UAAO;EACR;AAED,MACE,OAAO,0BAA0B,YAC/B,UAAU,yBACV,MAAM,QAAQ,sBAAsB,KAAK,EAC3C;GACA,MAAM,aAAa,IAAI,KAAK,MAAM;GAClC,MAAM,eAAe,sBAAsB,KAAK;AAChD,OAAI,eAAe,cAAc;IAC/B;AACA,WAAO;GACR;GAED,OACE,CAAC,UAAU,EAAE,cAAc,aAAa,EAAE,aAAa,QAAQ,EAAE,WAAW,EAAE,CAAC,EAC/E,MACA,IACD;AACD,UAAO;EACR;AAED,MAAI,MAAM,QAAQ,sBAAsB,EAAE;AACxC,OAAI,CAAC,kBACH,QAAO;AAGT,OAAI,IAAI,QAAQ,IAAI,KAAK,OAAO,gBAAgB,KAAK,GACnD,QAAO;GAGT,MAAM,CACJ,eACA,EACE,qBACA,iBACA,OAAO,YACP,OACD,CACF,GAIW;AACZ,OAAI,wBAAwB,QAAW;IACrC,MAAM,OAAO,IAAI,KAAK,MAAM;AAC5B,QAAI,SAAS,qBACX,OAAO,CAAC,CAAC,EAAE,cAAc,EAAE,EAAE,KAAK,iCAAiC,EAAE,oBAAoB,CAAC,CAAC,EAAE,MAAM,IAAI;GAE1G;GAED,MAAM,UAAU,kBAAkB,SAAY,IAAI,KAAK,MAAM,GAAG;GAChE,MAAM,gBAAgB,WAAW,IAAI,CAAC,SAAS;AAC7C,WAAO,GAAG,QAAQ,CAAC,EAAE,MAAM;GAC5B,EAAC;GACF,MAAM,cAAc,UAAU,IAAI,CAAC,GAC/B,SACH,KAAK;AACJ,WAAO,SAAS,KAAK,MAAM;GAC5B,EAAC;GACF,MAAM,cAAc,UAAU,IAAI,CAAC,GAC/B,SACH,KAAK;AACJ,WAAO,SAAS;GACjB,EAAC;GAEF,MAAM,oBAAoB,CAAE;;GAG5B,MAAM,mBAAmB,CAAE;AAE3B,QAAK,MAAM,CACT,KACA,KACD,IAAI,cAAc,SAAS,EAAE;AAC5B,QAAI,iBAAiB,KAAK,CAAC,oBAAoB;AAC7C,YAAO,KAAK,WAAW,gBAAgB;IACxC,EAAC,CACA;IAGF,MAAM,gBAAgB,YAAY,UAAU,CAAC,eAAe;AAC1D,YAAO,MAAM,aAAa,KAAK,CAAC,WAAW;IAC5C,EAAC;AACF,QAAI,kBAAkB,IAAI;AACxB,SAAI,CAAC,qBAAqB,MAAM,KAC9B;KAGF,MAAM,eAAe,YAAY,UAAU,CAAC,eAAe;AACzD,aAAO,MAAM,qBAAqB,MAAM,WAAW;KACpD,EAAC;KACF,MAAM,OAAO,IAAI,OAAO,GAAG,SAAS,KAAK,eAAe,KAAK,eAAe,YAAY;KACxF,kBAAkB,KAAK;MACrB;MACA,cAAc,EACZ,MAAM,SAAS,IAAI,IAAI,KACxB;KACF,EAAC;IACH,WAAU,YAAY,eAAe,OAAO,gBAAgB,KAAK,MAAM,YAAY,mBAAmB,IACrG,iBAAiB,KAAK,KAAK;GAE9B;GAED,MAAM,aAAa,kBAAkB;AACrC,OAAI,WACF,MAAK,MAAM,EACT,MAAM,iBACN,cACD,IAAI,mBACH,OAAO,CAAC,SAAS,EAAE,cAAc,EAAE,EAAE,gBAAgB,CAAC,CAAC,EAAE,MAAM,aAAa;AAIhF,OAAI,CAAC,mBAAmB,mBAAmB;;IAEzC,MAAM,kBAAkB,CAAE;AAC1B,SAAK,MAAM,CACT,KACA,KACD,IAAI,YAAY,SAAS,EAAE;KAC1B,MAAM,QAAQ,KAAK,WAAW,IAAI,KAAK,MAAM,GAAG,IAAI;AACpD,SACE,SAAS,CAAC,cAAc,KACtB,MAAM,aAAa,KAAK,CACzB,IAAI,CAAC,MAAM,aAAa,KAAK,CAAC,IAAI,KAAK,KACvC,CAAC,iCAAiC,WAAW,KAAK,CAAC,SAAS;AAC3D,aAAO,KAAK,MAAM,IAAI,CAAC,UAAU,KAAK,MAAM,IAAI,CAAC,SAAS;KAC3D,EAAC,GAEF,gBAAgB,KAAK,CACnB,MAAM,UAAU,KAAK,EACtB,EAAC;IAEL;AAED,QAAI,gBAAgB,QAAQ;AAC1B,UAAK,MAAM,CACT,eACA,GACD,IAAI,iBACH,OAAO,CAAC,CAAC,EAAE,cAAc,EAAE,EAAE,cAAc,oBAAoB,EAAE,IAAI,MAAM,EAAE,MAAM,GAAG;AAGxF,YAAO;IACR;GACF;AAED,UAAO;EACR;EAED,IAAI;AACJ,MAAI,OAAO,0BAA0B,UAAU;GAC7C,MAAM,EACJ,MACD,GAAG;GACJ,gBAAgB;EACjB,OACC,gBAAgB;AAGlB,MAAI,kBAAkB,IAAI,KAAK,MAAM,EAAE;GAErC,MAAM,cAAc,mBAAmB,IAAI,CAAC,GACxC,EACA,MACD,CACF,KAAK;AACJ,WAAO,KAAK,MAAM;GACnB,EAAC;GAEF,MAAM,gBAAgB,uBAAuB,IAAI,CAAC,MAAM,QAAQ;AAC9D,QAGe,OAAQ,IAAI,MACzB,QAAO,YAAY;AAGrB,WAAO;GACR,EAAC,CAAC,OAAO,CAAC,SAAS;AAClB,WAAO,SAAS;GACjB,EAAC;AAIF,OAAI,2BAA2B;IAC7B,MAAM,oBAAoB,cAAc,IAAI,CAAC,MAAM;AACjD,YAAO,GAAG,UAAU;IACrB,EAAC,CAAC,OAAO,CAAC,iBAAiB;AAC1B,YAAO,gBAAgB,YAAY,SAAS,aAAa;IAC1D,EAAC;IACF,MAAM,cAAc,YAAY,MAAM,CAAC,YAAY,QAAQ;AACzD,YAAO,eAAe,kBAAkB;IACzC,EAAC;AACF,QAAI,YACF,QAAO;GAEV;GAED,OACE,CAAC,UAAU,EAAE,cAAc,cAAc,EACvC,cAAc,IAAI,CAAC,iBAAiB;AAClC,WAAO,OAAO,iBAAiB,YAC7B,UAAU,gBACV,aAAa,cACb,QAAQ,aAAa,OACrB;GACH,EAAC,CAAC,KAAK,KAAK,CACd,QAAQ,EAAE,YAAY,KAAK,KAAK,CAAC,EAAE,CAAC,EACrC,MACA,IACD;AAED,UAAO;EACR;AAED,SAAO;CACR,EAAC;AACH;;;;;;;;;;;;AAaD,MAAM,6BAA6B,CACjC,eAAe,8BACf,qBAAqB,OAAO,WACzB;;CAEH,IAAI;AAEJ,QAAO,oBAAoB,KAAK,CAAC,EAC/B,KACA,MAAM,oBACP,KAAK;EACJ,MAAM,iBAAiB,mBAAmB,SAAS,IAAI;AAEvD,MAAI,gBAAgB;AAClB,OAAI,CAAC,mBAAmB;IACtB,OAAO,CAAC,CAAC,EAAE,cAAc,oBAAoB,EAAE,mBAAmB,qCAAqC,CAAC,EAAE,MAAM,MAAM,KAAK,KAAK;AAEhI,WAAO;GACR;GAED,IAAI,mBAAmB,mBAAmB,MAAM,GAAG,mBAAmB,QAAQ,IAAI,CAAC;AAEnF,OAAI,iBAAiB,SAAS,KAAK,EACjC,mBAAmB,iBAAiB,MAAM,GAAG,GAAG;AAGlD,OAAI,qBAAqB,mBAAmB;IAC1C,OACE,CAAC,CAAC,EAAE,cAAc,oBAAoB,EAAE,mBAAmB,oBAAoB,EAAE,iBAAiB,iDAAG,EACpD,kBAAkB,GAAG,CAAC,EACvE,MACA,MAAM,KAAK,KACZ;AAED,WAAO;GACR;EACF,OACC,oBAAoB;AAGtB,SAAO;CACR,EAAC;AACH;AAED,MAAM,eAAe;CACnB;CAA2B;CAAuB;CAAsB;CAExE;AACD;AAED,8BAAe,aAAa,CAAC,EAC3B,SACA,OACA,MACA,QACA,OACD,KAAK;CACJ,MAAM,EACJ,6BACA,oBAAoB,MACpB,oBAAoB,OACpB,oBAAoB,kEACpB,gCAAgC,OAChC,4BAA4B,OAC5B,cAAc,OACd,6BAA6B,OAC9B,GAAG,QAAQ,QAAQ,MAAM,CAAE;AAO5B,KAAI,CAAC,aAAa;;EAA+C,KAAM;EAAK,CAC1E;CAGF,MAAM,kBAAkB,MAAM,mBAAmB,kBAAkB;CAEnE,MAAM,0BAA0B,MAAM,iBAAiB,QAAQ;AAC/D,KAAI,CAAC,2BAA2B,CAAC,wBAAwB,OACvD;CAGF,MAAM,yBAAyB,MAAM,0BAA0B,2BAA2B;CAE1F,MAAM,gBAAuC,MAAM,oBAAoB,EACrE,SAAS,QACV,EAAC;CACF,MAAM,UAAU,uBACd,eACA,6BACA,mBACA,mBACA,iBACA,+BACA,2BACA,aACA,wBACA,OACA,OACA,OACD;AAED,KAAI,WAAW,CAAC,kBACd;CAGF,2BACE,eAAe,6BAA6B,yBAAyB,OAAO,OAC7E;AACF,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,6BAA6B,EAC3B,MAAM,UACP;IACD,mBAAmB,EACjB,MAAM,UACP;IACD,mBAAmB,EACjB,MAAM,UACP;IACD,mBAAmB,EACjB,MAAM,SACP;IACD,+BAA+B,EAC7B,MAAM,UACP;IACD,2BAA2B,EACzB,MAAM,UACP;IACD,aAAa,EACX,MAAM,UACP;IACD,4BAA4B,EAC1B,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/checkPropertyNames.cjs

@@ -1,116 +1,88 @@
-"use strict";
+const require_iterateJsdoc = require('../iterateJsdoc.cjs');
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+//#region src/rules/checkPropertyNames.js
 /**
- * @param {string} targetTagName
- * @param {boolean} enableFixer
- * @param {import('comment-parser').Block} jsdoc
- * @param {import('../iterateJsdoc.js').Utils} utils
- * @returns {boolean}
- */
+* @param {string} targetTagName
+* @param {boolean} enableFixer
+* @param {import('comment-parser').Block} jsdoc
+* @param {import('../iterateJsdoc.js').Utils} utils
+* @returns {boolean}
+*/
 const validatePropertyNames = (targetTagName, enableFixer, jsdoc, utils) => {
-  const propertyTags = Object.entries(jsdoc.tags).filter(([, tag]) => {
-    return tag.tag === targetTagName;
-  });
-  return propertyTags.some(([, tag], index) => {
-    /** @type {import('../iterateJsdoc.js').Integer} */
-    let tagsIndex;
-    const dupeTagInfo = propertyTags.find(([tgsIndex, tg], idx) => {
-      tagsIndex = Number(tgsIndex);
-      return tg.name === tag.name && idx !== index;
-    });
-    if (dupeTagInfo) {
-      utils.reportJSDoc(`Duplicate @${targetTagName} "${tag.name}"`, dupeTagInfo[1], enableFixer ? () => {
-        utils.removeTag(tagsIndex);
-      } : null);
-      return true;
-    }
-    return false;
-  });
+	const propertyTags = Object.entries(jsdoc.tags).filter(([, tag]) => {
+		return tag.tag === targetTagName;
+	});
+	return propertyTags.some(([, tag], index) => {
+		/** @type {import('../iterateJsdoc.js').Integer} */
+		let tagsIndex;
+		const dupeTagInfo = propertyTags.find(([tgsIndex, tg], idx) => {
+			tagsIndex = Number(tgsIndex);
+			return tg.name === tag.name && idx !== index;
+		});
+		if (dupeTagInfo) {
+			utils.reportJSDoc(`Duplicate @${targetTagName} "${tag.name}"`, dupeTagInfo[1], enableFixer ? () => {
+				utils.removeTag(tagsIndex);
+			} : null);
+			return true;
+		}
+		return false;
+	});
 };
-
 /**
- * @param {string} targetTagName
- * @param {{
- *   idx: number;
- *   name: string;
- *   type: string;
- * }[]} jsdocPropertyNames
- * @param {import('comment-parser').Block} jsdoc
- * @param {Function} report
- */
+* @param {string} targetTagName
+* @param {{
+*   idx: number;
+*   name: string;
+*   type: string;
+* }[]} jsdocPropertyNames
+* @param {import('comment-parser').Block} jsdoc
+* @param {Function} report
+*/
 const validatePropertyNamesDeep = (targetTagName, jsdocPropertyNames, jsdoc, report) => {
-  /** @type {string} */
-  let lastRealProperty;
-  return jsdocPropertyNames.some(({
-    idx,
-    name: jsdocPropertyName
-  }) => {
-    const isPropertyPath = jsdocPropertyName.includes('.');
-    if (isPropertyPath) {
-      if (!lastRealProperty) {
-        report(`@${targetTagName} path declaration ("${jsdocPropertyName}") appears before any real property.`, null, jsdoc.tags[idx]);
-        return true;
-      }
-      let pathRootNodeName = jsdocPropertyName.slice(0, jsdocPropertyName.indexOf('.'));
-      if (pathRootNodeName.endsWith('[]')) {
-        pathRootNodeName = pathRootNodeName.slice(0, -2);
-      }
-      if (pathRootNodeName !== lastRealProperty) {
-        report(`@${targetTagName} path declaration ("${jsdocPropertyName}") root node name ("${pathRootNodeName}") ` + `does not match previous real property name ("${lastRealProperty}").`, null, jsdoc.tags[idx]);
-        return true;
-      }
-    } else {
-      lastRealProperty = jsdocPropertyName;
-    }
-    return false;
-  });
+	/** @type {string} */
+	let lastRealProperty;
+	return jsdocPropertyNames.some(({ idx, name: jsdocPropertyName }) => {
+		const isPropertyPath = jsdocPropertyName.includes(".");
+		if (isPropertyPath) {
+			if (!lastRealProperty) {
+				report(`@${targetTagName} path declaration ("${jsdocPropertyName}") appears before any real property.`, null, jsdoc.tags[idx]);
+				return true;
+			}
+			let pathRootNodeName = jsdocPropertyName.slice(0, jsdocPropertyName.indexOf("."));
+			if (pathRootNodeName.endsWith("[]")) pathRootNodeName = pathRootNodeName.slice(0, -2);
+			if (pathRootNodeName !== lastRealProperty) {
+				report(`@${targetTagName} path declaration ("${jsdocPropertyName}") root node name ("${pathRootNodeName}") does not match previous real property name ("${lastRealProperty}").`, null, jsdoc.tags[idx]);
+				return true;
+			}
+		} else lastRealProperty = jsdocPropertyName;
+		return false;
+	});
 };
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  context,
-  jsdoc,
-  report,
-  utils
-}) => {
-  const {
-    enableFixer = false
-  } = context.options[0] || {};
-  const jsdocPropertyNamesDeep = utils.getJsdocTagsDeep('property');
-  if (!jsdocPropertyNamesDeep || !jsdocPropertyNamesDeep.length) {
-    return;
-  }
-  const targetTagName = /** @type {string} */utils.getPreferredTagName({
-    tagName: 'property'
-  });
-  const isError = validatePropertyNames(targetTagName, enableFixer, jsdoc, utils);
-  if (isError) {
-    return;
-  }
-  validatePropertyNamesDeep(targetTagName, jsdocPropertyNamesDeep, jsdoc, report);
+var checkPropertyNames_default = require_iterateJsdoc.default(({ context, jsdoc, report, utils }) => {
+	const { enableFixer = false } = context.options[0] || {};
+	const jsdocPropertyNamesDeep = utils.getJsdocTagsDeep("property");
+	if (!jsdocPropertyNamesDeep || !jsdocPropertyNamesDeep.length) return;
+	const targetTagName = utils.getPreferredTagName({ tagName: "property" });
+	const isError = validatePropertyNames(targetTagName, enableFixer, jsdoc, utils);
+	if (isError) return;
+	validatePropertyNamesDeep(targetTagName, jsdocPropertyNamesDeep, jsdoc, report);
 }, {
-  iterateAllJsdocs: true,
-  meta: {
-    docs: {
-      description: 'Ensures that property names in JSDoc are not duplicated on the same block and that nested properties have defined roots.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-property-names.md#repos-sticky-header'
-    },
-    fixable: 'code',
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        enableFixer: {
-          type: 'boolean'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'suggestion'
-  }
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "Ensures that property names in JSDoc are not duplicated on the same block and that nested properties have defined roots.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-property-names.md#repos-sticky-header"
+		},
+		fixable: "code",
+		schema: [{
+			additionalProperties: false,
+			properties: { enableFixer: { type: "boolean" } },
+			type: "object"
+		}],
+		type: "suggestion"
+	}
 });
-module.exports = exports.default;
+
+//#endregion
+exports.default = checkPropertyNames_default;
 //# sourceMappingURL=checkPropertyNames.cjs.map