eslint-plugin-jsdoc 52.0.4 → 53.0.0

package/dist/rules/multilineBlocks.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"multilineBlocks.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","checkForShortTags","jsdoc","utils","requireSingleLineUnderCount","tags","length","lastLineWithTag","isUnderCountLimit","hasMultiDescOrType","tagLines","source","reduce","acc","tokens","delimiter","description","desc","name","postDelimiter","postName","postTag","postType","start","tag","type","idx","fixer","number","seedTokens","trimEnd","end","reportJSDoc","checkForShortDescriptions","lastLineWithDesc","descLines","_default","exports","iterateJsdoc","context","allowMultipleTags","minimumLengthForMultiline","Number","POSITIVE_INFINITY","multilineTags","noFinalLineText","noMultilineBlocks","noSingleLineBlocks","noZeroLineText","singleLineTags","options","sourceLength","isInvalidSingleLine","tagName","includes","slice","makeMultiline","lineChecks","line","emptyTokens","addLine","finalLine","finalLineTokens","trim","prop","hasATag","filterTags","tg","obj","lineEnd","nme","typ","nameOrDescription","iterateAllJsdocs","meta","docs","url","fixable","schema","additionalProperties","properties","anyOf","enum","items","module"],"sources":["../../src/rules/multilineBlocks.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {import('@es-joy/jsdoccomment').JsdocBlockWithInline} jsdoc\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {number} requireSingleLineUnderCount\n */\nconst checkForShortTags = (jsdoc, utils, requireSingleLineUnderCount) => {\n  if (!requireSingleLineUnderCount || !jsdoc.tags.length) {\n    return false;\n  }\n\n  let lastLineWithTag = 0;\n  let isUnderCountLimit = false;\n  let hasMultiDescOrType = false;\n  const tagLines = jsdoc.source.reduce((acc, {\n    tokens: {\n      delimiter,\n      description: desc,\n      name,\n      postDelimiter,\n      postName,\n      postTag,\n      postType,\n      start,\n      tag,\n      type,\n    },\n  }, idx) => {\n    if (tag.length) {\n      lastLineWithTag = idx;\n      if (\n        start.length + delimiter.length + postDelimiter.length +\n        type.length + postType.length + name.length + postName.length +\n        tag.length + postTag.length + desc.length <\n          requireSingleLineUnderCount\n      ) {\n        isUnderCountLimit = true;\n      }\n\n      return acc + 1;\n    } else if (desc.length || type.length) {\n      hasMultiDescOrType = true;\n      return acc;\n    }\n\n    return acc;\n  }, 0);\n  // Could be tagLines > 1\n  if (!hasMultiDescOrType && isUnderCountLimit && tagLines === 1) {\n    const fixer = () => {\n      const tokens = jsdoc.source[lastLineWithTag].tokens;\n      jsdoc.source = [\n        {\n          number: 0,\n          source: '',\n          tokens: utils.seedTokens({\n            delimiter: '/**',\n            description: tokens.description.trimEnd() + ' ',\n            end: '*/',\n            name: tokens.name,\n            postDelimiter: ' ',\n            postName: tokens.postName,\n            postTag: tokens.postTag,\n            postType: tokens.postType,\n            start: jsdoc.source[0].tokens.start,\n            tag: tokens.tag,\n            type: tokens.type,\n          }),\n        },\n      ];\n    };\n\n    utils.reportJSDoc(\n      'Description is too short to be multi-line.',\n      null,\n      fixer,\n    );\n    return true;\n  }\n\n  return false;\n};\n\n/**\n * @param {import('@es-joy/jsdoccomment').JsdocBlockWithInline} jsdoc\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {number} requireSingleLineUnderCount\n */\nconst checkForShortDescriptions = (jsdoc, utils, requireSingleLineUnderCount) => {\n  if (!requireSingleLineUnderCount || jsdoc.tags.length) {\n    return false;\n  }\n\n  let lastLineWithDesc = 0;\n  let isUnderCountLimit = false;\n  const descLines = jsdoc.source.reduce((acc, {\n    tokens: {\n      delimiter,\n      description: desc,\n      postDelimiter,\n      start,\n    },\n  }, idx) => {\n    if (desc.length) {\n      lastLineWithDesc = idx;\n      if (\n        start.length + delimiter.length + postDelimiter.length + desc.length <\n          requireSingleLineUnderCount\n      ) {\n        isUnderCountLimit = true;\n      }\n\n      return acc + 1;\n    }\n\n    return acc;\n  }, 0);\n  // Could be descLines > 1\n  if (isUnderCountLimit && descLines === 1) {\n    const fixer = () => {\n      const desc = jsdoc.source[lastLineWithDesc].tokens.description;\n      jsdoc.source = [\n        {\n          number: 0,\n          source: '',\n          tokens: utils.seedTokens({\n            delimiter: '/**',\n            description: desc.trimEnd() + ' ',\n            end: '*/',\n            postDelimiter: ' ',\n            start: jsdoc.source[0].tokens.start,\n          }),\n        },\n      ];\n    };\n\n    utils.reportJSDoc(\n      'Description is too short to be multi-line.',\n      null,\n      fixer,\n    );\n    return true;\n  }\n\n  return false;\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  const {\n    allowMultipleTags = true,\n    minimumLengthForMultiline = Number.POSITIVE_INFINITY,\n    multilineTags = [\n      '*',\n    ],\n    noFinalLineText = true,\n    noMultilineBlocks = false,\n    noSingleLineBlocks = false,\n    noZeroLineText = true,\n    requireSingleLineUnderCount = null,\n    singleLineTags = [\n      'lends', 'type',\n    ],\n  } = context.options[0] || {};\n\n  const {\n    source: [\n      {\n        tokens,\n      },\n    ],\n  } = jsdoc;\n  const {\n    description,\n    tag,\n  } = tokens;\n  const sourceLength = jsdoc.source.length;\n\n  /**\n   * @param {string} tagName\n   * @returns {boolean}\n   */\n  const isInvalidSingleLine = (tagName) => {\n    return noSingleLineBlocks &&\n      (!tagName ||\n      !singleLineTags.includes(tagName) && !singleLineTags.includes('*'));\n  };\n\n  if (sourceLength === 1) {\n    if (!isInvalidSingleLine(tag.slice(1))) {\n      return;\n    }\n\n    const fixer = () => {\n      utils.makeMultiline();\n    };\n\n    utils.reportJSDoc(\n      'Single line blocks are not permitted by your configuration.',\n      null,\n      fixer,\n      true,\n    );\n\n    return;\n  }\n\n  if (checkForShortDescriptions(jsdoc, utils, requireSingleLineUnderCount)\n  ) {\n    return;\n  }\n\n  if (checkForShortTags(jsdoc, utils, requireSingleLineUnderCount)\n  ) {\n    return;\n  }\n\n  const lineChecks = () => {\n    if (\n      noZeroLineText &&\n      (tag || description)\n    ) {\n      const fixer = () => {\n        const line = {\n          ...tokens,\n        };\n        utils.emptyTokens(tokens);\n        const {\n          tokens: {\n            delimiter,\n            start,\n          },\n        } = jsdoc.source[1];\n        utils.addLine(1, {\n          ...line,\n          delimiter,\n          start,\n        });\n      };\n\n      utils.reportJSDoc(\n        'Should have no text on the \"0th\" line (after the `/**`).',\n        null,\n        fixer,\n      );\n\n      return;\n    }\n\n    const finalLine = jsdoc.source[jsdoc.source.length - 1];\n    const finalLineTokens = finalLine.tokens;\n    if (\n      noFinalLineText &&\n      finalLineTokens.description.trim()\n    ) {\n      const fixer = () => {\n        const line = {\n          ...finalLineTokens,\n        };\n        line.description = line.description.trimEnd();\n\n        const {\n          delimiter,\n        } = line;\n\n        for (const prop of [\n          'delimiter',\n          'postDelimiter',\n          'tag',\n          'type',\n          'lineEnd',\n          'postType',\n          'postTag',\n          'name',\n          'postName',\n          'description',\n        ]) {\n          finalLineTokens[\n            /**\n             * @type {\"delimiter\"|\"postDelimiter\"|\"tag\"|\"type\"|\n             *   \"lineEnd\"|\"postType\"|\"postTag\"|\"name\"|\n             *   \"postName\"|\"description\"}\n             */ (\n              prop\n            )\n          ] = '';\n        }\n\n        utils.addLine(jsdoc.source.length - 1, {\n          ...line,\n          delimiter,\n          end: '',\n        });\n      };\n\n      utils.reportJSDoc(\n        'Should have no text on the final line (before the `*/`).',\n        null,\n        fixer,\n      );\n    }\n  };\n\n  if (noMultilineBlocks) {\n    if (\n      jsdoc.tags.length &&\n      (multilineTags.includes('*') || utils.hasATag(multilineTags))\n    ) {\n      lineChecks();\n\n      return;\n    }\n\n    if (jsdoc.description.length >= minimumLengthForMultiline) {\n      lineChecks();\n\n      return;\n    }\n\n    if (\n      noSingleLineBlocks &&\n      (!jsdoc.tags.length ||\n      !utils.filterTags(({\n        tag: tg,\n      }) => {\n        return !isInvalidSingleLine(tg);\n      }).length)\n    ) {\n      utils.reportJSDoc(\n        'Multiline jsdoc blocks are prohibited by ' +\n          'your configuration but fixing would result in a single ' +\n          'line block which you have prohibited with `noSingleLineBlocks`.',\n      );\n\n      return;\n    }\n\n    if (jsdoc.tags.length > 1) {\n      if (!allowMultipleTags) {\n        utils.reportJSDoc(\n          'Multiline jsdoc blocks are prohibited by ' +\n            'your configuration but the block has multiple tags.',\n        );\n\n        return;\n      }\n    } else if (jsdoc.tags.length === 1 && jsdoc.description.trim()) {\n      if (!allowMultipleTags) {\n        utils.reportJSDoc(\n          'Multiline jsdoc blocks are prohibited by ' +\n            'your configuration but the block has a description with a tag.',\n        );\n\n        return;\n      }\n    } else {\n      const fixer = () => {\n        jsdoc.source = [\n          {\n            number: 1,\n            source: '',\n            tokens: jsdoc.source.reduce((obj, {\n              tokens: {\n                description: desc,\n                lineEnd,\n                name: nme,\n                postName,\n                postTag,\n                postType,\n                tag: tg,\n                type: typ,\n              },\n            }) => {\n              if (typ) {\n                obj.type = typ;\n              }\n\n              if (tg && typ && nme) {\n                obj.postType = postType;\n              }\n\n              if (nme) {\n                obj.name += nme;\n              }\n\n              if (nme && desc) {\n                obj.postName = postName;\n              }\n\n              obj.description += desc;\n\n              const nameOrDescription = obj.description || obj.name;\n              if (\n                nameOrDescription && nameOrDescription.slice(-1) !== ' '\n              ) {\n                obj.description += ' ';\n              }\n\n              obj.lineEnd = lineEnd;\n\n              // Already filtered for multiple tags\n              obj.tag += tg;\n              if (tg) {\n                obj.postTag = postTag || ' ';\n              }\n\n              return obj;\n            }, utils.seedTokens({\n              delimiter: '/**',\n              end: '*/',\n              postDelimiter: ' ',\n            })),\n          },\n        ];\n      };\n\n      utils.reportJSDoc(\n        'Multiline jsdoc blocks are prohibited by ' +\n          'your configuration.',\n        null,\n        fixer,\n      );\n\n      return;\n    }\n  }\n\n  lineChecks();\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Controls how and whether jsdoc blocks can be expressed as single or multiple line blocks.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/multiline-blocks.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          allowMultipleTags: {\n            type: 'boolean',\n          },\n          minimumLengthForMultiline: {\n            type: 'integer',\n          },\n          multilineTags: {\n            anyOf: [\n              {\n                enum: [\n                  '*',\n                ],\n                type: 'string',\n              }, {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n            ],\n          },\n          noFinalLineText: {\n            type: 'boolean',\n          },\n          noMultilineBlocks: {\n            type: 'boolean',\n          },\n          noSingleLineBlocks: {\n            type: 'boolean',\n          },\n          noZeroLineText: {\n            type: 'boolean',\n          },\n          requireSingleLineUnderCount: {\n            type: 'number',\n          },\n          singleLineTags: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE9C;AACA;AACA;AACA;AACA;AACA,MAAMG,iBAAiB,GAAGA,CAACC,KAAK,EAAEC,KAAK,EAAEC,2BAA2B,KAAK;EACvE,IAAI,CAACA,2BAA2B,IAAI,CAACF,KAAK,CAACG,IAAI,CAACC,MAAM,EAAE;IACtD,OAAO,KAAK;EACd;EAEA,IAAIC,eAAe,GAAG,CAAC;EACvB,IAAIC,iBAAiB,GAAG,KAAK;EAC7B,IAAIC,kBAAkB,GAAG,KAAK;EAC9B,MAAMC,QAAQ,GAAGR,KAAK,CAACS,MAAM,CAACC,MAAM,CAAC,CAACC,GAAG,EAAE;IACzCC,MAAM,EAAE;MACNC,SAAS;MACTC,WAAW,EAAEC,IAAI;MACjBC,IAAI;MACJC,aAAa;MACbC,QAAQ;MACRC,OAAO;MACPC,QAAQ;MACRC,KAAK;MACLC,GAAG;MACHC;IACF;EACF,CAAC,EAAEC,GAAG,KAAK;IACT,IAAIF,GAAG,CAAClB,MAAM,EAAE;MACdC,eAAe,GAAGmB,GAAG;MACrB,IACEH,KAAK,CAACjB,MAAM,GAAGS,SAAS,CAACT,MAAM,GAAGa,aAAa,CAACb,MAAM,GACtDmB,IAAI,CAACnB,MAAM,GAAGgB,QAAQ,CAAChB,MAAM,GAAGY,IAAI,CAACZ,MAAM,GAAGc,QAAQ,CAACd,MAAM,GAC7DkB,GAAG,CAAClB,MAAM,GAAGe,OAAO,CAACf,MAAM,GAAGW,IAAI,CAACX,MAAM,GACvCF,2BAA2B,EAC7B;QACAI,iBAAiB,GAAG,IAAI;MAC1B;MAEA,OAAOK,GAAG,GAAG,CAAC;IAChB,CAAC,MAAM,IAAII,IAAI,CAACX,MAAM,IAAImB,IAAI,CAACnB,MAAM,EAAE;MACrCG,kBAAkB,GAAG,IAAI;MACzB,OAAOI,GAAG;IACZ;IAEA,OAAOA,GAAG;EACZ,CAAC,EAAE,CAAC,CAAC;EACL;EACA,IAAI,CAACJ,kBAAkB,IAAID,iBAAiB,IAAIE,QAAQ,KAAK,CAAC,EAAE;IAC9D,MAAMiB,KAAK,GAAGA,CAAA,KAAM;MAClB,MAAMb,MAAM,GAAGZ,KAAK,CAACS,MAAM,CAACJ,eAAe,CAAC,CAACO,MAAM;MACnDZ,KAAK,CAACS,MAAM,GAAG,CACb;QACEiB,MAAM,EAAE,CAAC;QACTjB,MAAM,EAAE,EAAE;QACVG,MAAM,EAAEX,KAAK,CAAC0B,UAAU,CAAC;UACvBd,SAAS,EAAE,KAAK;UAChBC,WAAW,EAAEF,MAAM,CAACE,WAAW,CAACc,OAAO,CAAC,CAAC,GAAG,GAAG;UAC/CC,GAAG,EAAE,IAAI;UACTb,IAAI,EAAEJ,MAAM,CAACI,IAAI;UACjBC,aAAa,EAAE,GAAG;UAClBC,QAAQ,EAAEN,MAAM,CAACM,QAAQ;UACzBC,OAAO,EAAEP,MAAM,CAACO,OAAO;UACvBC,QAAQ,EAAER,MAAM,CAACQ,QAAQ;UACzBC,KAAK,EAAErB,KAAK,CAACS,MAAM,CAAC,CAAC,CAAC,CAACG,MAAM,CAACS,KAAK;UACnCC,GAAG,EAAEV,MAAM,CAACU,GAAG;UACfC,IAAI,EAAEX,MAAM,CAACW;QACf,CAAC;MACH,CAAC,CACF;IACH,CAAC;IAEDtB,KAAK,CAAC6B,WAAW,CACf,4CAA4C,EAC5C,IAAI,EACJL,KACF,CAAC;IACD,OAAO,IAAI;EACb;EAEA,OAAO,KAAK;AACd,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAMM,yBAAyB,GAAGA,CAAC/B,KAAK,EAAEC,KAAK,EAAEC,2BAA2B,KAAK;EAC/E,IAAI,CAACA,2BAA2B,IAAIF,KAAK,CAACG,IAAI,CAACC,MAAM,EAAE;IACrD,OAAO,KAAK;EACd;EAEA,IAAI4B,gBAAgB,GAAG,CAAC;EACxB,IAAI1B,iBAAiB,GAAG,KAAK;EAC7B,MAAM2B,SAAS,GAAGjC,KAAK,CAACS,MAAM,CAACC,MAAM,CAAC,CAACC,GAAG,EAAE;IAC1CC,MAAM,EAAE;MACNC,SAAS;MACTC,WAAW,EAAEC,IAAI;MACjBE,aAAa;MACbI;IACF;EACF,CAAC,EAAEG,GAAG,KAAK;IACT,IAAIT,IAAI,CAACX,MAAM,EAAE;MACf4B,gBAAgB,GAAGR,GAAG;MACtB,IACEH,KAAK,CAACjB,MAAM,GAAGS,SAAS,CAACT,MAAM,GAAGa,aAAa,CAACb,MAAM,GAAGW,IAAI,CAACX,MAAM,GAClEF,2BAA2B,EAC7B;QACAI,iBAAiB,GAAG,IAAI;MAC1B;MAEA,OAAOK,GAAG,GAAG,CAAC;IAChB;IAEA,OAAOA,GAAG;EACZ,CAAC,EAAE,CAAC,CAAC;EACL;EACA,IAAIL,iBAAiB,IAAI2B,SAAS,KAAK,CAAC,EAAE;IACxC,MAAMR,KAAK,GAAGA,CAAA,KAAM;MAClB,MAAMV,IAAI,GAAGf,KAAK,CAACS,MAAM,CAACuB,gBAAgB,CAAC,CAACpB,MAAM,CAACE,WAAW;MAC9Dd,KAAK,CAACS,MAAM,GAAG,CACb;QACEiB,MAAM,EAAE,CAAC;QACTjB,MAAM,EAAE,EAAE;QACVG,MAAM,EAAEX,KAAK,CAAC0B,UAAU,CAAC;UACvBd,SAAS,EAAE,KAAK;UAChBC,WAAW,EAAEC,IAAI,CAACa,OAAO,CAAC,CAAC,GAAG,GAAG;UACjCC,GAAG,EAAE,IAAI;UACTZ,aAAa,EAAE,GAAG;UAClBI,KAAK,EAAErB,KAAK,CAACS,MAAM,CAAC,CAAC,CAAC,CAACG,MAAM,CAACS;QAChC,CAAC;MACH,CAAC,CACF;IACH,CAAC;IAEDpB,KAAK,CAAC6B,WAAW,CACf,4CAA4C,EAC5C,IAAI,EACJL,KACF,CAAC;IACD,OAAO,IAAI;EACb;EAEA,OAAO,KAAK;AACd,CAAC;AAAC,IAAAS,QAAA,GAAAC,OAAA,CAAArC,OAAA,GAEa,IAAAsC,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPrC,KAAK;EACLC;AACF,CAAC,KAAK;EACJ,MAAM;IACJqC,iBAAiB,GAAG,IAAI;IACxBC,yBAAyB,GAAGC,MAAM,CAACC,iBAAiB;IACpDC,aAAa,GAAG,CACd,GAAG,CACJ;IACDC,eAAe,GAAG,IAAI;IACtBC,iBAAiB,GAAG,KAAK;IACzBC,kBAAkB,GAAG,KAAK;IAC1BC,cAAc,GAAG,IAAI;IACrB5C,2BAA2B,GAAG,IAAI;IAClC6C,cAAc,GAAG,CACf,OAAO,EAAE,MAAM;EAEnB,CAAC,GAAGV,OAAO,CAACW,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,MAAM;IACJvC,MAAM,EAAE,CACN;MACEG;IACF,CAAC;EAEL,CAAC,GAAGZ,KAAK;EACT,MAAM;IACJc,WAAW;IACXQ;EACF,CAAC,GAAGV,MAAM;EACV,MAAMqC,YAAY,GAAGjD,KAAK,CAACS,MAAM,CAACL,MAAM;;EAExC;AACF;AACA;AACA;EACE,MAAM8C,mBAAmB,GAAIC,OAAO,IAAK;IACvC,OAAON,kBAAkB,KACtB,CAACM,OAAO,IACT,CAACJ,cAAc,CAACK,QAAQ,CAACD,OAAO,CAAC,IAAI,CAACJ,cAAc,CAACK,QAAQ,CAAC,GAAG,CAAC,CAAC;EACvE,CAAC;EAED,IAAIH,YAAY,KAAK,CAAC,EAAE;IACtB,IAAI,CAACC,mBAAmB,CAAC5B,GAAG,CAAC+B,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;MACtC;IACF;IAEA,MAAM5B,KAAK,GAAGA,CAAA,KAAM;MAClBxB,KAAK,CAACqD,aAAa,CAAC,CAAC;IACvB,CAAC;IAEDrD,KAAK,CAAC6B,WAAW,CACf,6DAA6D,EAC7D,IAAI,EACJL,KAAK,EACL,IACF,CAAC;IAED;EACF;EAEA,IAAIM,yBAAyB,CAAC/B,KAAK,EAAEC,KAAK,EAAEC,2BAA2B,CAAC,EACtE;IACA;EACF;EAEA,IAAIH,iBAAiB,CAACC,KAAK,EAAEC,KAAK,EAAEC,2BAA2B,CAAC,EAC9D;IACA;EACF;EAEA,MAAMqD,UAAU,GAAGA,CAAA,KAAM;IACvB,IACET,cAAc,KACbxB,GAAG,IAAIR,WAAW,CAAC,EACpB;MACA,MAAMW,KAAK,GAAGA,CAAA,KAAM;QAClB,MAAM+B,IAAI,GAAG;UACX,GAAG5C;QACL,CAAC;QACDX,KAAK,CAACwD,WAAW,CAAC7C,MAAM,CAAC;QACzB,MAAM;UACJA,MAAM,EAAE;YACNC,SAAS;YACTQ;UACF;QACF,CAAC,GAAGrB,KAAK,CAACS,MAAM,CAAC,CAAC,CAAC;QACnBR,KAAK,CAACyD,OAAO,CAAC,CAAC,EAAE;UACf,GAAGF,IAAI;UACP3C,SAAS;UACTQ;QACF,CAAC,CAAC;MACJ,CAAC;MAEDpB,KAAK,CAAC6B,WAAW,CACf,0DAA0D,EAC1D,IAAI,EACJL,KACF,CAAC;MAED;IACF;IAEA,MAAMkC,SAAS,GAAG3D,KAAK,CAACS,MAAM,CAACT,KAAK,CAACS,MAAM,CAACL,MAAM,GAAG,CAAC,CAAC;IACvD,MAAMwD,eAAe,GAAGD,SAAS,CAAC/C,MAAM;IACxC,IACE+B,eAAe,IACfiB,eAAe,CAAC9C,WAAW,CAAC+C,IAAI,CAAC,CAAC,EAClC;MACA,MAAMpC,KAAK,GAAGA,CAAA,KAAM;QAClB,MAAM+B,IAAI,GAAG;UACX,GAAGI;QACL,CAAC;QACDJ,IAAI,CAAC1C,WAAW,GAAG0C,IAAI,CAAC1C,WAAW,CAACc,OAAO,CAAC,CAAC;QAE7C,MAAM;UACJf;QACF,CAAC,GAAG2C,IAAI;QAER,KAAK,MAAMM,IAAI,IAAI,CACjB,WAAW,EACX,eAAe,EACf,KAAK,EACL,MAAM,EACN,SAAS,EACT,UAAU,EACV,SAAS,EACT,MAAM,EACN,UAAU,EACV,aAAa,CACd,EAAE;UACDF,eAAe;UACb;AACZ;AACA;AACA;AACA;UACcE,IAAI,EAEP,GAAG,EAAE;QACR;QAEA7D,KAAK,CAACyD,OAAO,CAAC1D,KAAK,CAACS,MAAM,CAACL,MAAM,GAAG,CAAC,EAAE;UACrC,GAAGoD,IAAI;UACP3C,SAAS;UACTgB,GAAG,EAAE;QACP,CAAC,CAAC;MACJ,CAAC;MAED5B,KAAK,CAAC6B,WAAW,CACf,0DAA0D,EAC1D,IAAI,EACJL,KACF,CAAC;IACH;EACF,CAAC;EAED,IAAImB,iBAAiB,EAAE;IACrB,IACE5C,KAAK,CAACG,IAAI,CAACC,MAAM,KAChBsC,aAAa,CAACU,QAAQ,CAAC,GAAG,CAAC,IAAInD,KAAK,CAAC8D,OAAO,CAACrB,aAAa,CAAC,CAAC,EAC7D;MACAa,UAAU,CAAC,CAAC;MAEZ;IACF;IAEA,IAAIvD,KAAK,CAACc,WAAW,CAACV,MAAM,IAAImC,yBAAyB,EAAE;MACzDgB,UAAU,CAAC,CAAC;MAEZ;IACF;IAEA,IACEV,kBAAkB,KACjB,CAAC7C,KAAK,CAACG,IAAI,CAACC,MAAM,IACnB,CAACH,KAAK,CAAC+D,UAAU,CAAC,CAAC;MACjB1C,GAAG,EAAE2C;IACP,CAAC,KAAK;MACJ,OAAO,CAACf,mBAAmB,CAACe,EAAE,CAAC;IACjC,CAAC,CAAC,CAAC7D,MAAM,CAAC,EACV;MACAH,KAAK,CAAC6B,WAAW,CACf,2CAA2C,GACzC,yDAAyD,GACzD,iEACJ,CAAC;MAED;IACF;IAEA,IAAI9B,KAAK,CAACG,IAAI,CAACC,MAAM,GAAG,CAAC,EAAE;MACzB,IAAI,CAACkC,iBAAiB,EAAE;QACtBrC,KAAK,CAAC6B,WAAW,CACf,2CAA2C,GACzC,qDACJ,CAAC;QAED;MACF;IACF,CAAC,MAAM,IAAI9B,KAAK,CAACG,IAAI,CAACC,MAAM,KAAK,CAAC,IAAIJ,KAAK,CAACc,WAAW,CAAC+C,IAAI,CAAC,CAAC,EAAE;MAC9D,IAAI,CAACvB,iBAAiB,EAAE;QACtBrC,KAAK,CAAC6B,WAAW,CACf,2CAA2C,GACzC,gEACJ,CAAC;QAED;MACF;IACF,CAAC,MAAM;MACL,MAAML,KAAK,GAAGA,CAAA,KAAM;QAClBzB,KAAK,CAACS,MAAM,GAAG,CACb;UACEiB,MAAM,EAAE,CAAC;UACTjB,MAAM,EAAE,EAAE;UACVG,MAAM,EAAEZ,KAAK,CAACS,MAAM,CAACC,MAAM,CAAC,CAACwD,GAAG,EAAE;YAChCtD,MAAM,EAAE;cACNE,WAAW,EAAEC,IAAI;cACjBoD,OAAO;cACPnD,IAAI,EAAEoD,GAAG;cACTlD,QAAQ;cACRC,OAAO;cACPC,QAAQ;cACRE,GAAG,EAAE2C,EAAE;cACP1C,IAAI,EAAE8C;YACR;UACF,CAAC,KAAK;YACJ,IAAIA,GAAG,EAAE;cACPH,GAAG,CAAC3C,IAAI,GAAG8C,GAAG;YAChB;YAEA,IAAIJ,EAAE,IAAII,GAAG,IAAID,GAAG,EAAE;cACpBF,GAAG,CAAC9C,QAAQ,GAAGA,QAAQ;YACzB;YAEA,IAAIgD,GAAG,EAAE;cACPF,GAAG,CAAClD,IAAI,IAAIoD,GAAG;YACjB;YAEA,IAAIA,GAAG,IAAIrD,IAAI,EAAE;cACfmD,GAAG,CAAChD,QAAQ,GAAGA,QAAQ;YACzB;YAEAgD,GAAG,CAACpD,WAAW,IAAIC,IAAI;YAEvB,MAAMuD,iBAAiB,GAAGJ,GAAG,CAACpD,WAAW,IAAIoD,GAAG,CAAClD,IAAI;YACrD,IACEsD,iBAAiB,IAAIA,iBAAiB,CAACjB,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,EACxD;cACAa,GAAG,CAACpD,WAAW,IAAI,GAAG;YACxB;YAEAoD,GAAG,CAACC,OAAO,GAAGA,OAAO;;YAErB;YACAD,GAAG,CAAC5C,GAAG,IAAI2C,EAAE;YACb,IAAIA,EAAE,EAAE;cACNC,GAAG,CAAC/C,OAAO,GAAGA,OAAO,IAAI,GAAG;YAC9B;YAEA,OAAO+C,GAAG;UACZ,CAAC,EAAEjE,KAAK,CAAC0B,UAAU,CAAC;YAClBd,SAAS,EAAE,KAAK;YAChBgB,GAAG,EAAE,IAAI;YACTZ,aAAa,EAAE;UACjB,CAAC,CAAC;QACJ,CAAC,CACF;MACH,CAAC;MAEDhB,KAAK,CAAC6B,WAAW,CACf,2CAA2C,GACzC,qBAAqB,EACvB,IAAI,EACJL,KACF,CAAC;MAED;IACF;EACF;EAEA8B,UAAU,CAAC,CAAC;AACd,CAAC,EAAE;EACDgB,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJ3D,WAAW,EAAE,2FAA2F;MACxG4D,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVxC,iBAAiB,EAAE;UACjBf,IAAI,EAAE;QACR,CAAC;QACDgB,yBAAyB,EAAE;UACzBhB,IAAI,EAAE;QACR,CAAC;QACDmB,aAAa,EAAE;UACbqC,KAAK,EAAE,CACL;YACEC,IAAI,EAAE,CACJ,GAAG,CACJ;YACDzD,IAAI,EAAE;UACR,CAAC,EAAE;YACD0D,KAAK,EAAE;cACL1D,IAAI,EAAE;YACR,CAAC;YACDA,IAAI,EAAE;UACR,CAAC;QAEL,CAAC;QACDoB,eAAe,EAAE;UACfpB,IAAI,EAAE;QACR,CAAC;QACDqB,iBAAiB,EAAE;UACjBrB,IAAI,EAAE;QACR,CAAC;QACDsB,kBAAkB,EAAE;UAClBtB,IAAI,EAAE;QACR,CAAC;QACDuB,cAAc,EAAE;UACdvB,IAAI,EAAE;QACR,CAAC;QACDrB,2BAA2B,EAAE;UAC3BqB,IAAI,EAAE;QACR,CAAC;QACDwB,cAAc,EAAE;UACdkC,KAAK,EAAE;YACL1D,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA2D,MAAA,CAAA/C,OAAA,GAAAA,OAAA,CAAArC,OAAA","ignoreList":[]}
+{"version":3,"file":"multilineBlocks.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/multilineBlocks.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {import('@es-joy/jsdoccomment').JsdocBlockWithInline} jsdoc\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {number} requireSingleLineUnderCount\n */\nconst checkForShortTags = (jsdoc, utils, requireSingleLineUnderCount) => {\n  if (!requireSingleLineUnderCount || !jsdoc.tags.length) {\n    return false;\n  }\n\n  let lastLineWithTag = 0;\n  let isUnderCountLimit = false;\n  let hasMultiDescOrType = false;\n  const tagLines = jsdoc.source.reduce((acc, {\n    tokens: {\n      delimiter,\n      description: desc,\n      name,\n      postDelimiter,\n      postName,\n      postTag,\n      postType,\n      start,\n      tag,\n      type,\n    },\n  }, idx) => {\n    if (tag.length) {\n      lastLineWithTag = idx;\n      if (\n        start.length + delimiter.length + postDelimiter.length +\n        type.length + postType.length + name.length + postName.length +\n        tag.length + postTag.length + desc.length <\n          requireSingleLineUnderCount\n      ) {\n        isUnderCountLimit = true;\n      }\n\n      return acc + 1;\n    } else if (desc.length || type.length) {\n      hasMultiDescOrType = true;\n      return acc;\n    }\n\n    return acc;\n  }, 0);\n  // Could be tagLines > 1\n  if (!hasMultiDescOrType && isUnderCountLimit && tagLines === 1) {\n    const fixer = () => {\n      const tokens = jsdoc.source[lastLineWithTag].tokens;\n      jsdoc.source = [\n        {\n          number: 0,\n          source: '',\n          tokens: utils.seedTokens({\n            delimiter: '/**',\n            description: tokens.description.trimEnd() + ' ',\n            end: '*/',\n            name: tokens.name,\n            postDelimiter: ' ',\n            postName: tokens.postName,\n            postTag: tokens.postTag,\n            postType: tokens.postType,\n            start: jsdoc.source[0].tokens.start,\n            tag: tokens.tag,\n            type: tokens.type,\n          }),\n        },\n      ];\n    };\n\n    utils.reportJSDoc(\n      'Description is too short to be multi-line.',\n      null,\n      fixer,\n    );\n    return true;\n  }\n\n  return false;\n};\n\n/**\n * @param {import('@es-joy/jsdoccomment').JsdocBlockWithInline} jsdoc\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {number} requireSingleLineUnderCount\n */\nconst checkForShortDescriptions = (jsdoc, utils, requireSingleLineUnderCount) => {\n  if (!requireSingleLineUnderCount || jsdoc.tags.length) {\n    return false;\n  }\n\n  let lastLineWithDesc = 0;\n  let isUnderCountLimit = false;\n  const descLines = jsdoc.source.reduce((acc, {\n    tokens: {\n      delimiter,\n      description: desc,\n      postDelimiter,\n      start,\n    },\n  }, idx) => {\n    if (desc.length) {\n      lastLineWithDesc = idx;\n      if (\n        start.length + delimiter.length + postDelimiter.length + desc.length <\n          requireSingleLineUnderCount\n      ) {\n        isUnderCountLimit = true;\n      }\n\n      return acc + 1;\n    }\n\n    return acc;\n  }, 0);\n  // Could be descLines > 1\n  if (isUnderCountLimit && descLines === 1) {\n    const fixer = () => {\n      const desc = jsdoc.source[lastLineWithDesc].tokens.description;\n      jsdoc.source = [\n        {\n          number: 0,\n          source: '',\n          tokens: utils.seedTokens({\n            delimiter: '/**',\n            description: desc.trimEnd() + ' ',\n            end: '*/',\n            postDelimiter: ' ',\n            start: jsdoc.source[0].tokens.start,\n          }),\n        },\n      ];\n    };\n\n    utils.reportJSDoc(\n      'Description is too short to be multi-line.',\n      null,\n      fixer,\n    );\n    return true;\n  }\n\n  return false;\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  const {\n    allowMultipleTags = true,\n    minimumLengthForMultiline = Number.POSITIVE_INFINITY,\n    multilineTags = [\n      '*',\n    ],\n    noFinalLineText = true,\n    noMultilineBlocks = false,\n    noSingleLineBlocks = false,\n    noZeroLineText = true,\n    requireSingleLineUnderCount = null,\n    singleLineTags = [\n      'lends', 'type',\n    ],\n  } = context.options[0] || {};\n\n  const {\n    source: [\n      {\n        tokens,\n      },\n    ],\n  } = jsdoc;\n  const {\n    description,\n    tag,\n  } = tokens;\n  const sourceLength = jsdoc.source.length;\n\n  /**\n   * @param {string} tagName\n   * @returns {boolean}\n   */\n  const isInvalidSingleLine = (tagName) => {\n    return noSingleLineBlocks &&\n      (!tagName ||\n      !singleLineTags.includes(tagName) && !singleLineTags.includes('*'));\n  };\n\n  if (sourceLength === 1) {\n    if (!isInvalidSingleLine(tag.slice(1))) {\n      return;\n    }\n\n    const fixer = () => {\n      utils.makeMultiline();\n    };\n\n    utils.reportJSDoc(\n      'Single line blocks are not permitted by your configuration.',\n      null,\n      fixer,\n      true,\n    );\n\n    return;\n  }\n\n  if (checkForShortDescriptions(jsdoc, utils, requireSingleLineUnderCount)\n  ) {\n    return;\n  }\n\n  if (checkForShortTags(jsdoc, utils, requireSingleLineUnderCount)\n  ) {\n    return;\n  }\n\n  const lineChecks = () => {\n    if (\n      noZeroLineText &&\n      (tag || description)\n    ) {\n      const fixer = () => {\n        const line = {\n          ...tokens,\n        };\n        utils.emptyTokens(tokens);\n        const {\n          tokens: {\n            delimiter,\n            start,\n          },\n        } = jsdoc.source[1];\n        utils.addLine(1, {\n          ...line,\n          delimiter,\n          start,\n        });\n      };\n\n      utils.reportJSDoc(\n        'Should have no text on the \"0th\" line (after the `/**`).',\n        null,\n        fixer,\n      );\n\n      return;\n    }\n\n    const finalLine = jsdoc.source[jsdoc.source.length - 1];\n    const finalLineTokens = finalLine.tokens;\n    if (\n      noFinalLineText &&\n      finalLineTokens.description.trim()\n    ) {\n      const fixer = () => {\n        const line = {\n          ...finalLineTokens,\n        };\n        line.description = line.description.trimEnd();\n\n        const {\n          delimiter,\n        } = line;\n\n        for (const prop of [\n          'delimiter',\n          'postDelimiter',\n          'tag',\n          'type',\n          'lineEnd',\n          'postType',\n          'postTag',\n          'name',\n          'postName',\n          'description',\n        ]) {\n          finalLineTokens[\n            /**\n             * @type {\"delimiter\"|\"postDelimiter\"|\"tag\"|\"type\"|\n             *   \"lineEnd\"|\"postType\"|\"postTag\"|\"name\"|\n             *   \"postName\"|\"description\"}\n             */ (\n              prop\n            )\n          ] = '';\n        }\n\n        utils.addLine(jsdoc.source.length - 1, {\n          ...line,\n          delimiter,\n          end: '',\n        });\n      };\n\n      utils.reportJSDoc(\n        'Should have no text on the final line (before the `*/`).',\n        null,\n        fixer,\n      );\n    }\n  };\n\n  if (noMultilineBlocks) {\n    if (\n      jsdoc.tags.length &&\n      (multilineTags.includes('*') || utils.hasATag(multilineTags))\n    ) {\n      lineChecks();\n\n      return;\n    }\n\n    if (jsdoc.description.length >= minimumLengthForMultiline) {\n      lineChecks();\n\n      return;\n    }\n\n    if (\n      noSingleLineBlocks &&\n      (!jsdoc.tags.length ||\n      !utils.filterTags(({\n        tag: tg,\n      }) => {\n        return !isInvalidSingleLine(tg);\n      }).length)\n    ) {\n      utils.reportJSDoc(\n        'Multiline jsdoc blocks are prohibited by ' +\n          'your configuration but fixing would result in a single ' +\n          'line block which you have prohibited with `noSingleLineBlocks`.',\n      );\n\n      return;\n    }\n\n    if (jsdoc.tags.length > 1) {\n      if (!allowMultipleTags) {\n        utils.reportJSDoc(\n          'Multiline jsdoc blocks are prohibited by ' +\n            'your configuration but the block has multiple tags.',\n        );\n\n        return;\n      }\n    } else if (jsdoc.tags.length === 1 && jsdoc.description.trim()) {\n      if (!allowMultipleTags) {\n        utils.reportJSDoc(\n          'Multiline jsdoc blocks are prohibited by ' +\n            'your configuration but the block has a description with a tag.',\n        );\n\n        return;\n      }\n    } else {\n      const fixer = () => {\n        jsdoc.source = [\n          {\n            number: 1,\n            source: '',\n            tokens: jsdoc.source.reduce((obj, {\n              tokens: {\n                description: desc,\n                lineEnd,\n                name: nme,\n                postName,\n                postTag,\n                postType,\n                tag: tg,\n                type: typ,\n              },\n            }) => {\n              if (typ) {\n                obj.type = typ;\n              }\n\n              if (tg && typ && nme) {\n                obj.postType = postType;\n              }\n\n              if (nme) {\n                obj.name += nme;\n              }\n\n              if (nme && desc) {\n                obj.postName = postName;\n              }\n\n              obj.description += desc;\n\n              const nameOrDescription = obj.description || obj.name;\n              if (\n                nameOrDescription && nameOrDescription.slice(-1) !== ' '\n              ) {\n                obj.description += ' ';\n              }\n\n              obj.lineEnd = lineEnd;\n\n              // Already filtered for multiple tags\n              obj.tag += tg;\n              if (tg) {\n                obj.postTag = postTag || ' ';\n              }\n\n              return obj;\n            }, utils.seedTokens({\n              delimiter: '/**',\n              end: '*/',\n              postDelimiter: ' ',\n            })),\n          },\n        ];\n      };\n\n      utils.reportJSDoc(\n        'Multiline jsdoc blocks are prohibited by ' +\n          'your configuration.',\n        null,\n        fixer,\n      );\n\n      return;\n    }\n  }\n\n  lineChecks();\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Controls how and whether jsdoc blocks can be expressed as single or multiple line blocks.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/multiline-blocks.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          allowMultipleTags: {\n            type: 'boolean',\n          },\n          minimumLengthForMultiline: {\n            type: 'integer',\n          },\n          multilineTags: {\n            anyOf: [\n              {\n                enum: [\n                  '*',\n                ],\n                type: 'string',\n              }, {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n            ],\n          },\n          noFinalLineText: {\n            type: 'boolean',\n          },\n          noMultilineBlocks: {\n            type: 'boolean',\n          },\n          noSingleLineBlocks: {\n            type: 'boolean',\n          },\n          noZeroLineText: {\n            type: 'boolean',\n          },\n          requireSingleLineUnderCount: {\n            type: 'number',\n          },\n          singleLineTags: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;AAOA,MAAM,oBAAoB,CAAC,OAAO,OAAO,gCAAgC;AACvE,KAAI,CAAC,+BAA+B,CAAC,MAAM,KAAK,OAC9C,QAAO;CAGT,IAAI,kBAAkB;CACtB,IAAI,oBAAoB;CACxB,IAAI,qBAAqB;CACzB,MAAM,WAAW,MAAM,OAAO,OAAO,CAAC,KAAK,EACzC,QAAQ,EACN,WACA,aAAa,MACb,MACA,eACA,UACA,SACA,UACA,OACA,KACA,MACD,EACF,EAAE,QAAQ;AACT,MAAI,IAAI,QAAQ;GACd,kBAAkB;AAClB,OACE,MAAM,SAAS,UAAU,SAAS,cAAc,SAChD,KAAK,SAAS,SAAS,SAAS,KAAK,SAAS,SAAS,SACvD,IAAI,SAAS,QAAQ,SAAS,KAAK,SACjC,6BAEF,oBAAoB;AAGtB,UAAO,MAAM;EACd,WAAU,KAAK,UAAU,KAAK,QAAQ;GACrC,qBAAqB;AACrB,UAAO;EACR;AAED,SAAO;CACR,GAAE,EAAE;AAEL,KAAI,CAAC,sBAAsB,qBAAqB,aAAa,GAAG;EAC9D,MAAM,QAAQ,MAAM;GAClB,MAAM,SAAS,MAAM,OAAO,iBAAiB;GAC7C,MAAM,SAAS,CACb;IACE,QAAQ;IACR,QAAQ;IACR,QAAQ,MAAM,WAAW;KACvB,WAAW;KACX,aAAa,OAAO,YAAY,SAAS,GAAG;KAC5C,KAAK;KACL,MAAM,OAAO;KACb,eAAe;KACf,UAAU,OAAO;KACjB,SAAS,OAAO;KAChB,UAAU,OAAO;KACjB,OAAO,MAAM,OAAO,GAAG,OAAO;KAC9B,KAAK,OAAO;KACZ,MAAM,OAAO;IACd,EAAC;GACH,CACF;EACF;EAED,MAAM,YACJ,8CACA,MACA,MACD;AACD,SAAO;CACR;AAED,QAAO;AACR;;;;;;AAOD,MAAM,4BAA4B,CAAC,OAAO,OAAO,gCAAgC;AAC/E,KAAI,CAAC,+BAA+B,MAAM,KAAK,OAC7C,QAAO;CAGT,IAAI,mBAAmB;CACvB,IAAI,oBAAoB;CACxB,MAAM,YAAY,MAAM,OAAO,OAAO,CAAC,KAAK,EAC1C,QAAQ,EACN,WACA,aAAa,MACb,eACA,OACD,EACF,EAAE,QAAQ;AACT,MAAI,KAAK,QAAQ;GACf,mBAAmB;AACnB,OACE,MAAM,SAAS,UAAU,SAAS,cAAc,SAAS,KAAK,SAC5D,6BAEF,oBAAoB;AAGtB,UAAO,MAAM;EACd;AAED,SAAO;CACR,GAAE,EAAE;AAEL,KAAI,qBAAqB,cAAc,GAAG;EACxC,MAAM,QAAQ,MAAM;GAClB,MAAM,OAAO,MAAM,OAAO,kBAAkB,OAAO;GACnD,MAAM,SAAS,CACb;IACE,QAAQ;IACR,QAAQ;IACR,QAAQ,MAAM,WAAW;KACvB,WAAW;KACX,aAAa,KAAK,SAAS,GAAG;KAC9B,KAAK;KACL,eAAe;KACf,OAAO,MAAM,OAAO,GAAG,OAAO;IAC/B,EAAC;GACH,CACF;EACF;EAED,MAAM,YACJ,8CACA,MACA,MACD;AACD,SAAO;CACR;AAED,QAAO;AACR;AAED,8BAAeA,6BAAa,CAAC,EAC3B,SACA,OACA,OACD,KAAK;CACJ,MAAM,EACJ,oBAAoB,MACpB,4BAA4B,OAAO,mBACnC,gBAAgB,CACd,GACD,GACD,kBAAkB,MAClB,oBAAoB,OACpB,qBAAqB,OACrB,iBAAiB,MACjB,8BAA8B,MAC9B,iBAAiB,CACf,SAAS,MACV,GACF,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,MAAM,EACJ,QAAQ,CACN,EACE,QACD,CACF,EACF,GAAG;CACJ,MAAM,EACJ,aACA,KACD,GAAG;CACJ,MAAM,eAAe,MAAM,OAAO;;;;;CAMlC,MAAM,sBAAsB,CAAC,YAAY;AACvC,SAAO,uBACJ,CAAC,WACF,CAAC,eAAe,SAAS,QAAQ,IAAI,CAAC,eAAe,SAAS,IAAI;CACrE;AAED,KAAI,iBAAiB,GAAG;AACtB,MAAI,CAAC,oBAAoB,IAAI,MAAM,EAAE,CAAC,CACpC;EAGF,MAAM,QAAQ,MAAM;GAClB,MAAM,eAAe;EACtB;EAED,MAAM,YACJ,+DACA,MACA,OACA,KACD;AAED;CACD;AAED,KAAI,0BAA0B,OAAO,OAAO,4BAA4B,CAEtE;AAGF,KAAI,kBAAkB,OAAO,OAAO,4BAA4B,CAE9D;CAGF,MAAM,aAAa,MAAM;AACvB,MACE,mBACC,OAAO,cACR;GACA,MAAM,QAAQ,MAAM;IAClB,MAAM,OAAO,EACX,GAAG,OACJ;IACD,MAAM,YAAY,OAAO;IACzB,MAAM,EACJ,QAAQ,EACN,WACA,OACD,EACF,GAAG,MAAM,OAAO;IACjB,MAAM,QAAQ,GAAG;KACf,GAAG;KACH;KACA;IACD,EAAC;GACH;GAED,MAAM,YACJ,8DACA,MACA,MACD;AAED;EACD;EAED,MAAM,YAAY,MAAM,OAAO,MAAM,OAAO,SAAS;EACrD,MAAM,kBAAkB,UAAU;AAClC,MACE,mBACA,gBAAgB,YAAY,MAAM,EAClC;GACA,MAAM,QAAQ,MAAM;IAClB,MAAM,OAAO,EACX,GAAG,gBACJ;IACD,KAAK,cAAc,KAAK,YAAY,SAAS;IAE7C,MAAM,EACJ,WACD,GAAG;AAEJ,SAAK,MAAM,QAAQ;KACjB;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;IACD,GACC,gBAMI,QAEA;IAGN,MAAM,QAAQ,MAAM,OAAO,SAAS,GAAG;KACrC,GAAG;KACH;KACA,KAAK;IACN,EAAC;GACH;GAED,MAAM,YACJ,4DACA,MACA,MACD;EACF;CACF;AAED,KAAI,mBAAmB;AACrB,MACE,MAAM,KAAK,WACV,cAAc,SAAS,IAAI,IAAI,MAAM,QAAQ,cAAc,GAC5D;GACA,YAAY;AAEZ;EACD;AAED,MAAI,MAAM,YAAY,UAAU,2BAA2B;GACzD,YAAY;AAEZ;EACD;AAED,MACE,uBACC,CAAC,MAAM,KAAK,UACb,CAAC,MAAM,WAAW,CAAC,EACjB,KAAK,IACN,KAAK;AACJ,UAAO,CAAC,oBAAoB,GAAG;EAChC,EAAC,CAAC,SACH;GACA,MAAM,YACJ,kKAGD;AAED;EACD;AAED,MAAI,MAAM,KAAK,SAAS,GACtB;OAAI,CAAC,mBAAmB;IACtB,MAAM,YACJ,+FAED;AAED;GACD;aACQ,MAAM,KAAK,WAAW,KAAK,MAAM,YAAY,MAAM,EAC5D;OAAI,CAAC,mBAAmB;IACtB,MAAM,YACJ,0GAED;AAED;GACD;SACI;GACL,MAAM,QAAQ,MAAM;IAClB,MAAM,SAAS,CACb;KACE,QAAQ;KACR,QAAQ;KACR,QAAQ,MAAM,OAAO,OAAO,CAAC,KAAK,EAChC,QAAQ,EACN,aAAa,MACb,SACA,MAAM,KACN,UACA,SACA,UACA,KAAK,IACL,MAAM,KACP,EACF,KAAK;AACJ,UAAI,KACF,IAAI,OAAO;AAGb,UAAI,MAAM,OAAO,KACf,IAAI,WAAW;AAGjB,UAAI,KACF,IAAI,QAAQ;AAGd,UAAI,OAAO,MACT,IAAI,WAAW;MAGjB,IAAI,eAAe;MAEnB,MAAM,oBAAoB,IAAI,eAAe,IAAI;AACjD,UACE,qBAAqB,kBAAkB,MAAM,GAAG,KAAK,KAErD,IAAI,eAAe;MAGrB,IAAI,UAAU;MAGd,IAAI,OAAO;AACX,UAAI,IACF,IAAI,UAAU,WAAW;AAG3B,aAAO;KACR,GAAE,MAAM,WAAW;MAClB,WAAW;MACX,KAAK;MACL,eAAe;KAChB,EAAC,CAAC;IACJ,CACF;GACF;GAED,MAAM,YACJ,gEAEA,MACA,MACD;AAED;EACD;CACF;CAED,YAAY;AACb,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,mBAAmB,EACjB,MAAM,UACP;IACD,2BAA2B,EACzB,MAAM,UACP;IACD,eAAe,EACb,OAAO,CACL;KACE,MAAM,CACJ,GACD;KACD,MAAM;IACP,GAAE;KACD,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP,CACF,EACF;IACD,iBAAiB,EACf,MAAM,UACP;IACD,mBAAmB,EACjB,MAAM,UACP;IACD,oBAAoB,EAClB,MAAM,UACP;IACD,gBAAgB,EACd,MAAM,UACP;IACD,6BAA6B,EAC3B,MAAM,SACP;IACD,gBAAgB;KACd,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/multilineBlocks.js

@@ -0,0 +1,245 @@
+import iterateJsdoc from "../iterateJsdoc.js";
+
+//#region src/rules/multilineBlocks.js
+/**
+* @param {import('@es-joy/jsdoccomment').JsdocBlockWithInline} jsdoc
+* @param {import('../iterateJsdoc.js').Utils} utils
+* @param {number} requireSingleLineUnderCount
+*/
+const checkForShortTags = (jsdoc, utils, requireSingleLineUnderCount) => {
+	if (!requireSingleLineUnderCount || !jsdoc.tags.length) return false;
+	let lastLineWithTag = 0;
+	let isUnderCountLimit = false;
+	let hasMultiDescOrType = false;
+	const tagLines = jsdoc.source.reduce((acc, { tokens: { delimiter, description: desc, name, postDelimiter, postName, postTag, postType, start, tag, type } }, idx) => {
+		if (tag.length) {
+			lastLineWithTag = idx;
+			if (start.length + delimiter.length + postDelimiter.length + type.length + postType.length + name.length + postName.length + tag.length + postTag.length + desc.length < requireSingleLineUnderCount) isUnderCountLimit = true;
+			return acc + 1;
+		} else if (desc.length || type.length) {
+			hasMultiDescOrType = true;
+			return acc;
+		}
+		return acc;
+	}, 0);
+	if (!hasMultiDescOrType && isUnderCountLimit && tagLines === 1) {
+		const fixer = () => {
+			const tokens = jsdoc.source[lastLineWithTag].tokens;
+			jsdoc.source = [{
+				number: 0,
+				source: "",
+				tokens: utils.seedTokens({
+					delimiter: "/**",
+					description: tokens.description.trimEnd() + " ",
+					end: "*/",
+					name: tokens.name,
+					postDelimiter: " ",
+					postName: tokens.postName,
+					postTag: tokens.postTag,
+					postType: tokens.postType,
+					start: jsdoc.source[0].tokens.start,
+					tag: tokens.tag,
+					type: tokens.type
+				})
+			}];
+		};
+		utils.reportJSDoc("Description is too short to be multi-line.", null, fixer);
+		return true;
+	}
+	return false;
+};
+/**
+* @param {import('@es-joy/jsdoccomment').JsdocBlockWithInline} jsdoc
+* @param {import('../iterateJsdoc.js').Utils} utils
+* @param {number} requireSingleLineUnderCount
+*/
+const checkForShortDescriptions = (jsdoc, utils, requireSingleLineUnderCount) => {
+	if (!requireSingleLineUnderCount || jsdoc.tags.length) return false;
+	let lastLineWithDesc = 0;
+	let isUnderCountLimit = false;
+	const descLines = jsdoc.source.reduce((acc, { tokens: { delimiter, description: desc, postDelimiter, start } }, idx) => {
+		if (desc.length) {
+			lastLineWithDesc = idx;
+			if (start.length + delimiter.length + postDelimiter.length + desc.length < requireSingleLineUnderCount) isUnderCountLimit = true;
+			return acc + 1;
+		}
+		return acc;
+	}, 0);
+	if (isUnderCountLimit && descLines === 1) {
+		const fixer = () => {
+			const desc = jsdoc.source[lastLineWithDesc].tokens.description;
+			jsdoc.source = [{
+				number: 0,
+				source: "",
+				tokens: utils.seedTokens({
+					delimiter: "/**",
+					description: desc.trimEnd() + " ",
+					end: "*/",
+					postDelimiter: " ",
+					start: jsdoc.source[0].tokens.start
+				})
+			}];
+		};
+		utils.reportJSDoc("Description is too short to be multi-line.", null, fixer);
+		return true;
+	}
+	return false;
+};
+var multilineBlocks_default = iterateJsdoc(({ context, jsdoc, utils }) => {
+	const { allowMultipleTags = true, minimumLengthForMultiline = Number.POSITIVE_INFINITY, multilineTags = ["*"], noFinalLineText = true, noMultilineBlocks = false, noSingleLineBlocks = false, noZeroLineText = true, requireSingleLineUnderCount = null, singleLineTags = ["lends", "type"] } = context.options[0] || {};
+	const { source: [{ tokens }] } = jsdoc;
+	const { description, tag } = tokens;
+	const sourceLength = jsdoc.source.length;
+	/**
+	* @param {string} tagName
+	* @returns {boolean}
+	*/
+	const isInvalidSingleLine = (tagName) => {
+		return noSingleLineBlocks && (!tagName || !singleLineTags.includes(tagName) && !singleLineTags.includes("*"));
+	};
+	if (sourceLength === 1) {
+		if (!isInvalidSingleLine(tag.slice(1))) return;
+		const fixer = () => {
+			utils.makeMultiline();
+		};
+		utils.reportJSDoc("Single line blocks are not permitted by your configuration.", null, fixer, true);
+		return;
+	}
+	if (checkForShortDescriptions(jsdoc, utils, requireSingleLineUnderCount)) return;
+	if (checkForShortTags(jsdoc, utils, requireSingleLineUnderCount)) return;
+	const lineChecks = () => {
+		if (noZeroLineText && (tag || description)) {
+			const fixer = () => {
+				const line = { ...tokens };
+				utils.emptyTokens(tokens);
+				const { tokens: { delimiter, start } } = jsdoc.source[1];
+				utils.addLine(1, {
+					...line,
+					delimiter,
+					start
+				});
+			};
+			utils.reportJSDoc("Should have no text on the \"0th\" line (after the `/**`).", null, fixer);
+			return;
+		}
+		const finalLine = jsdoc.source[jsdoc.source.length - 1];
+		const finalLineTokens = finalLine.tokens;
+		if (noFinalLineText && finalLineTokens.description.trim()) {
+			const fixer = () => {
+				const line = { ...finalLineTokens };
+				line.description = line.description.trimEnd();
+				const { delimiter } = line;
+				for (const prop of [
+					"delimiter",
+					"postDelimiter",
+					"tag",
+					"type",
+					"lineEnd",
+					"postType",
+					"postTag",
+					"name",
+					"postName",
+					"description"
+				]) finalLineTokens[prop] = "";
+				utils.addLine(jsdoc.source.length - 1, {
+					...line,
+					delimiter,
+					end: ""
+				});
+			};
+			utils.reportJSDoc("Should have no text on the final line (before the `*/`).", null, fixer);
+		}
+	};
+	if (noMultilineBlocks) {
+		if (jsdoc.tags.length && (multilineTags.includes("*") || utils.hasATag(multilineTags))) {
+			lineChecks();
+			return;
+		}
+		if (jsdoc.description.length >= minimumLengthForMultiline) {
+			lineChecks();
+			return;
+		}
+		if (noSingleLineBlocks && (!jsdoc.tags.length || !utils.filterTags(({ tag: tg }) => {
+			return !isInvalidSingleLine(tg);
+		}).length)) {
+			utils.reportJSDoc("Multiline jsdoc blocks are prohibited by your configuration but fixing would result in a single line block which you have prohibited with `noSingleLineBlocks`.");
+			return;
+		}
+		if (jsdoc.tags.length > 1) {
+			if (!allowMultipleTags) {
+				utils.reportJSDoc("Multiline jsdoc blocks are prohibited by your configuration but the block has multiple tags.");
+				return;
+			}
+		} else if (jsdoc.tags.length === 1 && jsdoc.description.trim()) {
+			if (!allowMultipleTags) {
+				utils.reportJSDoc("Multiline jsdoc blocks are prohibited by your configuration but the block has a description with a tag.");
+				return;
+			}
+		} else {
+			const fixer = () => {
+				jsdoc.source = [{
+					number: 1,
+					source: "",
+					tokens: jsdoc.source.reduce((obj, { tokens: { description: desc, lineEnd, name: nme, postName, postTag, postType, tag: tg, type: typ } }) => {
+						if (typ) obj.type = typ;
+						if (tg && typ && nme) obj.postType = postType;
+						if (nme) obj.name += nme;
+						if (nme && desc) obj.postName = postName;
+						obj.description += desc;
+						const nameOrDescription = obj.description || obj.name;
+						if (nameOrDescription && nameOrDescription.slice(-1) !== " ") obj.description += " ";
+						obj.lineEnd = lineEnd;
+						obj.tag += tg;
+						if (tg) obj.postTag = postTag || " ";
+						return obj;
+					}, utils.seedTokens({
+						delimiter: "/**",
+						end: "*/",
+						postDelimiter: " "
+					}))
+				}];
+			};
+			utils.reportJSDoc("Multiline jsdoc blocks are prohibited by your configuration.", null, fixer);
+			return;
+		}
+	}
+	lineChecks();
+}, {
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "Controls how and whether jsdoc blocks can be expressed as single or multiple line blocks.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/multiline-blocks.md#repos-sticky-header"
+		},
+		fixable: "code",
+		schema: [{
+			additionalProperties: false,
+			properties: {
+				allowMultipleTags: { type: "boolean" },
+				minimumLengthForMultiline: { type: "integer" },
+				multilineTags: { anyOf: [{
+					enum: ["*"],
+					type: "string"
+				}, {
+					items: { type: "string" },
+					type: "array"
+				}] },
+				noFinalLineText: { type: "boolean" },
+				noMultilineBlocks: { type: "boolean" },
+				noSingleLineBlocks: { type: "boolean" },
+				noZeroLineText: { type: "boolean" },
+				requireSingleLineUnderCount: { type: "number" },
+				singleLineTags: {
+					items: { type: "string" },
+					type: "array"
+				}
+			},
+			type: "object"
+		}],
+		type: "suggestion"
+	}
+});
+
+//#endregion
+export { multilineBlocks_default as default };
+//# sourceMappingURL=multilineBlocks.js.map

