eslint-plugin-jsdoc 52.0.3 → 52.0.4

package/dist/rules/checkExamples.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"checkExamples.js","names":[],"sources":["../../src/rules/checkExamples.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport eslint, {\n  ESLint,\n} from 'eslint';\nimport semver from 'semver';\n\nconst {\n  // @ts-expect-error Older ESLint\n  CLIEngine,\n} = eslint;\n\nconst zeroBasedLineIndexAdjust = -1;\nconst likelyNestedJSDocIndentSpace = 1;\nconst preTagSpaceLength = 1;\n\n// If a space is present, we should ignore it\nconst firstLinePrefixLength = preTagSpaceLength;\n\nconst hasCaptionRegex = /^\\s*<caption>([\\s\\S]*?)<\\/caption>/v;\n\n/**\n * @param {string} str\n * @returns {string}\n */\nconst escapeStringRegexp = (str) => {\n  return str.replaceAll(/[.*+?^$\\{\\}\\(\\)\\|\\[\\]\\\\]/gv, '\\\\$&');\n};\n\n/**\n * @param {string} str\n * @param {string} ch\n * @returns {import('../iterateJsdoc.js').Integer}\n */\nconst countChars = (str, ch) => {\n  return (str.match(new RegExp(escapeStringRegexp(ch), 'gv')) || []).length;\n};\n\n/** @type {import('eslint').Linter.RulesRecord} */\nconst defaultMdRules = {\n  // \"always\" newline rule at end unlikely in sample code\n  'eol-last': 0,\n\n  // Wouldn't generally expect example paths to resolve relative to JS file\n  'import/no-unresolved': 0,\n\n  // Snippets likely too short to always include import/export info\n  'import/unambiguous': 0,\n\n  'jsdoc/require-file-overview': 0,\n\n  // The end of a multiline comment would end the comment the example is in.\n  'jsdoc/require-jsdoc': 0,\n\n  // Unlikely to have inadvertent debugging within examples\n  'no-console': 0,\n\n  // Often wish to start `@example` code after newline; also may use\n  //   empty lines for spacing\n  'no-multiple-empty-lines': 0,\n\n  // Many variables in examples will be `undefined`\n  'no-undef': 0,\n\n  // Common to define variables for clarity without always using them\n  'no-unused-vars': 0,\n\n  // See import/no-unresolved\n  'node/no-missing-import': 0,\n  'node/no-missing-require': 0,\n\n  // Can generally look nicer to pad a little even if code imposes more stringency\n  'padded-blocks': 0,\n};\n\n/** @type {import('eslint').Linter.RulesRecord} */\nconst defaultExpressionRules = {\n  ...defaultMdRules,\n  'chai-friendly/no-unused-expressions': 'off',\n  'no-empty-function': 'off',\n  'no-new': 'off',\n  'no-unused-expressions': 'off',\n  quotes: [\n    'error', 'double',\n  ],\n  semi: [\n    'error', 'never',\n  ],\n  strict: 'off',\n};\n\n/**\n * @param {string} text\n * @returns {[\n *   import('../iterateJsdoc.js').Integer,\n *   import('../iterateJsdoc.js').Integer\n * ]}\n */\nconst getLinesCols = (text) => {\n  const matchLines = countChars(text, '\\n');\n\n  const colDelta = matchLines ?\n    text.slice(text.lastIndexOf('\\n') + 1).length :\n    text.length;\n\n  return [\n    matchLines, colDelta,\n  ];\n};\n\nexport default iterateJsdoc(({\n  context,\n  globalState,\n  report,\n  utils,\n}) => {\n  if (semver.gte(ESLint.version, '8.0.0')) {\n    report(\n      'This rule does not work for ESLint 8+; you should disable this rule and use' +\n        'the processor mentioned in the docs.',\n      null,\n      {\n        column: 1,\n        line: 1,\n      },\n    );\n\n    return;\n  }\n\n  if (!globalState.has('checkExamples-matchingFileName')) {\n    globalState.set('checkExamples-matchingFileName', new Map());\n  }\n\n  const matchingFileNameMap = /** @type {Map<string, string>} */ (\n    globalState.get('checkExamples-matchingFileName')\n  );\n\n  const options = context.options[0] || {};\n  let {\n    exampleCodeRegex = null,\n    rejectExampleCodeRegex = null,\n  } = options;\n  const {\n    allowInlineConfig = true,\n    baseConfig = {},\n    captionRequired = false,\n    checkDefaults = false,\n    checkEslintrc = true,\n    checkParams = false,\n    checkProperties = false,\n    configFile,\n    matchingFileName = null,\n    matchingFileNameDefaults = null,\n    matchingFileNameParams = null,\n    matchingFileNameProperties = null,\n    noDefaultExampleRules = false,\n    paddedIndent = 0,\n    reportUnusedDisableDirectives = true,\n  } = options;\n\n  // Make this configurable?\n  /**\n   * @type {never[]}\n   */\n  const rulePaths = [];\n\n  const mdRules = noDefaultExampleRules ? undefined : defaultMdRules;\n\n  const expressionRules = noDefaultExampleRules ? undefined : defaultExpressionRules;\n\n  if (exampleCodeRegex) {\n    exampleCodeRegex = utils.getRegexFromString(exampleCodeRegex);\n  }\n\n  if (rejectExampleCodeRegex) {\n    rejectExampleCodeRegex = utils.getRegexFromString(rejectExampleCodeRegex);\n  }\n\n  /**\n   * @param {{\n   *   filename: string,\n   *   defaultFileName: string|undefined,\n   *   source: string,\n   *   targetTagName: string,\n   *   rules?: import('eslint').Linter.RulesRecord|undefined,\n   *   lines?: import('../iterateJsdoc.js').Integer,\n   *   cols?: import('../iterateJsdoc.js').Integer,\n   *   skipInit?: boolean,\n   *   sources?: {\n   *     nonJSPrefacingCols: import('../iterateJsdoc.js').Integer,\n   *     nonJSPrefacingLines: import('../iterateJsdoc.js').Integer,\n   *     string: string,\n   *   }[],\n   *   tag?: import('comment-parser').Spec & {\n   *     line?: import('../iterateJsdoc.js').Integer,\n   *   }|{\n   *     line: import('../iterateJsdoc.js').Integer,\n   *   }\n   * }} cfg\n   */\n  const checkSource = ({\n    cols = 0,\n    defaultFileName,\n    filename,\n    lines = 0,\n    rules = expressionRules,\n    skipInit,\n    source,\n    sources = [],\n    tag = {\n      line: 0,\n    },\n    targetTagName,\n  }) => {\n    if (!skipInit) {\n      sources.push({\n        nonJSPrefacingCols: cols,\n        nonJSPrefacingLines: lines,\n        string: source,\n      });\n    }\n\n    /**\n     * @param {{\n     *   nonJSPrefacingCols: import('../iterateJsdoc.js').Integer,\n     *   nonJSPrefacingLines: import('../iterateJsdoc.js').Integer,\n     *   string: string\n     * }} cfg\n     */\n    const checkRules = function ({\n      nonJSPrefacingCols,\n      nonJSPrefacingLines,\n      string,\n    }) {\n      const cliConfig = {\n        allowInlineConfig,\n        baseConfig,\n        configFile,\n        reportUnusedDisableDirectives,\n        rulePaths,\n        rules,\n        useEslintrc: checkEslintrc,\n      };\n      const cliConfigStr = JSON.stringify(cliConfig);\n\n      const src = paddedIndent ?\n        string.replaceAll(new RegExp(`(^|\\n) {${paddedIndent}}(?!$)`, 'gv'), '\\n') :\n        string;\n\n      // Programmatic ESLint API: https://eslint.org/docs/developer-guide/nodejs-api\n      const fileNameMapKey = filename ?\n        'a' + cliConfigStr + filename :\n        'b' + cliConfigStr + defaultFileName;\n      const file = filename || defaultFileName;\n      let cliFile;\n      if (matchingFileNameMap.has(fileNameMapKey)) {\n        cliFile = matchingFileNameMap.get(fileNameMapKey);\n      } else {\n        const cli = new CLIEngine(cliConfig);\n        let config;\n        if (filename || checkEslintrc) {\n          config = cli.getConfigForFile(file);\n        }\n\n        // We need a new instance to ensure that the rules that may only\n        //  be available to `file` (if it has its own `.eslintrc`),\n        //  will be defined.\n        cliFile = new CLIEngine({\n          allowInlineConfig,\n          baseConfig: {\n            ...baseConfig,\n            ...config,\n          },\n          configFile,\n          reportUnusedDisableDirectives,\n          rulePaths,\n          rules,\n          useEslintrc: false,\n        });\n        matchingFileNameMap.set(fileNameMapKey, cliFile);\n      }\n\n      const {\n        results: [\n          {\n            messages,\n          },\n        ],\n      } = cliFile.executeOnText(src);\n\n      if (!('line' in tag)) {\n        tag.line = tag.source[0].number;\n      }\n\n      // NOTE: `tag.line` can be 0 if of form `/** @tag ... */`\n      const codeStartLine = /**\n                             * @type {import('comment-parser').Spec & {\n                             *     line: import('../iterateJsdoc.js').Integer,\n                             * }}\n                             */ (tag).line + nonJSPrefacingLines;\n      const codeStartCol = likelyNestedJSDocIndentSpace;\n\n      for (const {\n        column,\n        line,\n        message,\n        ruleId,\n        severity,\n      } of messages) {\n        const startLine = codeStartLine + line + zeroBasedLineIndexAdjust;\n        const startCol = codeStartCol + (\n\n          // This might not work for line 0, but line 0 is unlikely for examples\n          line <= 1 ? nonJSPrefacingCols + firstLinePrefixLength : preTagSpaceLength\n        ) + column;\n\n        report(\n          '@' + targetTagName + ' ' + (severity === 2 ? 'error' : 'warning') +\n            (ruleId ? ' (' + ruleId + ')' : '') + ': ' +\n            message,\n          null,\n          {\n            column: startCol,\n            line: startLine,\n          },\n        );\n      }\n    };\n\n    for (const targetSource of sources) {\n      checkRules(targetSource);\n    }\n  };\n\n  /**\n   *\n   * @param {string} filename\n   * @param {string} [ext] Since `eslint-plugin-markdown` v2, and\n   *   ESLint 7, this is the default which other JS-fenced rules will used.\n   *   Formerly \"md\" was the default.\n   * @returns {{defaultFileName: string|undefined, filename: string}}\n   */\n  const getFilenameInfo = (filename, ext = 'md/*.js') => {\n    let defaultFileName;\n    if (!filename) {\n      const jsFileName = context.getFilename();\n      if (typeof jsFileName === 'string' && jsFileName.includes('.')) {\n        defaultFileName = jsFileName.replace(/\\.[^.]*$/v, `.${ext}`);\n      } else {\n        defaultFileName = `dummy.${ext}`;\n      }\n    }\n\n    return {\n      defaultFileName,\n      filename,\n    };\n  };\n\n  if (checkDefaults) {\n    const filenameInfo = getFilenameInfo(matchingFileNameDefaults, 'jsdoc-defaults');\n    utils.forEachPreferredTag('default', (tag, targetTagName) => {\n      if (!tag.description.trim()) {\n        return;\n      }\n\n      checkSource({\n        source: `(${utils.getTagDescription(tag)})`,\n        targetTagName,\n        ...filenameInfo,\n      });\n    });\n  }\n\n  if (checkParams) {\n    const filenameInfo = getFilenameInfo(matchingFileNameParams, 'jsdoc-params');\n    utils.forEachPreferredTag('param', (tag, targetTagName) => {\n      if (!tag.default || !tag.default.trim()) {\n        return;\n      }\n\n      checkSource({\n        source: `(${tag.default})`,\n        targetTagName,\n        ...filenameInfo,\n      });\n    });\n  }\n\n  if (checkProperties) {\n    const filenameInfo = getFilenameInfo(matchingFileNameProperties, 'jsdoc-properties');\n    utils.forEachPreferredTag('property', (tag, targetTagName) => {\n      if (!tag.default || !tag.default.trim()) {\n        return;\n      }\n\n      checkSource({\n        source: `(${tag.default})`,\n        targetTagName,\n        ...filenameInfo,\n      });\n    });\n  }\n\n  const tagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'example',\n  }));\n  if (!utils.hasTag(tagName)) {\n    return;\n  }\n\n  const matchingFilenameInfo = getFilenameInfo(matchingFileName);\n\n  utils.forEachPreferredTag('example', (tag, targetTagName) => {\n    let source = /** @type {string} */ (utils.getTagDescription(tag));\n    const match = source.match(hasCaptionRegex);\n\n    if (captionRequired && (!match || !match[1].trim())) {\n      report('Caption is expected for examples.', null, tag);\n    }\n\n    source = source.replace(hasCaptionRegex, '');\n    const [\n      lines,\n      cols,\n    ] = match ? getLinesCols(match[0]) : [\n      0, 0,\n    ];\n\n    if (exampleCodeRegex && !exampleCodeRegex.test(source) ||\n      rejectExampleCodeRegex && rejectExampleCodeRegex.test(source)\n    ) {\n      return;\n    }\n\n    const sources = [];\n    let skipInit = false;\n    if (exampleCodeRegex) {\n      let nonJSPrefacingCols = 0;\n      let nonJSPrefacingLines = 0;\n\n      let startingIndex = 0;\n      let lastStringCount = 0;\n\n      let exampleCode;\n      exampleCodeRegex.lastIndex = 0;\n      while ((exampleCode = exampleCodeRegex.exec(source)) !== null) {\n        const {\n          '0': n0,\n          '1': n1,\n          index,\n        } = exampleCode;\n\n        // Count anything preceding user regex match (can affect line numbering)\n        const preMatch = source.slice(startingIndex, index);\n\n        const [\n          preMatchLines,\n          colDelta,\n        ] = getLinesCols(preMatch);\n\n        let nonJSPreface;\n        let nonJSPrefaceLineCount;\n        if (n1) {\n          const idx = n0.indexOf(n1);\n          nonJSPreface = n0.slice(0, idx);\n          nonJSPrefaceLineCount = countChars(nonJSPreface, '\\n');\n        } else {\n          nonJSPreface = '';\n          nonJSPrefaceLineCount = 0;\n        }\n\n        nonJSPrefacingLines += lastStringCount + preMatchLines + nonJSPrefaceLineCount;\n\n        // Ignore `preMatch` delta if newlines here\n        if (nonJSPrefaceLineCount) {\n          const charsInLastLine = nonJSPreface.slice(nonJSPreface.lastIndexOf('\\n') + 1).length;\n\n          nonJSPrefacingCols += charsInLastLine;\n        } else {\n          nonJSPrefacingCols += colDelta + nonJSPreface.length;\n        }\n\n        const string = n1 || n0;\n        sources.push({\n          nonJSPrefacingCols,\n          nonJSPrefacingLines,\n          string,\n        });\n        startingIndex = exampleCodeRegex.lastIndex;\n        lastStringCount = countChars(string, '\\n');\n        if (!exampleCodeRegex.global) {\n          break;\n        }\n      }\n\n      skipInit = true;\n    }\n\n    checkSource({\n      cols,\n      lines,\n      rules: mdRules,\n      skipInit,\n      source,\n      sources,\n      tag,\n      targetTagName,\n      ...matchingFilenameInfo,\n    });\n  });\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Ensures that (JavaScript) examples within JSDoc adhere to ESLint rules.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-examples.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          allowInlineConfig: {\n            default: true,\n            type: 'boolean',\n          },\n          baseConfig: {\n            type: 'object',\n          },\n          captionRequired: {\n            default: false,\n            type: 'boolean',\n          },\n          checkDefaults: {\n            default: false,\n            type: 'boolean',\n          },\n          checkEslintrc: {\n            default: true,\n            type: 'boolean',\n          },\n          checkParams: {\n            default: false,\n            type: 'boolean',\n          },\n          checkProperties: {\n            default: false,\n            type: 'boolean',\n          },\n          configFile: {\n            type: 'string',\n          },\n          exampleCodeRegex: {\n            type: 'string',\n          },\n          matchingFileName: {\n            type: 'string',\n          },\n          matchingFileNameDefaults: {\n            type: 'string',\n          },\n          matchingFileNameParams: {\n            type: 'string',\n          },\n          matchingFileNameProperties: {\n            type: 'string',\n          },\n          noDefaultExampleRules: {\n            default: false,\n            type: 'boolean',\n          },\n          paddedIndent: {\n            default: 0,\n            type: 'integer',\n          },\n          rejectExampleCodeRegex: {\n            type: 'string',\n          },\n          reportUnusedDisableDirectives: {\n            default: true,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;AAMA,MAAM,EAEJ,WACD,GAAG;AAEJ,MAAM,2BAA2B;AACjC,MAAM,+BAA+B;AACrC,MAAM,oBAAoB;AAG1B,MAAM,wBAAwB;AAE9B,MAAM,kBAAkB;;;;;AAMxB,MAAM,qBAAqB,CAAC,QAAQ;AAClC,QAAO,IAAI,WAAW,8BAA8B,OAAO;AAC5D;;;;;;AAOD,MAAM,aAAa,CAAC,KAAK,OAAO;AAC9B,SAAQ,IAAI,MAAM,IAAI,OAAO,mBAAmB,GAAG,EAAE,MAAM,IAAI,CAAE,GAAE;AACpE;;AAGD,MAAM,iBAAiB;CAErB,YAAY;CAGZ,wBAAwB;CAGxB,sBAAsB;CAEtB,+BAA+B;CAG/B,uBAAuB;CAGvB,cAAc;CAId,2BAA2B;CAG3B,YAAY;CAGZ,kBAAkB;CAGlB,0BAA0B;CAC1B,2BAA2B;CAG3B,iBAAiB;AAClB;;AAGD,MAAM,yBAAyB;CAC7B,GAAG;CACH,uCAAuC;CACvC,qBAAqB;CACrB,UAAU;CACV,yBAAyB;CACzB,QAAQ,CACN,SAAS,QACV;CACD,MAAM,CACJ,SAAS,OACV;CACD,QAAQ;AACT;;;;;;;;AASD,MAAM,eAAe,CAAC,SAAS;CAC7B,MAAM,aAAa,WAAW,MAAM,KAAK;CAEzC,MAAM,WAAW,aACf,KAAK,MAAM,KAAK,YAAY,KAAK,GAAG,EAAE,CAAC,SACvC,KAAK;AAEP,QAAO,CACL,YAAY,QACb;AACF;AAED,4BAAe,aAAa,CAAC,EAC3B,SACA,aACA,QACA,OACD,KAAK;AACJ,KAAI,OAAO,IAAI,OAAO,SAAS,QAAQ,EAAE;EACvC,OACE,mHAEA,MACA;GACE,QAAQ;GACR,MAAM;EACP,EACF;AAED;CACD;AAED,KAAI,CAAC,YAAY,IAAI,iCAAiC,EACpD,YAAY,IAAI,kDAAkC,IAAI,MAAM;CAG9D,MAAM,sBACJ,YAAY,IAAI,iCAAiC;CAGnD,MAAM,UAAU,QAAQ,QAAQ,MAAM,CAAE;CACxC,IAAI,EACF,mBAAmB,MACnB,yBAAyB,MAC1B,GAAG;CACJ,MAAM,EACJ,oBAAoB,MACpB,aAAa,CAAE,GACf,kBAAkB,OAClB,gBAAgB,OAChB,gBAAgB,MAChB,cAAc,OACd,kBAAkB,OAClB,YACA,mBAAmB,MACnB,2BAA2B,MAC3B,yBAAyB,MACzB,6BAA6B,MAC7B,wBAAwB,OACxB,eAAe,GACf,gCAAgC,MACjC,GAAG;;;;CAMJ,MAAM,YAAY,CAAE;CAEpB,MAAM,UAAU,wBAAwB,SAAY;CAEpD,MAAM,kBAAkB,wBAAwB,SAAY;AAE5D,KAAI,kBACF,mBAAmB,MAAM,mBAAmB,iBAAiB;AAG/D,KAAI,wBACF,yBAAyB,MAAM,mBAAmB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;CAyB3E,MAAM,cAAc,CAAC,EACnB,OAAO,GACP,iBACA,UACA,QAAQ,GACR,QAAQ,iBACR,UACA,QACA,UAAU,CAAE,GACZ,MAAM,EACJ,MAAM,EACP,GACD,eACD,KAAK;AACJ,MAAI,CAAC,UACH,QAAQ,KAAK;GACX,oBAAoB;GACpB,qBAAqB;GACrB,QAAQ;EACT,EAAC;;;;;;;;EAUJ,MAAM,aAAa,SAAU,EAC3B,oBACA,qBACA,QACD,EAAE;GACD,MAAM,YAAY;IAChB;IACA;IACA;IACA;IACA;IACA;IACA,aAAa;GACd;GACD,MAAM,eAAe,KAAK,UAAU,UAAU;GAE9C,MAAM,MAAM,eACV,OAAO,WAAW,IAAI,OAAO,CAAC,QAAQ,EAAE,aAAa,MAAM,CAAC,EAAE,OAAO,KAAK,GAC1E;GAGF,MAAM,iBAAiB,WACrB,MAAM,eAAe,WACrB,MAAM,eAAe;GACvB,MAAM,OAAO,YAAY;GACzB,IAAI;AACJ,OAAI,oBAAoB,IAAI,eAAe,EACzC,UAAU,oBAAoB,IAAI,eAAe;QAC5C;IACL,MAAM,MAAM,IAAI,UAAU;IAC1B,IAAI;AACJ,QAAI,YAAY,eACd,SAAS,IAAI,iBAAiB,KAAK;IAMrC,UAAU,IAAI,UAAU;KACtB;KACA,YAAY;MACV,GAAG;MACH,GAAG;KACJ;KACD;KACA;KACA;KACA;KACA,aAAa;IACd;IACD,oBAAoB,IAAI,gBAAgB,QAAQ;GACjD;GAED,MAAM,EACJ,SAAS,CACP,EACE,UACD,CACF,EACF,GAAG,QAAQ,cAAc,IAAI;AAE9B,OAAI,EAAE,UAAU,MACd,IAAI,OAAO,IAAI,OAAO,GAAG;GAI3B,MAAM,gBAIqB,IAAK,OAAO;GACvC,MAAM,eAAe;AAErB,QAAK,MAAM,EACT,QACA,MACA,SACA,QACA,UACD,IAAI,UAAU;IACb,MAAM,YAAY,gBAAgB,OAAO;IACzC,MAAM,WAAW,gBAGf,QAAQ,IAAI,qBAAqB,wBAAwB,qBACvD;IAEJ,OACE,MAAM,gBAAgB,OAAO,aAAa,IAAI,UAAU,cACrD,SAAS,OAAO,SAAS,MAAM,MAAM,OACtC,SACF,MACA;KACE,QAAQ;KACR,MAAM;IACP,EACF;GACF;EACF;AAED,OAAK,MAAM,gBAAgB,SACzB,WAAW,aAAa;CAE3B;;;;;;;;;CAUD,MAAM,kBAAkB,CAAC,UAAU,MAAM,cAAc;EACrD,IAAI;AACJ,MAAI,CAAC,UAAU;GACb,MAAM,aAAa,QAAQ,aAAa;AACxC,OAAI,OAAO,eAAe,YAAY,WAAW,SAAS,IAAI,EAC5D,kBAAkB,WAAW,QAAQ,aAAa,CAAC,CAAC,EAAE,KAAK,CAAC;QAE5D,kBAAkB,CAAC,MAAM,EAAE,KAAK;EAEnC;AAED,SAAO;GACL;GACA;EACD;CACF;AAED,KAAI,eAAe;EACjB,MAAM,eAAe,gBAAgB,0BAA0B,iBAAiB;EAChF,MAAM,oBAAoB,WAAW,CAAC,KAAK,kBAAkB;AAC3D,OAAI,CAAC,IAAI,YAAY,MAAM,CACzB;GAGF,YAAY;IACV,QAAQ,CAAC,CAAC,EAAE,MAAM,kBAAkB,IAAI,CAAC,CAAC,CAAC;IAC3C;IACA,GAAG;GACJ,EAAC;EACH,EAAC;CACH;AAED,KAAI,aAAa;EACf,MAAM,eAAe,gBAAgB,wBAAwB,eAAe;EAC5E,MAAM,oBAAoB,SAAS,CAAC,KAAK,kBAAkB;AACzD,OAAI,CAAC,IAAI,WAAW,CAAC,IAAI,QAAQ,MAAM,CACrC;GAGF,YAAY;IACV,QAAQ,CAAC,CAAC,EAAE,IAAI,QAAQ,CAAC,CAAC;IAC1B;IACA,GAAG;GACJ,EAAC;EACH,EAAC;CACH;AAED,KAAI,iBAAiB;EACnB,MAAM,eAAe,gBAAgB,4BAA4B,mBAAmB;EACpF,MAAM,oBAAoB,YAAY,CAAC,KAAK,kBAAkB;AAC5D,OAAI,CAAC,IAAI,WAAW,CAAC,IAAI,QAAQ,MAAM,CACrC;GAGF,YAAY;IACV,QAAQ,CAAC,CAAC,EAAE,IAAI,QAAQ,CAAC,CAAC;IAC1B;IACA,GAAG;GACJ,EAAC;EACH,EAAC;CACH;CAED,MAAM,UAAiC,MAAM,oBAAoB,EAC/D,SAAS,UACV,EAAC;AACF,KAAI,CAAC,MAAM,OAAO,QAAQ,CACxB;CAGF,MAAM,uBAAuB,gBAAgB,iBAAiB;CAE9D,MAAM,oBAAoB,WAAW,CAAC,KAAK,kBAAkB;EAC3D,IAAI,SAAgC,MAAM,kBAAkB,IAAI;EAChE,MAAM,QAAQ,OAAO,MAAM,gBAAgB;AAE3C,MAAI,oBAAoB,CAAC,SAAS,CAAC,MAAM,GAAG,MAAM,GAChD,OAAO,qCAAqC,MAAM,IAAI;EAGxD,SAAS,OAAO,QAAQ,iBAAiB,GAAG;EAC5C,MAAM,CACJ,OACA,KACD,GAAG,QAAQ,aAAa,MAAM,GAAG,GAAG,CACnC,GAAG,CACJ;AAED,MAAI,oBAAoB,CAAC,iBAAiB,KAAK,OAAO,IACpD,0BAA0B,uBAAuB,KAAK,OAAO,CAE7D;EAGF,MAAM,UAAU,CAAE;EAClB,IAAI,WAAW;AACf,MAAI,kBAAkB;GACpB,IAAI,qBAAqB;GACzB,IAAI,sBAAsB;GAE1B,IAAI,gBAAgB;GACpB,IAAI,kBAAkB;GAEtB,IAAI;GACJ,iBAAiB,YAAY;AAC7B,WAAQ,cAAc,iBAAiB,KAAK,OAAO,MAAM,MAAM;IAC7D,MAAM,EACJ,KAAK,IACL,KAAK,IACL,OACD,GAAG;IAGJ,MAAM,WAAW,OAAO,MAAM,eAAe,MAAM;IAEnD,MAAM,CACJ,eACA,SACD,GAAG,aAAa,SAAS;IAE1B,IAAI;IACJ,IAAI;AACJ,QAAI,IAAI;KACN,MAAM,MAAM,GAAG,QAAQ,GAAG;KAC1B,eAAe,GAAG,MAAM,GAAG,IAAI;KAC/B,wBAAwB,WAAW,cAAc,KAAK;IACvD,OAAM;KACL,eAAe;KACf,wBAAwB;IACzB;IAED,uBAAuB,kBAAkB,gBAAgB;AAGzD,QAAI,uBAAuB;KACzB,MAAM,kBAAkB,aAAa,MAAM,aAAa,YAAY,KAAK,GAAG,EAAE,CAAC;KAE/E,sBAAsB;IACvB,OACC,sBAAsB,WAAW,aAAa;IAGhD,MAAM,SAAS,MAAM;IACrB,QAAQ,KAAK;KACX;KACA;KACA;IACD,EAAC;IACF,gBAAgB,iBAAiB;IACjC,kBAAkB,WAAW,QAAQ,KAAK;AAC1C,QAAI,CAAC,iBAAiB,OACpB;GAEH;GAED,WAAW;EACZ;EAED,YAAY;GACV;GACA;GACA,OAAO;GACP;GACA;GACA;GACA;GACA;GACA,GAAG;EACJ,EAAC;CACH,EAAC;AACH,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,mBAAmB;KACjB,SAAS;KACT,MAAM;IACP;IACD,YAAY,EACV,MAAM,SACP;IACD,iBAAiB;KACf,SAAS;KACT,MAAM;IACP;IACD,eAAe;KACb,SAAS;KACT,MAAM;IACP;IACD,eAAe;KACb,SAAS;KACT,MAAM;IACP;IACD,aAAa;KACX,SAAS;KACT,MAAM;IACP;IACD,iBAAiB;KACf,SAAS;KACT,MAAM;IACP;IACD,YAAY,EACV,MAAM,SACP;IACD,kBAAkB,EAChB,MAAM,SACP;IACD,kBAAkB,EAChB,MAAM,SACP;IACD,0BAA0B,EACxB,MAAM,SACP;IACD,wBAAwB,EACtB,MAAM,SACP;IACD,4BAA4B,EAC1B,MAAM,SACP;IACD,uBAAuB;KACrB,SAAS;KACT,MAAM;IACP;IACD,cAAc;KACZ,SAAS;KACT,MAAM;IACP;IACD,wBAAwB,EACtB,MAAM,SACP;IACD,+BAA+B;KAC7B,SAAS;KACT,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/checkIndentation.js

@@ -1,59 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/checkIndentation.js
-/**
-* @param {string} str
-* @param {string[]} excludeTags
-* @returns {string}
-*/
-const maskExcludedContent = (str, excludeTags) => {
-	const regContent = new RegExp(`([ \\t]+\\*)[ \\t]@(?:${excludeTags.join("|")})(?=[ \\n])([\\w\\|\\W]*?\\n)(?=[ \\t]*\\*(?:[ \\t]*@\\w+\\s|\\/))`, "gv");
-	return str.replace(regContent, (_match, margin, code) => {
-		return (margin + "\n").repeat(code.match(/\n/gv).length);
-	});
-};
-/**
-* @param {string} str
-* @returns {string}
-*/
-const maskCodeBlocks = (str) => {
-	const regContent = /([ \t]+\*)[ \t]```[^\n]*?([\w\|\W]*?\n)(?=[ \t]*\*(?:[ \t]*(?:```|@\w+\s)|\/))/gv;
-	return str.replaceAll(regContent, (_match, margin, code) => {
-		return (margin + "\n").repeat(code.match(/\n/gv).length);
-	});
-};
-var checkIndentation_default = iterateJsdoc(({ context, jsdocNode, report, sourceCode }) => {
-	const options = context.options[0] || {};
-	const { excludeTags = ["example"] } = options;
-	const reg = /^(?:\/?\**|[ \t]*)\*[ \t]{2}/gmv;
-	const textWithoutCodeBlocks = maskCodeBlocks(sourceCode.getText(jsdocNode));
-	const text = excludeTags.length ? maskExcludedContent(textWithoutCodeBlocks, excludeTags) : textWithoutCodeBlocks;
-	if (reg.test(text)) {
-		const lineBreaks = text.slice(0, reg.lastIndex).match(/\n/gv) || [];
-		report("There must be no indentation.", null, { line: lineBreaks.length });
-	}
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Reports invalid padding inside JSDoc blocks.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-indentation.md#repos-sticky-header"
-		},
-		schema: [{
-			additionalProperties: false,
-			properties: { excludeTags: {
-				items: {
-					pattern: "^\\S+$",
-					type: "string"
-				},
-				type: "array"
-			} },
-			type: "object"
-		}],
-		type: "layout"
-	}
-});
-
-//#endregion
-export { checkIndentation_default as default };
-//# sourceMappingURL=checkIndentation.js.map

