eslint-plugin-comment-length/lib/cjs/rules/limit-multi-line-comments/util.capture-next-block.cjs.map

An ESLint plugin that provides rules that limit the line length of your comments

{"version":3,"file":"util.capture-next-block.cjs","sources":["../../../../src/rules/limit-multi-line-comments/util.capture-next-block.ts"],"sourcesContent":["import type { Context } from \"../../typings.context.js\";\nimport { isLineOverflowing } from \"../../utils/is-line-overflowing.js\";\n\nimport type { MultilineBlock } from \"./typings.block.js\";\n\n/**\n * captures the next logical group/block in the provided multi-line comment\n * content, based on a set of rules.\n *\n * 1) Everything within a set of back-ticks (``) is ignored, as this is used\n * to explicitly declare that the content should not be auto-fixed.\n *\n * 2) Lines that are not on the same indentation-level will not be recognized\n * as part of the same block.\n *\n * 3) Lines separated by a new-line will not be considered as part of the same\n * block.\n *\n * 4) Lines will only be grouped in case the current line of the block to be\n * constructed actually is overflowing. This avoids issues where auto-fixing\n * 'sucks' a line up even though the previous line should have been considered\n * a logical end to a block.\n */\nexport function captureNextBlock(\n  ignoreFollowingLines: boolean,\n  initialStartIndex: number,\n  context: Context,\n): [Omit<MultilineBlock, \"value\">, boolean] {\n  let ignoreLines = ignoreFollowingLines;\n  let startIndex = initialStartIndex;\n\n  // the provided startIndex may not necessarily indicate the startIndex of the\n  // next logical block. (it may e.g. just point to a blank line)\n  // as such we need to determine the actual start of the next block.\n  for (let i = initialStartIndex; i < context.comment.lines.length; i++) {\n    const line = context.comment.lines[i];\n\n    // ensure that lines within backticks is skipped (and that the line itself\n    // is ignored as it acts as a marker).\n    if (\n      line?.trimStart().startsWith(\"` \") ||\n      line?.trimStart().startsWith(\"``\")\n    ) {\n      ignoreLines = !ignoreLines;\n      continue;\n    }\n\n    startIndex = i;\n\n    if (line && line.trim() !== \"\" && !ignoreLines) {\n      break;\n    }\n  }\n\n  const blockLines: string[] = context.comment.lines.slice(\n    startIndex,\n    startIndex + 1,\n  );\n\n  // In case we could not resolve the start of a new block, then we cannot\n  // continue...\n  if (blockLines.length === 0) {\n    return [\n      {\n        lines: blockLines,\n        startIndex,\n        endIndex: startIndex,\n        lineOffsets: [],\n      },\n      ignoreLines,\n    ];\n  }\n\n  // ... else we can begin analysing the following lines to determine if they\n  // are to be added to the current group\n  for (let i = startIndex; i < context.comment.lines.length; i++) {\n    const currLine = context.comment.lines[i];\n    const nextLine = context.comment.lines[i + 1];\n\n    if (!currLine) {\n      break;\n    }\n\n    const currLineOffset =\n      currLine\n        .match(/^( |\\t)*/)?.[0]\n        ?.split(\"\")\n        .reduce(\n          (acc, curr) => acc + (curr === \"\\t\" ? context.tabSize : 1),\n          0,\n        ) ?? 0;\n\n    const nextLineOffset =\n      nextLine\n        ?.match(/^( |\\t)*/)?.[0]\n        ?.split(\"\")\n        .reduce(\n          (acc, curr) => acc + (curr === \"\\t\" ? context.tabSize : 1),\n          0,\n        ) ?? 0;\n\n    if (\n      !nextLine ||\n      nextLine.trim() === \"\" ||\n      currLineOffset !== nextLineOffset ||\n      (context.mode === \"overflow-only\" &&\n        !isLineOverflowing(\n          `${currLine} ${nextLine.trimStart().split(\" \")[0] ?? \"\"}`.trimEnd(),\n          context,\n        ))\n    ) {\n      return [\n        {\n          lines: blockLines,\n          startIndex,\n          endIndex: i,\n          lineOffsets: blockLines.map((it, lineIndex) => {\n            const whitespaceString = context.comment.value\n              .split(\"\\n\")\n              [startIndex + lineIndex]?.includes(\"*\")\n              ? (it.match(/^( |\\t)*/)?.[0] ?? \"\")\n              : \" \";\n\n            return {\n              string: whitespaceString,\n              size:\n                whitespaceString\n                  .split(\"\")\n                  .reduce(\n                    (acc, curr) => acc + (curr === \"\\t\" ? context.tabSize : 1),\n                    0,\n                  ) ?? 0,\n            };\n          }),\n        },\n        ignoreLines,\n      ];\n    }\n\n    blockLines.push(nextLine);\n  }\n\n  return [\n    {\n      lines: blockLines,\n      startIndex,\n      endIndex: context.comment.lines.length,\n      lineOffsets: blockLines.map((it, lineIndex) => {\n        const whitespaceString = context.comment.value\n          .split(\"\\n\")\n          [startIndex + lineIndex]?.includes(\"*\")\n          ? (it.match(/^( |\\t)*/)?.[0] ?? \"\")\n          : \" \";\n\n        return {\n          string: whitespaceString,\n          size:\n            whitespaceString\n              .split(\"\")\n              .reduce(\n                (acc, curr) => acc + (curr === \"\\t\" ? context.tabSize : 1),\n                0,\n              ) ?? 0,\n        };\n      }),\n    },\n    ignoreLines,\n  ];\n}\n"],"names":["isLineOverflowing"],"mappings":";;;;AAuBgB,SAAA,gBAAA,CACd,oBACA,EAAA,iBAAA,EACA,OAC0C,EAAA;AAC1C,EAAA,IAAI,WAAc,GAAA,oBAAA,CAAA;AAClB,EAAA,IAAI,UAAa,GAAA,iBAAA,CAAA;AAKjB,EAAA,KAAA,IAAS,IAAI,iBAAmB,EAAA,CAAA,GAAI,QAAQ,OAAQ,CAAA,KAAA,CAAM,QAAQ,CAAK,EAAA,EAAA;AACrE,IAAA,MAAM,IAAO,GAAA,OAAA,CAAQ,OAAQ,CAAA,KAAA,CAAM,CAAC,CAAA,CAAA;AAIpC,IACE,IAAA,IAAA,EAAM,SAAU,EAAA,CAAE,UAAW,CAAA,IAAI,CACjC,IAAA,IAAA,EAAM,SAAU,EAAA,CAAE,UAAW,CAAA,IAAI,CACjC,EAAA;AACA,MAAA,WAAA,GAAc,CAAC,WAAA,CAAA;AACf,MAAA,SAAA;AAAA,KACF;AAEA,IAAa,UAAA,GAAA,CAAA,CAAA;AAEb,IAAA,IAAI,QAAQ,IAAK,CAAA,IAAA,EAAW,KAAA,EAAA,IAAM,CAAC,WAAa,EAAA;AAC9C,MAAA,MAAA;AAAA,KACF;AAAA,GACF;AAEA,EAAM,MAAA,UAAA,GAAuB,OAAQ,CAAA,OAAA,CAAQ,KAAM,CAAA,KAAA;AAAA,IACjD,UAAA;AAAA,IACA,UAAa,GAAA,CAAA;AAAA,GACf,CAAA;AAIA,EAAI,IAAA,UAAA,CAAW,WAAW,CAAG,EAAA;AAC3B,IAAO,OAAA;AAAA,MACL;AAAA,QACE,KAAO,EAAA,UAAA;AAAA,QACP,UAAA;AAAA,QACA,QAAU,EAAA,UAAA;AAAA,QACV,aAAa,EAAC;AAAA,OAChB;AAAA,MACA,WAAA;AAAA,KACF,CAAA;AAAA,GACF;AAIA,EAAA,KAAA,IAAS,IAAI,UAAY,EAAA,CAAA,GAAI,QAAQ,OAAQ,CAAA,KAAA,CAAM,QAAQ,CAAK,EAAA,EAAA;AAC9D,IAAA,MAAM,QAAW,GAAA,OAAA,CAAQ,OAAQ,CAAA,KAAA,CAAM,CAAC,CAAA,CAAA;AACxC,IAAA,MAAM,QAAW,GAAA,OAAA,CAAQ,OAAQ,CAAA,KAAA,CAAM,IAAI,CAAC,CAAA,CAAA;AAE5C,IAAA,IAAI,CAAC,QAAU,EAAA;AACb,MAAA,MAAA;AAAA,KACF;AAEA,IAAM,MAAA,cAAA,GACJ,SACG,KAAM,CAAA,UAAU,IAAI,CAAC,CAAA,EACpB,KAAM,CAAA,EAAE,CACT,CAAA,MAAA;AAAA,MACC,CAAC,GAAK,EAAA,IAAA,KAAS,OAAO,IAAS,KAAA,GAAA,GAAO,QAAQ,OAAU,GAAA,CAAA,CAAA;AAAA,MACxD,CAAA;AAAA,KACG,IAAA,CAAA,CAAA;AAET,IAAM,MAAA,cAAA,GACJ,UACI,KAAM,CAAA,UAAU,IAAI,CAAC,CAAA,EACrB,KAAM,CAAA,EAAE,CACT,CAAA,MAAA;AAAA,MACC,CAAC,GAAK,EAAA,IAAA,KAAS,OAAO,IAAS,KAAA,GAAA,GAAO,QAAQ,OAAU,GAAA,CAAA,CAAA;AAAA,MACxD,CAAA;AAAA,KACG,IAAA,CAAA,CAAA;AAET,IACE,IAAA,CAAC,QACD,IAAA,QAAA,CAAS,IAAK,EAAA,KAAM,EACpB,IAAA,cAAA,KAAmB,cAClB,IAAA,OAAA,CAAQ,IAAS,KAAA,eAAA,IAChB,CAACA,mCAAA;AAAA,MACC,CAAG,EAAA,QAAQ,CAAI,CAAA,EAAA,QAAA,CAAS,SAAU,EAAA,CAAE,KAAM,CAAA,GAAG,CAAE,CAAA,CAAC,CAAK,IAAA,EAAE,GAAG,OAAQ,EAAA;AAAA,MAClE,OAAA;AAAA,KAEJ,EAAA;AACA,MAAO,OAAA;AAAA,QACL;AAAA,UACE,KAAO,EAAA,UAAA;AAAA,UACP,UAAA;AAAA,UACA,QAAU,EAAA,CAAA;AAAA,UACV,WAAa,EAAA,UAAA,CAAW,GAAI,CAAA,CAAC,IAAI,SAAc,KAAA;AAC7C,YAAA,MAAM,mBAAmB,OAAQ,CAAA,OAAA,CAAQ,MACtC,KAAM,CAAA,IAAI,EACV,UAAa,GAAA,SAAS,GAAG,QAAS,CAAA,GAAG,IACnC,EAAG,CAAA,KAAA,CAAM,UAAU,CAAI,GAAA,CAAC,KAAK,EAC9B,GAAA,GAAA,CAAA;AAEJ,YAAO,OAAA;AAAA,cACL,MAAQ,EAAA,gBAAA;AAAA,cACR,IACE,EAAA,gBAAA,CACG,KAAM,CAAA,EAAE,CACR,CAAA,MAAA;AAAA,gBACC,CAAC,GAAK,EAAA,IAAA,KAAS,OAAO,IAAS,KAAA,GAAA,GAAO,QAAQ,OAAU,GAAA,CAAA,CAAA;AAAA,gBACxD,CAAA;AAAA,eACG,IAAA,CAAA;AAAA,aACX,CAAA;AAAA,WACD,CAAA;AAAA,SACH;AAAA,QACA,WAAA;AAAA,OACF,CAAA;AAAA,KACF;AAEA,IAAA,UAAA,CAAW,KAAK,QAAQ,CAAA,CAAA;AAAA,GAC1B;AAEA,EAAO,OAAA;AAAA,IACL;AAAA,MACE,KAAO,EAAA,UAAA;AAAA,MACP,UAAA;AAAA,MACA,QAAA,EAAU,OAAQ,CAAA,OAAA,CAAQ,KAAM,CAAA,MAAA;AAAA,MAChC,WAAa,EAAA,UAAA,CAAW,GAAI,CAAA,CAAC,IAAI,SAAc,KAAA;AAC7C,QAAA,MAAM,mBAAmB,OAAQ,CAAA,OAAA,CAAQ,MACtC,KAAM,CAAA,IAAI,EACV,UAAa,GAAA,SAAS,GAAG,QAAS,CAAA,GAAG,IACnC,EAAG,CAAA,KAAA,CAAM,UAAU,CAAI,GAAA,CAAC,KAAK,EAC9B,GAAA,GAAA,CAAA;AAEJ,QAAO,OAAA;AAAA,UACL,MAAQ,EAAA,gBAAA;AAAA,UACR,IACE,EAAA,gBAAA,CACG,KAAM,CAAA,EAAE,CACR,CAAA,MAAA;AAAA,YACC,CAAC,GAAK,EAAA,IAAA,KAAS,OAAO,IAAS,KAAA,GAAA,GAAO,QAAQ,OAAU,GAAA,CAAA,CAAA;AAAA,YACxD,CAAA;AAAA,WACG,IAAA,CAAA;AAAA,SACX,CAAA;AAAA,OACD,CAAA;AAAA,KACH;AAAA,IACA,WAAA;AAAA,GACF,CAAA;AACF;;;;"}