package/dist/rules/multilineBlocks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"multilineBlocks.js","names":[],"sources":["../../src/rules/multilineBlocks.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {import('@es-joy/jsdoccomment').JsdocBlockWithInline} jsdoc\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {number} requireSingleLineUnderCount\n */\nconst checkForShortTags = (jsdoc, utils, requireSingleLineUnderCount) => {\n  if (!requireSingleLineUnderCount || !jsdoc.tags.length) {\n    return false;\n  }\n\n  let lastLineWithTag = 0;\n  let isUnderCountLimit = false;\n  let hasMultiDescOrType = false;\n  const tagLines = jsdoc.source.reduce((acc, {\n    tokens: {\n      delimiter,\n      description: desc,\n      name,\n      postDelimiter,\n      postName,\n      postTag,\n      postType,\n      start,\n      tag,\n      type,\n    },\n  }, idx) => {\n    if (tag.length) {\n      lastLineWithTag = idx;\n      if (\n        start.length + delimiter.length + postDelimiter.length +\n        type.length + postType.length + name.length + postName.length +\n        tag.length + postTag.length + desc.length <\n          requireSingleLineUnderCount\n      ) {\n        isUnderCountLimit = true;\n      }\n\n      return acc + 1;\n    } else if (desc.length || type.length) {\n      hasMultiDescOrType = true;\n      return acc;\n    }\n\n    return acc;\n  }, 0);\n  // Could be tagLines > 1\n  if (!hasMultiDescOrType && isUnderCountLimit && tagLines === 1) {\n    const fixer = () => {\n      const tokens = jsdoc.source[lastLineWithTag].tokens;\n      jsdoc.source = [\n        {\n          number: 0,\n          source: '',\n          tokens: utils.seedTokens({\n            delimiter: '/**',\n            description: tokens.description.trimEnd() + ' ',\n            end: '*/',\n            name: tokens.name,\n            postDelimiter: ' ',\n            postName: tokens.postName,\n            postTag: tokens.postTag,\n            postType: tokens.postType,\n            start: jsdoc.source[0].tokens.start,\n            tag: tokens.tag,\n            type: tokens.type,\n          }),\n        },\n      ];\n    };\n\n    utils.reportJSDoc(\n      'Description is too short to be multi-line.',\n      null,\n      fixer,\n    );\n    return true;\n  }\n\n  return false;\n};\n\n/**\n * @param {import('@es-joy/jsdoccomment').JsdocBlockWithInline} jsdoc\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {number} requireSingleLineUnderCount\n */\nconst checkForShortDescriptions = (jsdoc, utils, requireSingleLineUnderCount) => {\n  if (!requireSingleLineUnderCount || jsdoc.tags.length) {\n    return false;\n  }\n\n  let lastLineWithDesc = 0;\n  let isUnderCountLimit = false;\n  const descLines = jsdoc.source.reduce((acc, {\n    tokens: {\n      delimiter,\n      description: desc,\n      postDelimiter,\n      start,\n    },\n  }, idx) => {\n    if (desc.length) {\n      lastLineWithDesc = idx;\n      if (\n        start.length + delimiter.length + postDelimiter.length + desc.length <\n          requireSingleLineUnderCount\n      ) {\n        isUnderCountLimit = true;\n      }\n\n      return acc + 1;\n    }\n\n    return acc;\n  }, 0);\n  // Could be descLines > 1\n  if (isUnderCountLimit && descLines === 1) {\n    const fixer = () => {\n      const desc = jsdoc.source[lastLineWithDesc].tokens.description;\n      jsdoc.source = [\n        {\n          number: 0,\n          source: '',\n          tokens: utils.seedTokens({\n            delimiter: '/**',\n            description: desc.trimEnd() + ' ',\n            end: '*/',\n            postDelimiter: ' ',\n            start: jsdoc.source[0].tokens.start,\n          }),\n        },\n      ];\n    };\n\n    utils.reportJSDoc(\n      'Description is too short to be multi-line.',\n      null,\n      fixer,\n    );\n    return true;\n  }\n\n  return false;\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  const {\n    allowMultipleTags = true,\n    minimumLengthForMultiline = Number.POSITIVE_INFINITY,\n    multilineTags = [\n      '*',\n    ],\n    noFinalLineText = true,\n    noMultilineBlocks = false,\n    noSingleLineBlocks = false,\n    noZeroLineText = true,\n    requireSingleLineUnderCount = null,\n    singleLineTags = [\n      'lends', 'type',\n    ],\n  } = context.options[0] || {};\n\n  const {\n    source: [\n      {\n        tokens,\n      },\n    ],\n  } = jsdoc;\n  const {\n    description,\n    tag,\n  } = tokens;\n  const sourceLength = jsdoc.source.length;\n\n  /**\n   * @param {string} tagName\n   * @returns {boolean}\n   */\n  const isInvalidSingleLine = (tagName) => {\n    return noSingleLineBlocks &&\n      (!tagName ||\n      !singleLineTags.includes(tagName) && !singleLineTags.includes('*'));\n  };\n\n  if (sourceLength === 1) {\n    if (!isInvalidSingleLine(tag.slice(1))) {\n      return;\n    }\n\n    const fixer = () => {\n      utils.makeMultiline();\n    };\n\n    utils.reportJSDoc(\n      'Single line blocks are not permitted by your configuration.',\n      null,\n      fixer,\n      true,\n    );\n\n    return;\n  }\n\n  if (checkForShortDescriptions(jsdoc, utils, requireSingleLineUnderCount)\n  ) {\n    return;\n  }\n\n  if (checkForShortTags(jsdoc, utils, requireSingleLineUnderCount)\n  ) {\n    return;\n  }\n\n  const lineChecks = () => {\n    if (\n      noZeroLineText &&\n      (tag || description)\n    ) {\n      const fixer = () => {\n        const line = {\n          ...tokens,\n        };\n        utils.emptyTokens(tokens);\n        const {\n          tokens: {\n            delimiter,\n            start,\n          },\n        } = jsdoc.source[1];\n        utils.addLine(1, {\n          ...line,\n          delimiter,\n          start,\n        });\n      };\n\n      utils.reportJSDoc(\n        'Should have no text on the \"0th\" line (after the `/**`).',\n        null,\n        fixer,\n      );\n\n      return;\n    }\n\n    const finalLine = jsdoc.source[jsdoc.source.length - 1];\n    const finalLineTokens = finalLine.tokens;\n    if (\n      noFinalLineText &&\n      finalLineTokens.description.trim()\n    ) {\n      const fixer = () => {\n        const line = {\n          ...finalLineTokens,\n        };\n        line.description = line.description.trimEnd();\n\n        const {\n          delimiter,\n        } = line;\n\n        for (const prop of [\n          'delimiter',\n          'postDelimiter',\n          'tag',\n          'type',\n          'lineEnd',\n          'postType',\n          'postTag',\n          'name',\n          'postName',\n          'description',\n        ]) {\n          finalLineTokens[\n            /**\n             * @type {\"delimiter\"|\"postDelimiter\"|\"tag\"|\"type\"|\n             *   \"lineEnd\"|\"postType\"|\"postTag\"|\"name\"|\n             *   \"postName\"|\"description\"}\n             */ (\n              prop\n            )\n          ] = '';\n        }\n\n        utils.addLine(jsdoc.source.length - 1, {\n          ...line,\n          delimiter,\n          end: '',\n        });\n      };\n\n      utils.reportJSDoc(\n        'Should have no text on the final line (before the `*/`).',\n        null,\n        fixer,\n      );\n    }\n  };\n\n  if (noMultilineBlocks) {\n    if (\n      jsdoc.tags.length &&\n      (multilineTags.includes('*') || utils.hasATag(multilineTags))\n    ) {\n      lineChecks();\n\n      return;\n    }\n\n    if (jsdoc.description.length >= minimumLengthForMultiline) {\n      lineChecks();\n\n      return;\n    }\n\n    if (\n      noSingleLineBlocks &&\n      (!jsdoc.tags.length ||\n      !utils.filterTags(({\n        tag: tg,\n      }) => {\n        return !isInvalidSingleLine(tg);\n      }).length)\n    ) {\n      utils.reportJSDoc(\n        'Multiline jsdoc blocks are prohibited by ' +\n          'your configuration but fixing would result in a single ' +\n          'line block which you have prohibited with `noSingleLineBlocks`.',\n      );\n\n      return;\n    }\n\n    if (jsdoc.tags.length > 1) {\n      if (!allowMultipleTags) {\n        utils.reportJSDoc(\n          'Multiline jsdoc blocks are prohibited by ' +\n            'your configuration but the block has multiple tags.',\n        );\n\n        return;\n      }\n    } else if (jsdoc.tags.length === 1 && jsdoc.description.trim()) {\n      if (!allowMultipleTags) {\n        utils.reportJSDoc(\n          'Multiline jsdoc blocks are prohibited by ' +\n            'your configuration but the block has a description with a tag.',\n        );\n\n        return;\n      }\n    } else {\n      const fixer = () => {\n        jsdoc.source = [\n          {\n            number: 1,\n            source: '',\n            tokens: jsdoc.source.reduce((obj, {\n              tokens: {\n                description: desc,\n                lineEnd,\n                name: nme,\n                postName,\n                postTag,\n                postType,\n                tag: tg,\n                type: typ,\n              },\n            }) => {\n              if (typ) {\n                obj.type = typ;\n              }\n\n              if (tg && typ && nme) {\n                obj.postType = postType;\n              }\n\n              if (nme) {\n                obj.name += nme;\n              }\n\n              if (nme && desc) {\n                obj.postName = postName;\n              }\n\n              obj.description += desc;\n\n              const nameOrDescription = obj.description || obj.name;\n              if (\n                nameOrDescription && nameOrDescription.slice(-1) !== ' '\n              ) {\n                obj.description += ' ';\n              }\n\n              obj.lineEnd = lineEnd;\n\n              // Already filtered for multiple tags\n              obj.tag += tg;\n              if (tg) {\n                obj.postTag = postTag || ' ';\n              }\n\n              return obj;\n            }, utils.seedTokens({\n              delimiter: '/**',\n              end: '*/',\n              postDelimiter: ' ',\n            })),\n          },\n        ];\n      };\n\n      utils.reportJSDoc(\n        'Multiline jsdoc blocks are prohibited by ' +\n          'your configuration.',\n        null,\n        fixer,\n      );\n\n      return;\n    }\n  }\n\n  lineChecks();\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Controls how and whether jsdoc blocks can be expressed as single or multiple line blocks.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/multiline-blocks.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          allowMultipleTags: {\n            type: 'boolean',\n          },\n          minimumLengthForMultiline: {\n            type: 'integer',\n          },\n          multilineTags: {\n            anyOf: [\n              {\n                enum: [\n                  '*',\n                ],\n                type: 'string',\n              }, {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n            ],\n          },\n          noFinalLineText: {\n            type: 'boolean',\n          },\n          noMultilineBlocks: {\n            type: 'boolean',\n          },\n          noSingleLineBlocks: {\n            type: 'boolean',\n          },\n          noZeroLineText: {\n            type: 'boolean',\n          },\n          requireSingleLineUnderCount: {\n            type: 'number',\n          },\n          singleLineTags: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;AAOA,MAAM,oBAAoB,CAAC,OAAO,OAAO,gCAAgC;AACvE,KAAI,CAAC,+BAA+B,CAAC,MAAM,KAAK,OAC9C,QAAO;CAGT,IAAI,kBAAkB;CACtB,IAAI,oBAAoB;CACxB,IAAI,qBAAqB;CACzB,MAAM,WAAW,MAAM,OAAO,OAAO,CAAC,KAAK,EACzC,QAAQ,EACN,WACA,aAAa,MACb,MACA,eACA,UACA,SACA,UACA,OACA,KACA,MACD,EACF,EAAE,QAAQ;AACT,MAAI,IAAI,QAAQ;GACd,kBAAkB;AAClB,OACE,MAAM,SAAS,UAAU,SAAS,cAAc,SAChD,KAAK,SAAS,SAAS,SAAS,KAAK,SAAS,SAAS,SACvD,IAAI,SAAS,QAAQ,SAAS,KAAK,SACjC,6BAEF,oBAAoB;AAGtB,UAAO,MAAM;EACd,WAAU,KAAK,UAAU,KAAK,QAAQ;GACrC,qBAAqB;AACrB,UAAO;EACR;AAED,SAAO;CACR,GAAE,EAAE;AAEL,KAAI,CAAC,sBAAsB,qBAAqB,aAAa,GAAG;EAC9D,MAAM,QAAQ,MAAM;GAClB,MAAM,SAAS,MAAM,OAAO,iBAAiB;GAC7C,MAAM,SAAS,CACb;IACE,QAAQ;IACR,QAAQ;IACR,QAAQ,MAAM,WAAW;KACvB,WAAW;KACX,aAAa,OAAO,YAAY,SAAS,GAAG;KAC5C,KAAK;KACL,MAAM,OAAO;KACb,eAAe;KACf,UAAU,OAAO;KACjB,SAAS,OAAO;KAChB,UAAU,OAAO;KACjB,OAAO,MAAM,OAAO,GAAG,OAAO;KAC9B,KAAK,OAAO;KACZ,MAAM,OAAO;IACd,EAAC;GACH,CACF;EACF;EAED,MAAM,YACJ,8CACA,MACA,MACD;AACD,SAAO;CACR;AAED,QAAO;AACR;;;;;;AAOD,MAAM,4BAA4B,CAAC,OAAO,OAAO,gCAAgC;AAC/E,KAAI,CAAC,+BAA+B,MAAM,KAAK,OAC7C,QAAO;CAGT,IAAI,mBAAmB;CACvB,IAAI,oBAAoB;CACxB,MAAM,YAAY,MAAM,OAAO,OAAO,CAAC,KAAK,EAC1C,QAAQ,EACN,WACA,aAAa,MACb,eACA,OACD,EACF,EAAE,QAAQ;AACT,MAAI,KAAK,QAAQ;GACf,mBAAmB;AACnB,OACE,MAAM,SAAS,UAAU,SAAS,cAAc,SAAS,KAAK,SAC5D,6BAEF,oBAAoB;AAGtB,UAAO,MAAM;EACd;AAED,SAAO;CACR,GAAE,EAAE;AAEL,KAAI,qBAAqB,cAAc,GAAG;EACxC,MAAM,QAAQ,MAAM;GAClB,MAAM,OAAO,MAAM,OAAO,kBAAkB,OAAO;GACnD,MAAM,SAAS,CACb;IACE,QAAQ;IACR,QAAQ;IACR,QAAQ,MAAM,WAAW;KACvB,WAAW;KACX,aAAa,KAAK,SAAS,GAAG;KAC9B,KAAK;KACL,eAAe;KACf,OAAO,MAAM,OAAO,GAAG,OAAO;IAC/B,EAAC;GACH,CACF;EACF;EAED,MAAM,YACJ,8CACA,MACA,MACD;AACD,SAAO;CACR;AAED,QAAO;AACR;AAED,8BAAe,aAAa,CAAC,EAC3B,SACA,OACA,OACD,KAAK;CACJ,MAAM,EACJ,oBAAoB,MACpB,4BAA4B,OAAO,mBACnC,gBAAgB,CACd,GACD,GACD,kBAAkB,MAClB,oBAAoB,OACpB,qBAAqB,OACrB,iBAAiB,MACjB,8BAA8B,MAC9B,iBAAiB,CACf,SAAS,MACV,GACF,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,MAAM,EACJ,QAAQ,CACN,EACE,QACD,CACF,EACF,GAAG;CACJ,MAAM,EACJ,aACA,KACD,GAAG;CACJ,MAAM,eAAe,MAAM,OAAO;;;;;CAMlC,MAAM,sBAAsB,CAAC,YAAY;AACvC,SAAO,uBACJ,CAAC,WACF,CAAC,eAAe,SAAS,QAAQ,IAAI,CAAC,eAAe,SAAS,IAAI;CACrE;AAED,KAAI,iBAAiB,GAAG;AACtB,MAAI,CAAC,oBAAoB,IAAI,MAAM,EAAE,CAAC,CACpC;EAGF,MAAM,QAAQ,MAAM;GAClB,MAAM,eAAe;EACtB;EAED,MAAM,YACJ,+DACA,MACA,OACA,KACD;AAED;CACD;AAED,KAAI,0BAA0B,OAAO,OAAO,4BAA4B,CAEtE;AAGF,KAAI,kBAAkB,OAAO,OAAO,4BAA4B,CAE9D;CAGF,MAAM,aAAa,MAAM;AACvB,MACE,mBACC,OAAO,cACR;GACA,MAAM,QAAQ,MAAM;IAClB,MAAM,OAAO,EACX,GAAG,OACJ;IACD,MAAM,YAAY,OAAO;IACzB,MAAM,EACJ,QAAQ,EACN,WACA,OACD,EACF,GAAG,MAAM,OAAO;IACjB,MAAM,QAAQ,GAAG;KACf,GAAG;KACH;KACA;IACD,EAAC;GACH;GAED,MAAM,YACJ,8DACA,MACA,MACD;AAED;EACD;EAED,MAAM,YAAY,MAAM,OAAO,MAAM,OAAO,SAAS;EACrD,MAAM,kBAAkB,UAAU;AAClC,MACE,mBACA,gBAAgB,YAAY,MAAM,EAClC;GACA,MAAM,QAAQ,MAAM;IAClB,MAAM,OAAO,EACX,GAAG,gBACJ;IACD,KAAK,cAAc,KAAK,YAAY,SAAS;IAE7C,MAAM,EACJ,WACD,GAAG;AAEJ,SAAK,MAAM,QAAQ;KACjB;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;IACD,GACC,gBAMI,QAEA;IAGN,MAAM,QAAQ,MAAM,OAAO,SAAS,GAAG;KACrC,GAAG;KACH;KACA,KAAK;IACN,EAAC;GACH;GAED,MAAM,YACJ,4DACA,MACA,MACD;EACF;CACF;AAED,KAAI,mBAAmB;AACrB,MACE,MAAM,KAAK,WACV,cAAc,SAAS,IAAI,IAAI,MAAM,QAAQ,cAAc,GAC5D;GACA,YAAY;AAEZ;EACD;AAED,MAAI,MAAM,YAAY,UAAU,2BAA2B;GACzD,YAAY;AAEZ;EACD;AAED,MACE,uBACC,CAAC,MAAM,KAAK,UACb,CAAC,MAAM,WAAW,CAAC,EACjB,KAAK,IACN,KAAK;AACJ,UAAO,CAAC,oBAAoB,GAAG;EAChC,EAAC,CAAC,SACH;GACA,MAAM,YACJ,kKAGD;AAED;EACD;AAED,MAAI,MAAM,KAAK,SAAS,GACtB;OAAI,CAAC,mBAAmB;IACtB,MAAM,YACJ,+FAED;AAED;GACD;aACQ,MAAM,KAAK,WAAW,KAAK,MAAM,YAAY,MAAM,EAC5D;OAAI,CAAC,mBAAmB;IACtB,MAAM,YACJ,0GAED;AAED;GACD;SACI;GACL,MAAM,QAAQ,MAAM;IAClB,MAAM,SAAS,CACb;KACE,QAAQ;KACR,QAAQ;KACR,QAAQ,MAAM,OAAO,OAAO,CAAC,KAAK,EAChC,QAAQ,EACN,aAAa,MACb,SACA,MAAM,KACN,UACA,SACA,UACA,KAAK,IACL,MAAM,KACP,EACF,KAAK;AACJ,UAAI,KACF,IAAI,OAAO;AAGb,UAAI,MAAM,OAAO,KACf,IAAI,WAAW;AAGjB,UAAI,KACF,IAAI,QAAQ;AAGd,UAAI,OAAO,MACT,IAAI,WAAW;MAGjB,IAAI,eAAe;MAEnB,MAAM,oBAAoB,IAAI,eAAe,IAAI;AACjD,UACE,qBAAqB,kBAAkB,MAAM,GAAG,KAAK,KAErD,IAAI,eAAe;MAGrB,IAAI,UAAU;MAGd,IAAI,OAAO;AACX,UAAI,IACF,IAAI,UAAU,WAAW;AAG3B,aAAO;KACR,GAAE,MAAM,WAAW;MAClB,WAAW;MACX,KAAK;MACL,eAAe;KAChB,EAAC,CAAC;IACJ,CACF;GACF;GAED,MAAM,YACJ,gEAEA,MACA,MACD;AAED;EACD;CACF;CAED,YAAY;AACb,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,mBAAmB,EACjB,MAAM,UACP;IACD,2BAA2B,EACzB,MAAM,UACP;IACD,eAAe,EACb,OAAO,CACL;KACE,MAAM,CACJ,GACD;KACD,MAAM;IACP,GAAE;KACD,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP,CACF,EACF;IACD,iBAAiB,EACf,MAAM,UACP;IACD,mBAAmB,EACjB,MAAM,UACP;IACD,oBAAoB,EAClB,MAAM,UACP;IACD,gBAAgB,EACd,MAAM,UACP;IACD,6BAA6B,EAC3B,MAAM,SACP;IACD,gBAAgB;KACd,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/noBadBlocks.cjs

@@ -1,92 +1,69 @@
-"use strict";
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+const require_iterateJsdoc = require('../iterateJsdoc.cjs');
+const comment_parser = require_rolldown_runtime.__toESM(require("comment-parser"));
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-var _commentParser = require("comment-parser");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-// Neither a single nor 3+ asterisks are valid jsdoc per
-//  https://jsdoc.app/about-getting-started.html#adding-documentation-comments-to-your-code
+//#region src/rules/noBadBlocks.js
 const commentRegexp = /^\/\*(?!\*)/v;
 const extraAsteriskCommentRegexp = /^\/\*{3,}/v;
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  allComments,
-  context,
-  makeReport,
-  sourceCode
-}) => {
-  const [{
-    ignore = ['ts-check', 'ts-expect-error', 'ts-ignore', 'ts-nocheck'],
-    preventAllMultiAsteriskBlocks = false
-  } = {}] = context.options;
-  let extraAsterisks = false;
-  const nonJsdocNodes = /** @type {import('estree').Node[]} */allComments.filter(comment => {
-    const commentText = sourceCode.getText(comment);
-    const initialText = commentText.replace(commentRegexp, '').trimStart();
-    if (['eslint'].some(directive => {
-      return initialText.startsWith(directive);
-    })) {
-      return false;
-    }
-    let sliceIndex = 2;
-    if (!commentRegexp.test(commentText)) {
-      const multiline = extraAsteriskCommentRegexp.exec(commentText)?.[0];
-      if (!multiline) {
-        return false;
-      }
-      sliceIndex = multiline.length;
-      extraAsterisks = true;
-      if (preventAllMultiAsteriskBlocks) {
-        return true;
-      }
-    }
-    const tags = ((0, _commentParser.parse)(`${commentText.slice(0, 2)}*${commentText.slice(sliceIndex)}`)[0] || {}).tags ?? [];
-    return tags.length && !tags.some(({
-      tag
-    }) => {
-      return ignore.includes(tag);
-    });
-  });
-  if (!nonJsdocNodes.length) {
-    return;
-  }
-  for (const node of nonJsdocNodes) {
-    const report = /** @type {import('../iterateJsdoc.js').MakeReport} */makeReport(context, node);
-
-    // eslint-disable-next-line no-loop-func
-    const fix = /** @type {import('eslint').Rule.ReportFixer} */fixer => {
-      const text = sourceCode.getText(node);
-      return fixer.replaceText(node, extraAsterisks ? text.replace(extraAsteriskCommentRegexp, '/**') : text.replace('/*', '/**'));
-    };
-    report('Expected JSDoc-like comment to begin with two asterisks.', fix);
-  }
+var noBadBlocks_default = require_iterateJsdoc.default(({ allComments, context, makeReport, sourceCode }) => {
+	const [{ ignore = [
+		"ts-check",
+		"ts-expect-error",
+		"ts-ignore",
+		"ts-nocheck"
+	], preventAllMultiAsteriskBlocks = false } = {}] = context.options;
+	let extraAsterisks = false;
+	const nonJsdocNodes = allComments.filter((comment) => {
+		const commentText = sourceCode.getText(comment);
+		const initialText = commentText.replace(commentRegexp, "").trimStart();
+		if (["eslint"].some((directive) => {
+			return initialText.startsWith(directive);
+		})) return false;
+		let sliceIndex = 2;
+		if (!commentRegexp.test(commentText)) {
+			const multiline = extraAsteriskCommentRegexp.exec(commentText)?.[0];
+			if (!multiline) return false;
+			sliceIndex = multiline.length;
+			extraAsterisks = true;
+			if (preventAllMultiAsteriskBlocks) return true;
+		}
+		const tags = ((0, comment_parser.parse)(`${commentText.slice(0, 2)}*${commentText.slice(sliceIndex)}`)[0] || {}).tags ?? [];
+		return tags.length && !tags.some(({ tag }) => {
+			return ignore.includes(tag);
+		});
+	});
+	if (!nonJsdocNodes.length) return;
+	for (const node of nonJsdocNodes) {
+		const report = makeReport(context, node);
+		const fix = (fixer) => {
+			const text = sourceCode.getText(node);
+			return fixer.replaceText(node, extraAsterisks ? text.replace(extraAsteriskCommentRegexp, "/**") : text.replace("/*", "/**"));
+		};
+		report("Expected JSDoc-like comment to begin with two asterisks.", fix);
+	}
 }, {
-  checkFile: true,
-  meta: {
-    docs: {
-      description: 'This rule checks for multi-line-style comments which fail to meet the criteria of a jsdoc block.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-bad-blocks.md#repos-sticky-header'
-    },
-    fixable: 'code',
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        ignore: {
-          items: {
-            type: 'string'
-          },
-          type: 'array'
-        },
-        preventAllMultiAsteriskBlocks: {
-          type: 'boolean'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'layout'
-  }
+	checkFile: true,
+	meta: {
+		docs: {
+			description: "This rule checks for multi-line-style comments which fail to meet the criteria of a jsdoc block.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-bad-blocks.md#repos-sticky-header"
+		},
+		fixable: "code",
+		schema: [{
+			additionalProperties: false,
+			properties: {
+				ignore: {
+					items: { type: "string" },
+					type: "array"
+				},
+				preventAllMultiAsteriskBlocks: { type: "boolean" }
+			},
+			type: "object"
+		}],
+		type: "layout"
+	}
 });
-module.exports = exports.default;
+
+//#endregion
+exports.default = noBadBlocks_default;
 //# sourceMappingURL=noBadBlocks.cjs.map

package/dist/rules/noBadBlocks.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"noBadBlocks.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","_commentParser","e","__esModule","default","commentRegexp","extraAsteriskCommentRegexp","_default","exports","iterateJsdoc","allComments","context","makeReport","sourceCode","ignore","preventAllMultiAsteriskBlocks","options","extraAsterisks","nonJsdocNodes","filter","comment","commentText","getText","initialText","replace","trimStart","some","directive","startsWith","sliceIndex","test","multiline","exec","length","tags","commentParser","slice","tag","includes","node","report","fix","fixer","text","replaceText","checkFile","meta","docs","description","url","fixable","schema","additionalProperties","properties","items","type","module"],"sources":["../../src/rules/noBadBlocks.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  parse as commentParser,\n} from 'comment-parser';\n\n// Neither a single nor 3+ asterisks are valid jsdoc per\n//  https://jsdoc.app/about-getting-started.html#adding-documentation-comments-to-your-code\nconst commentRegexp = /^\\/\\*(?!\\*)/v;\nconst extraAsteriskCommentRegexp = /^\\/\\*{3,}/v;\n\nexport default iterateJsdoc(({\n  allComments,\n  context,\n  makeReport,\n  sourceCode,\n}) => {\n  const [\n    {\n      ignore = [\n        'ts-check',\n        'ts-expect-error',\n        'ts-ignore',\n        'ts-nocheck',\n      ],\n      preventAllMultiAsteriskBlocks = false,\n    } = {},\n  ] = context.options;\n\n  let extraAsterisks = false;\n  const nonJsdocNodes = /** @type {import('estree').Node[]} */ (\n    allComments\n  ).filter((comment) => {\n    const commentText = sourceCode.getText(comment);\n\n    const initialText = commentText.replace(commentRegexp, '').trimStart();\n    if ([\n      'eslint',\n    ].some((directive) => {\n      return initialText.startsWith(directive);\n    })) {\n      return false;\n    }\n\n    let sliceIndex = 2;\n    if (!commentRegexp.test(commentText)) {\n      const multiline = extraAsteriskCommentRegexp.exec(commentText)?.[0];\n      if (!multiline) {\n        return false;\n      }\n\n      sliceIndex = multiline.length;\n      extraAsterisks = true;\n      if (preventAllMultiAsteriskBlocks) {\n        return true;\n      }\n    }\n\n    const tags = (commentParser(\n      `${commentText.slice(0, 2)}*${commentText.slice(sliceIndex)}`,\n    )[0] || {}).tags ?? [];\n\n    return tags.length && !tags.some(({\n      tag,\n    }) => {\n      return ignore.includes(tag);\n    });\n  });\n\n  if (!nonJsdocNodes.length) {\n    return;\n  }\n\n  for (const node of nonJsdocNodes) {\n    const report = /** @type {import('../iterateJsdoc.js').MakeReport} */ (\n      makeReport\n    )(context, node);\n\n    // eslint-disable-next-line no-loop-func\n    const fix = /** @type {import('eslint').Rule.ReportFixer} */ (fixer) => {\n      const text = sourceCode.getText(node);\n\n      return fixer.replaceText(\n        node,\n        extraAsterisks ?\n          text.replace(extraAsteriskCommentRegexp, '/**') :\n          text.replace('/*', '/**'),\n      );\n    };\n\n    report('Expected JSDoc-like comment to begin with two asterisks.', fix);\n  }\n}, {\n  checkFile: true,\n  meta: {\n    docs: {\n      description: 'This rule checks for multi-line-style comments which fail to meet the criteria of a jsdoc block.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-bad-blocks.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          ignore: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          preventAllMultiAsteriskBlocks: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'layout',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,cAAA,GAAAD,OAAA;AAEwB,SAAAD,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAExB;AACA;AACA,MAAMG,aAAa,GAAG,cAAc;AACpC,MAAMC,0BAA0B,GAAG,YAAY;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAJ,OAAA,GAEjC,IAAAK,qBAAY,EAAC,CAAC;EAC3BC,WAAW;EACXC,OAAO;EACPC,UAAU;EACVC;AACF,CAAC,KAAK;EACJ,MAAM,CACJ;IACEC,MAAM,GAAG,CACP,UAAU,EACV,iBAAiB,EACjB,WAAW,EACX,YAAY,CACb;IACDC,6BAA6B,GAAG;EAClC,CAAC,GAAG,CAAC,CAAC,CACP,GAAGJ,OAAO,CAACK,OAAO;EAEnB,IAAIC,cAAc,GAAG,KAAK;EAC1B,MAAMC,aAAa,GAAG,sCACpBR,WAAW,CACXS,MAAM,CAAEC,OAAO,IAAK;IACpB,MAAMC,WAAW,GAAGR,UAAU,CAACS,OAAO,CAACF,OAAO,CAAC;IAE/C,MAAMG,WAAW,GAAGF,WAAW,CAACG,OAAO,CAACnB,aAAa,EAAE,EAAE,CAAC,CAACoB,SAAS,CAAC,CAAC;IACtE,IAAI,CACF,QAAQ,CACT,CAACC,IAAI,CAAEC,SAAS,IAAK;MACpB,OAAOJ,WAAW,CAACK,UAAU,CAACD,SAAS,CAAC;IAC1C,CAAC,CAAC,EAAE;MACF,OAAO,KAAK;IACd;IAEA,IAAIE,UAAU,GAAG,CAAC;IAClB,IAAI,CAACxB,aAAa,CAACyB,IAAI,CAACT,WAAW,CAAC,EAAE;MACpC,MAAMU,SAAS,GAAGzB,0BAA0B,CAAC0B,IAAI,CAACX,WAAW,CAAC,GAAG,CAAC,CAAC;MACnE,IAAI,CAACU,SAAS,EAAE;QACd,OAAO,KAAK;MACd;MAEAF,UAAU,GAAGE,SAAS,CAACE,MAAM;MAC7BhB,cAAc,GAAG,IAAI;MACrB,IAAIF,6BAA6B,EAAE;QACjC,OAAO,IAAI;MACb;IACF;IAEA,MAAMmB,IAAI,GAAG,CAAC,IAAAC,oBAAa,EACzB,GAAGd,WAAW,CAACe,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAIf,WAAW,CAACe,KAAK,CAACP,UAAU,CAAC,EAC7D,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAEK,IAAI,IAAI,EAAE;IAEtB,OAAOA,IAAI,CAACD,MAAM,IAAI,CAACC,IAAI,CAACR,IAAI,CAAC,CAAC;MAChCW;IACF,CAAC,KAAK;MACJ,OAAOvB,MAAM,CAACwB,QAAQ,CAACD,GAAG,CAAC;IAC7B,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF,IAAI,CAACnB,aAAa,CAACe,MAAM,EAAE;IACzB;EACF;EAEA,KAAK,MAAMM,IAAI,IAAIrB,aAAa,EAAE;IAChC,MAAMsB,MAAM,GAAG,sDACb5B,UAAU,CACVD,OAAO,EAAE4B,IAAI,CAAC;;IAEhB;IACA,MAAME,GAAG,GAAG,gDAAkDC,KAAK,IAAK;MACtE,MAAMC,IAAI,GAAG9B,UAAU,CAACS,OAAO,CAACiB,IAAI,CAAC;MAErC,OAAOG,KAAK,CAACE,WAAW,CACtBL,IAAI,EACJtB,cAAc,GACZ0B,IAAI,CAACnB,OAAO,CAAClB,0BAA0B,EAAE,KAAK,CAAC,GAC/CqC,IAAI,CAACnB,OAAO,CAAC,IAAI,EAAE,KAAK,CAC5B,CAAC;IACH,CAAC;IAEDgB,MAAM,CAAC,0DAA0D,EAAEC,GAAG,CAAC;EACzE;AACF,CAAC,EAAE;EACDI,SAAS,EAAE,IAAI;EACfC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,kGAAkG;MAC/GC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVvC,MAAM,EAAE;UACNwC,KAAK,EAAE;YACLC,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACDxC,6BAA6B,EAAE;UAC7BwC,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAC,MAAA,CAAAhD,OAAA,GAAAA,OAAA,CAAAJ,OAAA","ignoreList":[]}
+{"version":3,"file":"noBadBlocks.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/noBadBlocks.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  parse as commentParser,\n} from 'comment-parser';\n\n// Neither a single nor 3+ asterisks are valid jsdoc per\n//  https://jsdoc.app/about-getting-started.html#adding-documentation-comments-to-your-code\nconst commentRegexp = /^\\/\\*(?!\\*)/v;\nconst extraAsteriskCommentRegexp = /^\\/\\*{3,}/v;\n\nexport default iterateJsdoc(({\n  allComments,\n  context,\n  makeReport,\n  sourceCode,\n}) => {\n  const [\n    {\n      ignore = [\n        'ts-check',\n        'ts-expect-error',\n        'ts-ignore',\n        'ts-nocheck',\n      ],\n      preventAllMultiAsteriskBlocks = false,\n    } = {},\n  ] = context.options;\n\n  let extraAsterisks = false;\n  const nonJsdocNodes = /** @type {import('estree').Node[]} */ (\n    allComments\n  ).filter((comment) => {\n    const commentText = sourceCode.getText(comment);\n\n    const initialText = commentText.replace(commentRegexp, '').trimStart();\n    if ([\n      'eslint',\n    ].some((directive) => {\n      return initialText.startsWith(directive);\n    })) {\n      return false;\n    }\n\n    let sliceIndex = 2;\n    if (!commentRegexp.test(commentText)) {\n      const multiline = extraAsteriskCommentRegexp.exec(commentText)?.[0];\n      if (!multiline) {\n        return false;\n      }\n\n      sliceIndex = multiline.length;\n      extraAsterisks = true;\n      if (preventAllMultiAsteriskBlocks) {\n        return true;\n      }\n    }\n\n    const tags = (commentParser(\n      `${commentText.slice(0, 2)}*${commentText.slice(sliceIndex)}`,\n    )[0] || {}).tags ?? [];\n\n    return tags.length && !tags.some(({\n      tag,\n    }) => {\n      return ignore.includes(tag);\n    });\n  });\n\n  if (!nonJsdocNodes.length) {\n    return;\n  }\n\n  for (const node of nonJsdocNodes) {\n    const report = /** @type {import('../iterateJsdoc.js').MakeReport} */ (\n      makeReport\n    )(context, node);\n\n    // eslint-disable-next-line no-loop-func\n    const fix = /** @type {import('eslint').Rule.ReportFixer} */ (fixer) => {\n      const text = sourceCode.getText(node);\n\n      return fixer.replaceText(\n        node,\n        extraAsterisks ?\n          text.replace(extraAsteriskCommentRegexp, '/**') :\n          text.replace('/*', '/**'),\n      );\n    };\n\n    report('Expected JSDoc-like comment to begin with two asterisks.', fix);\n  }\n}, {\n  checkFile: true,\n  meta: {\n    docs: {\n      description: 'This rule checks for multi-line-style comments which fail to meet the criteria of a jsdoc block.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-bad-blocks.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          ignore: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          preventAllMultiAsteriskBlocks: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'layout',\n  },\n});\n"],"mappings":";;;;;AAOA,MAAM,gBAAgB;AACtB,MAAM,6BAA6B;AAEnC,0BAAeA,6BAAa,CAAC,EAC3B,aACA,SACA,YACA,YACD,KAAK;CACJ,MAAM,CACJ,EACE,SAAS;EACP;EACA;EACA;EACA;CACD,GACD,gCAAgC,OACjC,GAAG,CAAE,EACP,GAAG,QAAQ;CAEZ,IAAI,iBAAiB;CACrB,MAAM,gBACJ,YACA,OAAO,CAAC,YAAY;EACpB,MAAM,cAAc,WAAW,QAAQ,QAAQ;EAE/C,MAAM,cAAc,YAAY,QAAQ,eAAe,GAAG,CAAC,WAAW;AACtE,MAAI,CACF,QACD,EAAC,KAAK,CAAC,cAAc;AACpB,UAAO,YAAY,WAAW,UAAU;EACzC,EAAC,CACA,QAAO;EAGT,IAAI,aAAa;AACjB,MAAI,CAAC,cAAc,KAAK,YAAY,EAAE;GACpC,MAAM,YAAY,2BAA2B,KAAK,YAAY,GAAG;AACjE,OAAI,CAAC,UACH,QAAO;GAGT,aAAa,UAAU;GACvB,iBAAiB;AACjB,OAAI,8BACF,QAAO;EAEV;EAED,MAAM,kCACJ,GAAG,YAAY,MAAM,GAAG,EAAE,CAAC,CAAC,EAAE,YAAY,MAAM,WAAW,EAAE,CAC9D,CAAC,MAAM,CAAE,GAAE,QAAQ,CAAE;AAEtB,SAAO,KAAK,UAAU,CAAC,KAAK,KAAK,CAAC,EAChC,KACD,KAAK;AACJ,UAAO,OAAO,SAAS,IAAI;EAC5B,EAAC;CACH,EAAC;AAEF,KAAI,CAAC,cAAc,OACjB;AAGF,MAAK,MAAM,QAAQ,eAAe;EAChC,MAAM,SACJ,WACA,SAAS,KAAK;EAGhB,MAAM,MAAuD,CAAC,UAAU;GACtE,MAAM,OAAO,WAAW,QAAQ,KAAK;AAErC,UAAO,MAAM,YACX,MACA,iBACE,KAAK,QAAQ,4BAA4B,MAAM,GAC/C,KAAK,QAAQ,MAAM,MAAM,CAC5B;EACF;EAED,OAAO,4DAA4D,IAAI;CACxE;AACF,GAAE;CACD,WAAW;CACX,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,QAAQ;KACN,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,+BAA+B,EAC7B,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/noBadBlocks.js

@@ -0,0 +1,68 @@
+import iterateJsdoc from "../iterateJsdoc.js";
+import { parse } from "comment-parser";
+
+//#region src/rules/noBadBlocks.js
+const commentRegexp = /^\/\*(?!\*)/v;
+const extraAsteriskCommentRegexp = /^\/\*{3,}/v;
+var noBadBlocks_default = iterateJsdoc(({ allComments, context, makeReport, sourceCode }) => {
+	const [{ ignore = [
+		"ts-check",
+		"ts-expect-error",
+		"ts-ignore",
+		"ts-nocheck"
+	], preventAllMultiAsteriskBlocks = false } = {}] = context.options;
+	let extraAsterisks = false;
+	const nonJsdocNodes = allComments.filter((comment) => {
+		const commentText = sourceCode.getText(comment);
+		const initialText = commentText.replace(commentRegexp, "").trimStart();
+		if (["eslint"].some((directive) => {
+			return initialText.startsWith(directive);
+		})) return false;
+		let sliceIndex = 2;
+		if (!commentRegexp.test(commentText)) {
+			const multiline = extraAsteriskCommentRegexp.exec(commentText)?.[0];
+			if (!multiline) return false;
+			sliceIndex = multiline.length;
+			extraAsterisks = true;
+			if (preventAllMultiAsteriskBlocks) return true;
+		}
+		const tags = (parse(`${commentText.slice(0, 2)}*${commentText.slice(sliceIndex)}`)[0] || {}).tags ?? [];
+		return tags.length && !tags.some(({ tag }) => {
+			return ignore.includes(tag);
+		});
+	});
+	if (!nonJsdocNodes.length) return;
+	for (const node of nonJsdocNodes) {
+		const report = makeReport(context, node);
+		const fix = (fixer) => {
+			const text = sourceCode.getText(node);
+			return fixer.replaceText(node, extraAsterisks ? text.replace(extraAsteriskCommentRegexp, "/**") : text.replace("/*", "/**"));
+		};
+		report("Expected JSDoc-like comment to begin with two asterisks.", fix);
+	}
+}, {
+	checkFile: true,
+	meta: {
+		docs: {
+			description: "This rule checks for multi-line-style comments which fail to meet the criteria of a jsdoc block.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-bad-blocks.md#repos-sticky-header"
+		},
+		fixable: "code",
+		schema: [{
+			additionalProperties: false,
+			properties: {
+				ignore: {
+					items: { type: "string" },
+					type: "array"
+				},
+				preventAllMultiAsteriskBlocks: { type: "boolean" }
+			},
+			type: "object"
+		}],
+		type: "layout"
+	}
+});
+
+//#endregion
+export { noBadBlocks_default as default };
+//# sourceMappingURL=noBadBlocks.js.map