package/dist/rules/checkIndentation.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"checkIndentation.js","names":[],"sources":["../../src/rules/checkIndentation.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {string} str\n * @param {string[]} excludeTags\n * @returns {string}\n */\nconst maskExcludedContent = (str, excludeTags) => {\n  const regContent = new RegExp(`([ \\\\t]+\\\\*)[ \\\\t]@(?:${excludeTags.join('|')})(?=[ \\\\n])([\\\\w\\\\|\\\\W]*?\\\\n)(?=[ \\\\t]*\\\\*(?:[ \\\\t]*@\\\\w+\\\\s|\\\\/))`, 'gv');\n\n  return str.replace(regContent, (_match, margin, code) => {\n    return (margin + '\\n').repeat(code.match(/\\n/gv).length);\n  });\n};\n\n/**\n * @param {string} str\n * @returns {string}\n */\nconst maskCodeBlocks = (str) => {\n  const regContent = /([ \\t]+\\*)[ \\t]```[^\\n]*?([\\w\\|\\W]*?\\n)(?=[ \\t]*\\*(?:[ \\t]*(?:```|@\\w+\\s)|\\/))/gv;\n\n  return str.replaceAll(regContent, (_match, margin, code) => {\n    return (margin + '\\n').repeat(code.match(/\\n/gv).length);\n  });\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdocNode,\n  report,\n  sourceCode,\n}) => {\n  const options = context.options[0] || {};\n  const /** @type {{excludeTags: string[]}} */ {\n    excludeTags = [\n      'example',\n    ],\n  } = options;\n\n  const reg = /^(?:\\/?\\**|[ \\t]*)\\*[ \\t]{2}/gmv;\n  const textWithoutCodeBlocks = maskCodeBlocks(sourceCode.getText(jsdocNode));\n  const text = excludeTags.length ? maskExcludedContent(textWithoutCodeBlocks, excludeTags) : textWithoutCodeBlocks;\n\n  if (reg.test(text)) {\n    const lineBreaks = text.slice(0, reg.lastIndex).match(/\\n/gv) || [];\n    report('There must be no indentation.', null, {\n      line: lineBreaks.length,\n    });\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Reports invalid padding inside JSDoc blocks.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-indentation.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          excludeTags: {\n            items: {\n              pattern: '^\\\\S+$',\n              type: 'string',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'layout',\n  },\n});\n"],"mappings":";;;;;;;;AAOA,MAAM,sBAAsB,CAAC,KAAK,gBAAgB;CAChD,MAAM,aAAa,IAAI,OAAO,CAAC,sBAAsB,EAAE,YAAY,KAAK,IAAI,CAAC,kEAAkE,CAAC,EAAE;AAElJ,QAAO,IAAI,QAAQ,YAAY,CAAC,QAAQ,QAAQ,SAAS;AACvD,UAAQ,SAAS,MAAM,OAAO,KAAK,MAAM,OAAO,CAAC,OAAO;CACzD,EAAC;AACH;;;;;AAMD,MAAM,iBAAiB,CAAC,QAAQ;CAC9B,MAAM,aAAa;AAEnB,QAAO,IAAI,WAAW,YAAY,CAAC,QAAQ,QAAQ,SAAS;AAC1D,UAAQ,SAAS,MAAM,OAAO,KAAK,MAAM,OAAO,CAAC,OAAO;CACzD,EAAC;AACH;AAED,+BAAe,aAAa,CAAC,EAC3B,SACA,WACA,QACA,YACD,KAAK;CACJ,MAAM,UAAU,QAAQ,QAAQ,MAAM,CAAE;CACxC,MAA6C,EAC3C,cAAc,CACZ,SACD,GACF,GAAG;CAEJ,MAAM,MAAM;CACZ,MAAM,wBAAwB,eAAe,WAAW,QAAQ,UAAU,CAAC;CAC3E,MAAM,OAAO,YAAY,SAAS,oBAAoB,uBAAuB,YAAY,GAAG;AAE5F,KAAI,IAAI,KAAK,KAAK,EAAE;EAClB,MAAM,aAAa,KAAK,MAAM,GAAG,IAAI,UAAU,CAAC,MAAM,OAAO,IAAI,CAAE;EACnE,OAAO,iCAAiC,MAAM,EAC5C,MAAM,WAAW,OAClB,EAAC;CACH;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,aAAa;IACX,OAAO;KACL,SAAS;KACT,MAAM;IACP;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/checkLineAlignment.js

@@ -1,229 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-import alignTransform_default from "../alignTransform.js";
-import { transforms } from "comment-parser";
-
-//#region src/rules/checkLineAlignment.js
-const { flow: commentFlow } = transforms;
-/**
-* @typedef {{
-*   postDelimiter: import('../iterateJsdoc.js').Integer,
-*   postHyphen: import('../iterateJsdoc.js').Integer,
-*   postName: import('../iterateJsdoc.js').Integer,
-*   postTag: import('../iterateJsdoc.js').Integer,
-*   postType: import('../iterateJsdoc.js').Integer,
-* }} CustomSpacings
-*/
-/**
-* @param {import('../iterateJsdoc.js').Utils} utils
-* @param {import('comment-parser').Spec & {
-*   line: import('../iterateJsdoc.js').Integer
-* }} tag
-* @param {CustomSpacings} customSpacings
-*/
-const checkNotAlignedPerTag = (utils, tag, customSpacings) => {
-	/**
-	* @typedef {"tag"|"type"|"name"|"description"} ContentProp
-	*/
-	/** @type {("postDelimiter"|"postTag"|"postType"|"postName")[]} */
-	let spacerProps;
-	/** @type {ContentProp[]} */
-	let contentProps;
-	const mightHaveNamepath = utils.tagMightHaveNamepath(tag.tag);
-	if (mightHaveNamepath) {
-		spacerProps = [
-			"postDelimiter",
-			"postTag",
-			"postType",
-			"postName"
-		];
-		contentProps = [
-			"tag",
-			"type",
-			"name",
-			"description"
-		];
-	} else {
-		spacerProps = [
-			"postDelimiter",
-			"postTag",
-			"postType"
-		];
-		contentProps = [
-			"tag",
-			"type",
-			"description"
-		];
-	}
-	const { tokens } = tag.source[0];
-	/**
-	* @param {import('../iterateJsdoc.js').Integer} idx
-	* @param {(notRet: boolean, contentProp: ContentProp) => void} [callbck]
-	*/
-	const followedBySpace = (idx, callbck) => {
-		const nextIndex = idx + 1;
-		return spacerProps.slice(nextIndex).some((spacerProp, innerIdx) => {
-			const contentProp = contentProps[nextIndex + innerIdx];
-			const spacePropVal = tokens[spacerProp];
-			const ret = spacePropVal;
-			if (callbck) callbck(!ret, contentProp);
-			return ret && (callbck || !contentProp);
-		});
-	};
-	const postHyphenSpacing = customSpacings?.postHyphen ?? 1;
-	const exactHyphenSpacing = new RegExp(`^\\s*-\\s{${postHyphenSpacing},${postHyphenSpacing}}(?!\\s)`, "v");
-	const hasNoHyphen = !/^\s*-(?!$)(?=\s)/v.test(tokens.description);
-	const hasExactHyphenSpacing = exactHyphenSpacing.test(tokens.description);
-	const ok = !spacerProps.some((spacerProp, idx) => {
-		const contentProp = contentProps[idx];
-		const contentPropVal = tokens[contentProp];
-		const spacerPropVal = tokens[spacerProp];
-		const spacing = customSpacings?.[spacerProp] || 1;
-		return spacerPropVal.length !== spacing && spacerPropVal.length !== 0 || spacerPropVal && !contentPropVal && followedBySpace(idx);
-	}) && (hasNoHyphen || hasExactHyphenSpacing);
-	if (ok) return;
-	const fix = () => {
-		for (const [idx, spacerProp] of spacerProps.entries()) {
-			const contentProp = contentProps[idx];
-			const contentPropVal = tokens[contentProp];
-			if (contentPropVal) {
-				const spacing = customSpacings?.[spacerProp] || 1;
-				tokens[spacerProp] = "".padStart(spacing, " ");
-				followedBySpace(idx, (hasSpace, contentPrp) => {
-					if (hasSpace) tokens[contentPrp] = "";
-				});
-			} else tokens[spacerProp] = "";
-		}
-		if (!hasExactHyphenSpacing) {
-			const hyphenSpacing = /^\s*-\s+/v;
-			tokens.description = tokens.description.replace(hyphenSpacing, "-" + "".padStart(postHyphenSpacing, " "));
-		}
-		utils.setTag(tag, tokens);
-	};
-	utils.reportJSDoc("Expected JSDoc block lines to not be aligned.", tag, fix, true);
-};
-/**
-* @param {object} cfg
-* @param {CustomSpacings} cfg.customSpacings
-* @param {string} cfg.indent
-* @param {import('comment-parser').Block} cfg.jsdoc
-* @param {import('eslint').Rule.Node & {
-*   range: [number, number]
-* }} cfg.jsdocNode
-* @param {boolean} cfg.preserveMainDescriptionPostDelimiter
-* @param {import('../iterateJsdoc.js').Report} cfg.report
-* @param {string[]} cfg.tags
-* @param {import('../iterateJsdoc.js').Utils} cfg.utils
-* @param {string} cfg.wrapIndent
-* @param {boolean} cfg.disableWrapIndent
-* @returns {void}
-*/
-const checkAlignment = ({ customSpacings, disableWrapIndent, indent, jsdoc, jsdocNode, preserveMainDescriptionPostDelimiter, report, tags, utils, wrapIndent }) => {
-	const transform = commentFlow(alignTransform_default({
-		customSpacings,
-		disableWrapIndent,
-		indent,
-		preserveMainDescriptionPostDelimiter,
-		tags,
-		wrapIndent
-	}));
-	const transformedJsdoc = transform(jsdoc);
-	const comment = "/*" + jsdocNode.value + "*/";
-	const formatted = utils.stringify(transformedJsdoc).trimStart();
-	if (comment !== formatted) report(
-		"Expected JSDoc block lines to be aligned.",
-		/** @type {import('eslint').Rule.ReportFixer} */
-		(fixer) => {
-			return fixer.replaceText(jsdocNode, formatted);
-		}
-	);
-};
-var checkLineAlignment_default = iterateJsdoc(({ context, indent, jsdoc, jsdocNode, report, utils }) => {
-	const { customSpacings, disableWrapIndent = false, preserveMainDescriptionPostDelimiter, tags: applicableTags = [
-		"param",
-		"arg",
-		"argument",
-		"property",
-		"prop",
-		"returns",
-		"return",
-		"template"
-	], wrapIndent = "" } = context.options[1] || {};
-	if (context.options[0] === "always") {
-		if (!jsdocNode.value.includes("\n")) return;
-		checkAlignment({
-			customSpacings,
-			disableWrapIndent,
-			indent,
-			jsdoc,
-			jsdocNode,
-			preserveMainDescriptionPostDelimiter,
-			report,
-			tags: applicableTags,
-			utils,
-			wrapIndent
-		});
-		return;
-	}
-	const foundTags = utils.getPresentTags(applicableTags);
-	if (context.options[0] !== "any") for (const tag of foundTags) checkNotAlignedPerTag(utils, tag, customSpacings);
-	for (const tag of foundTags) if (tag.source.length > 1) {
-		let idx = 0;
-		for (const { tokens } of tag.source.slice(1)) {
-			idx++;
-			if (!tokens.description || tokens.type || tokens.name) continue;
-			if (!disableWrapIndent && tokens.postDelimiter.slice(1) !== wrapIndent) {
-				utils.reportJSDoc("Expected wrap indent", { line: tag.source[0].number + idx }, () => {
-					tokens.postDelimiter = tokens.postDelimiter.charAt(0) + wrapIndent;
-				});
-				return;
-			}
-		}
-	}
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Reports invalid alignment of JSDoc block lines.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-line-alignment.md#repos-sticky-header"
-		},
-		fixable: "whitespace",
-		schema: [{
-			enum: [
-				"always",
-				"never",
-				"any"
-			],
-			type: "string"
-		}, {
-			additionalProperties: false,
-			properties: {
-				customSpacings: {
-					additionalProperties: false,
-					properties: {
-						postDelimiter: { type: "integer" },
-						postHyphen: { type: "integer" },
-						postName: { type: "integer" },
-						postTag: { type: "integer" },
-						postType: { type: "integer" }
-					}
-				},
-				disableWrapIndent: { type: "boolean" },
-				preserveMainDescriptionPostDelimiter: {
-					default: false,
-					type: "boolean"
-				},
-				tags: {
-					items: { type: "string" },
-					type: "array"
-				},
-				wrapIndent: { type: "string" }
-			},
-			type: "object"
-		}],
-		type: "layout"
-	}
-});
-
-//#endregion
-export { checkLineAlignment_default as default };
-//# sourceMappingURL=checkLineAlignment.js.map

package/dist/rules/checkLineAlignment.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"checkLineAlignment.js","names":["alignTransform"],"sources":["../../src/rules/checkLineAlignment.js"],"sourcesContent":["import alignTransform from '../alignTransform.js';\nimport iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  transforms,\n} from 'comment-parser';\n\nconst {\n  flow: commentFlow,\n} = transforms;\n\n/**\n * @typedef {{\n *   postDelimiter: import('../iterateJsdoc.js').Integer,\n *   postHyphen: import('../iterateJsdoc.js').Integer,\n *   postName: import('../iterateJsdoc.js').Integer,\n *   postTag: import('../iterateJsdoc.js').Integer,\n *   postType: import('../iterateJsdoc.js').Integer,\n * }} CustomSpacings\n */\n\n/**\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {import('comment-parser').Spec & {\n *   line: import('../iterateJsdoc.js').Integer\n * }} tag\n * @param {CustomSpacings} customSpacings\n */\nconst checkNotAlignedPerTag = (utils, tag, customSpacings) => {\n  /*\n  start +\n  delimiter +\n  postDelimiter +\n  tag +\n  postTag +\n  type +\n  postType +\n  name +\n  postName +\n  description +\n  end +\n  lineEnd\n   */\n\n  /**\n   * @typedef {\"tag\"|\"type\"|\"name\"|\"description\"} ContentProp\n   */\n\n  /** @type {(\"postDelimiter\"|\"postTag\"|\"postType\"|\"postName\")[]} */\n  let spacerProps;\n  /** @type {ContentProp[]} */\n  let contentProps;\n  const mightHaveNamepath = utils.tagMightHaveNamepath(tag.tag);\n  if (mightHaveNamepath) {\n    spacerProps = [\n      'postDelimiter', 'postTag', 'postType', 'postName',\n    ];\n    contentProps = [\n      'tag', 'type', 'name', 'description',\n    ];\n  } else {\n    spacerProps = [\n      'postDelimiter', 'postTag', 'postType',\n    ];\n    contentProps = [\n      'tag', 'type', 'description',\n    ];\n  }\n\n  const {\n    tokens,\n  } = tag.source[0];\n\n  /**\n   * @param {import('../iterateJsdoc.js').Integer} idx\n   * @param {(notRet: boolean, contentProp: ContentProp) => void} [callbck]\n   */\n  const followedBySpace = (idx, callbck) => {\n    const nextIndex = idx + 1;\n\n    return spacerProps.slice(nextIndex).some((spacerProp, innerIdx) => {\n      const contentProp = contentProps[nextIndex + innerIdx];\n\n      const spacePropVal = tokens[spacerProp];\n\n      const ret = spacePropVal;\n\n      if (callbck) {\n        callbck(!ret, contentProp);\n      }\n\n      return ret && (callbck || !contentProp);\n    });\n  };\n\n  const postHyphenSpacing = customSpacings?.postHyphen ?? 1;\n  const exactHyphenSpacing = new RegExp(`^\\\\s*-\\\\s{${postHyphenSpacing},${postHyphenSpacing}}(?!\\\\s)`, 'v');\n  const hasNoHyphen = !(/^\\s*-(?!$)(?=\\s)/v).test(tokens.description);\n  const hasExactHyphenSpacing = exactHyphenSpacing.test(\n    tokens.description,\n  );\n\n  // If checking alignment on multiple lines, need to check other `source`\n  //   items\n  // Go through `post*` spacing properties and exit to indicate problem if\n  //   extra spacing detected\n  const ok = !spacerProps.some((spacerProp, idx) => {\n    const contentProp = contentProps[idx];\n    const contentPropVal = tokens[contentProp];\n    const spacerPropVal = tokens[spacerProp];\n    const spacing = customSpacings?.[spacerProp] || 1;\n\n    // There will be extra alignment if...\n\n    // 1. The spaces don't match the space it should have (1 or custom spacing) OR\n    return spacerPropVal.length !== spacing && spacerPropVal.length !== 0 ||\n\n      // 2. There is a (single) space, no immediate content, and yet another\n      //     space is found subsequently (not separated by intervening content)\n      spacerPropVal && !contentPropVal && followedBySpace(idx);\n  }) && (hasNoHyphen || hasExactHyphenSpacing);\n  if (ok) {\n    return;\n  }\n\n  const fix = () => {\n    for (const [\n      idx,\n      spacerProp,\n    ] of spacerProps.entries()) {\n      const contentProp = contentProps[idx];\n      const contentPropVal = tokens[contentProp];\n\n      if (contentPropVal) {\n        const spacing = customSpacings?.[spacerProp] || 1;\n        tokens[spacerProp] = ''.padStart(spacing, ' ');\n        followedBySpace(idx, (hasSpace, contentPrp) => {\n          if (hasSpace) {\n            tokens[contentPrp] = '';\n          }\n        });\n      } else {\n        tokens[spacerProp] = '';\n      }\n    }\n\n    if (!hasExactHyphenSpacing) {\n      const hyphenSpacing = /^\\s*-\\s+/v;\n      tokens.description = tokens.description.replace(\n        hyphenSpacing, '-' + ''.padStart(postHyphenSpacing, ' '),\n      );\n    }\n\n    utils.setTag(tag, tokens);\n  };\n\n  utils.reportJSDoc('Expected JSDoc block lines to not be aligned.', tag, fix, true);\n};\n\n/**\n * @param {object} cfg\n * @param {CustomSpacings} cfg.customSpacings\n * @param {string} cfg.indent\n * @param {import('comment-parser').Block} cfg.jsdoc\n * @param {import('eslint').Rule.Node & {\n *   range: [number, number]\n * }} cfg.jsdocNode\n * @param {boolean} cfg.preserveMainDescriptionPostDelimiter\n * @param {import('../iterateJsdoc.js').Report} cfg.report\n * @param {string[]} cfg.tags\n * @param {import('../iterateJsdoc.js').Utils} cfg.utils\n * @param {string} cfg.wrapIndent\n * @param {boolean} cfg.disableWrapIndent\n * @returns {void}\n */\nconst checkAlignment = ({\n  customSpacings,\n  disableWrapIndent,\n  indent,\n  jsdoc,\n  jsdocNode,\n  preserveMainDescriptionPostDelimiter,\n  report,\n  tags,\n  utils,\n  wrapIndent,\n}) => {\n  const transform = commentFlow(\n    alignTransform({\n      customSpacings,\n      disableWrapIndent,\n      indent,\n      preserveMainDescriptionPostDelimiter,\n      tags,\n      wrapIndent,\n    }),\n  );\n  const transformedJsdoc = transform(jsdoc);\n\n  const comment = '/*' +\n  /**\n   * @type {import('eslint').Rule.Node & {\n   *   range: [number, number], value: string\n   * }}\n   */ (jsdocNode).value + '*/';\n\n  const formatted = utils.stringify(transformedJsdoc)\n    .trimStart();\n\n  if (comment !== formatted) {\n    report(\n      'Expected JSDoc block lines to be aligned.',\n      /** @type {import('eslint').Rule.ReportFixer} */ (fixer) => {\n        return fixer.replaceText(jsdocNode, formatted);\n      },\n    );\n  }\n};\n\nexport default iterateJsdoc(({\n  context,\n  indent,\n  jsdoc,\n  jsdocNode,\n  report,\n  utils,\n}) => {\n  const {\n    customSpacings,\n    disableWrapIndent = false,\n    preserveMainDescriptionPostDelimiter,\n    tags: applicableTags = [\n      'param', 'arg', 'argument', 'property', 'prop', 'returns', 'return', 'template',\n    ],\n    wrapIndent = '',\n  } = context.options[1] || {};\n\n  if (context.options[0] === 'always') {\n    // Skip if it contains only a single line.\n    if (!(\n      /**\n       * @type {import('eslint').Rule.Node & {\n       *   range: [number, number], value: string\n       * }}\n       */\n      (jsdocNode).value.includes('\\n')\n    )) {\n      return;\n    }\n\n    checkAlignment({\n      customSpacings,\n      disableWrapIndent,\n      indent,\n      jsdoc,\n      jsdocNode,\n      preserveMainDescriptionPostDelimiter,\n      report,\n      tags: applicableTags,\n      utils,\n      wrapIndent,\n    });\n\n    return;\n  }\n\n  const foundTags = utils.getPresentTags(applicableTags);\n  if (context.options[0] !== 'any') {\n    for (const tag of foundTags) {\n      checkNotAlignedPerTag(\n        utils,\n        /**\n         * @type {import('comment-parser').Spec & {\n         *   line: import('../iterateJsdoc.js').Integer\n         * }}\n         */\n        (tag),\n        customSpacings,\n      );\n    }\n  }\n\n  for (const tag of foundTags) {\n    if (tag.source.length > 1) {\n      let idx = 0;\n      for (const {\n        tokens,\n      // Avoid the tag line\n      } of tag.source.slice(1)) {\n        idx++;\n\n        if (\n          !tokens.description ||\n          // Avoid first lines after multiline type\n          tokens.type ||\n          tokens.name\n        ) {\n          continue;\n        }\n\n        // Don't include a single separating space/tab\n        if (!disableWrapIndent && tokens.postDelimiter.slice(1) !== wrapIndent) {\n          utils.reportJSDoc('Expected wrap indent', {\n            line: tag.source[0].number + idx,\n          }, () => {\n            tokens.postDelimiter = tokens.postDelimiter.charAt(0) + wrapIndent;\n          });\n          return;\n        }\n      }\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Reports invalid alignment of JSDoc block lines.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-line-alignment.md#repos-sticky-header',\n    },\n    fixable: 'whitespace',\n    schema: [\n      {\n        enum: [\n          'always', 'never', 'any',\n        ],\n        type: 'string',\n      },\n      {\n        additionalProperties: false,\n        properties: {\n          customSpacings: {\n            additionalProperties: false,\n            properties: {\n              postDelimiter: {\n                type: 'integer',\n              },\n              postHyphen: {\n                type: 'integer',\n              },\n              postName: {\n                type: 'integer',\n              },\n              postTag: {\n                type: 'integer',\n              },\n              postType: {\n                type: 'integer',\n              },\n            },\n          },\n          disableWrapIndent: {\n            type: 'boolean',\n          },\n          preserveMainDescriptionPostDelimiter: {\n            default: false,\n            type: 'boolean',\n          },\n          tags: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          wrapIndent: {\n            type: 'string',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'layout',\n  },\n});\n"],"mappings":";;;;;AAMA,MAAM,EACJ,MAAM,aACP,GAAG;;;;;;;;;;;;;;;;;AAmBJ,MAAM,wBAAwB,CAAC,OAAO,KAAK,mBAAmB;;;;;CAqB5D,IAAI;;CAEJ,IAAI;CACJ,MAAM,oBAAoB,MAAM,qBAAqB,IAAI,IAAI;AAC7D,KAAI,mBAAmB;EACrB,cAAc;GACZ;GAAiB;GAAW;GAAY;EACzC;EACD,eAAe;GACb;GAAO;GAAQ;GAAQ;EACxB;CACF,OAAM;EACL,cAAc;GACZ;GAAiB;GAAW;EAC7B;EACD,eAAe;GACb;GAAO;GAAQ;EAChB;CACF;CAED,MAAM,EACJ,QACD,GAAG,IAAI,OAAO;;;;;CAMf,MAAM,kBAAkB,CAAC,KAAK,YAAY;EACxC,MAAM,YAAY,MAAM;AAExB,SAAO,YAAY,MAAM,UAAU,CAAC,KAAK,CAAC,YAAY,aAAa;GACjE,MAAM,cAAc,aAAa,YAAY;GAE7C,MAAM,eAAe,OAAO;GAE5B,MAAM,MAAM;AAEZ,OAAI,SACF,QAAQ,CAAC,KAAK,YAAY;AAG5B,UAAO,QAAQ,WAAW,CAAC;EAC5B,EAAC;CACH;CAED,MAAM,oBAAoB,gBAAgB,cAAc;CACxD,MAAM,qBAAqB,IAAI,OAAO,CAAC,UAAU,EAAE,kBAAkB,CAAC,EAAE,kBAAkB,QAAQ,CAAC,EAAE;CACrG,MAAM,cAAc,CAAE,oBAAqB,KAAK,OAAO,YAAY;CACnE,MAAM,wBAAwB,mBAAmB,KAC/C,OAAO,YACR;CAMD,MAAM,KAAK,CAAC,YAAY,KAAK,CAAC,YAAY,QAAQ;EAChD,MAAM,cAAc,aAAa;EACjC,MAAM,iBAAiB,OAAO;EAC9B,MAAM,gBAAgB,OAAO;EAC7B,MAAM,UAAU,iBAAiB,eAAe;AAKhD,SAAO,cAAc,WAAW,WAAW,cAAc,WAAW,KAIlE,iBAAiB,CAAC,kBAAkB,gBAAgB,IAAI;CAC3D,EAAC,KAAK,eAAe;AACtB,KAAI,GACF;CAGF,MAAM,MAAM,MAAM;AAChB,OAAK,MAAM,CACT,KACA,WACD,IAAI,YAAY,SAAS,EAAE;GAC1B,MAAM,cAAc,aAAa;GACjC,MAAM,iBAAiB,OAAO;AAE9B,OAAI,gBAAgB;IAClB,MAAM,UAAU,iBAAiB,eAAe;IAChD,OAAO,cAAc,GAAG,SAAS,SAAS,IAAI;IAC9C,gBAAgB,KAAK,CAAC,UAAU,eAAe;AAC7C,SAAI,UACF,OAAO,cAAc;IAExB,EAAC;GACH,OACC,OAAO,cAAc;EAExB;AAED,MAAI,CAAC,uBAAuB;GAC1B,MAAM,gBAAgB;GACtB,OAAO,cAAc,OAAO,YAAY,QACtC,eAAe,MAAM,GAAG,SAAS,mBAAmB,IAAI,CACzD;EACF;EAED,MAAM,OAAO,KAAK,OAAO;CAC1B;CAED,MAAM,YAAY,iDAAiD,KAAK,KAAK,KAAK;AACnF;;;;;;;;;;;;;;;;;AAkBD,MAAM,iBAAiB,CAAC,EACtB,gBACA,mBACA,QACA,OACA,WACA,sCACA,QACA,MACA,OACA,YACD,KAAK;CACJ,MAAM,YAAY,YAChBA,uBAAe;EACb;EACA;EACA;EACA;EACA;EACA;CACD,EAAC,CACH;CACD,MAAM,mBAAmB,UAAU,MAAM;CAEzC,MAAM,UAAU,OAKX,UAAW,QAAQ;CAExB,MAAM,YAAY,MAAM,UAAU,iBAAiB,CAChD,WAAW;AAEd,KAAI,YAAY,WACd;EACE;;EACiD,CAAC,UAAU;AAC1D,UAAO,MAAM,YAAY,WAAW,UAAU;EAC/C;EACF;AAEJ;AAED,iCAAe,aAAa,CAAC,EAC3B,SACA,QACA,OACA,WACA,QACA,OACD,KAAK;CACJ,MAAM,EACJ,gBACA,oBAAoB,OACpB,sCACA,MAAM,iBAAiB;EACrB;EAAS;EAAO;EAAY;EAAY;EAAQ;EAAW;EAAU;CACtE,GACD,aAAa,IACd,GAAG,QAAQ,QAAQ,MAAM,CAAE;AAE5B,KAAI,QAAQ,QAAQ,OAAO,UAAU;AAEnC,MAAI,CAMD,UAAW,MAAM,SAAS,KAAK,CAEhC;EAGF,eAAe;GACb;GACA;GACA;GACA;GACA;GACA;GACA;GACA,MAAM;GACN;GACA;EACD,EAAC;AAEF;CACD;CAED,MAAM,YAAY,MAAM,eAAe,eAAe;AACtD,KAAI,QAAQ,QAAQ,OAAO,MACzB,MAAK,MAAM,OAAO,WAChB,sBACE,OAMC,KACD,eACD;AAIL,MAAK,MAAM,OAAO,UAChB,KAAI,IAAI,OAAO,SAAS,GAAG;EACzB,IAAI,MAAM;AACV,OAAK,MAAM,EACT,QAED,IAAI,IAAI,OAAO,MAAM,EAAE,EAAE;GACxB;AAEA,OACE,CAAC,OAAO,eAER,OAAO,QACP,OAAO,KAEP;AAIF,OAAI,CAAC,qBAAqB,OAAO,cAAc,MAAM,EAAE,KAAK,YAAY;IACtE,MAAM,YAAY,wBAAwB,EACxC,MAAM,IAAI,OAAO,GAAG,SAAS,IAC9B,GAAE,MAAM;KACP,OAAO,gBAAgB,OAAO,cAAc,OAAO,EAAE,GAAG;IACzD,EAAC;AACF;GACD;EACF;CACF;AAEJ,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,MAAM;IACJ;IAAU;IAAS;GACpB;GACD,MAAM;EACP,GACD;GACE,sBAAsB;GACtB,YAAY;IACV,gBAAgB;KACd,sBAAsB;KACtB,YAAY;MACV,eAAe,EACb,MAAM,UACP;MACD,YAAY,EACV,MAAM,UACP;MACD,UAAU,EACR,MAAM,UACP;MACD,SAAS,EACP,MAAM,UACP;MACD,UAAU,EACR,MAAM,UACP;KACF;IACF;IACD,mBAAmB,EACjB,MAAM,UACP;IACD,sCAAsC;KACpC,SAAS;KACT,MAAM;IACP;IACD,MAAM;KACJ,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,YAAY,EACV,MAAM,SACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/checkParamNames.js

@@ -1,237 +0,0 @@
-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