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

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

import type { Context } from "../../typings.context.js";
import type { MultilineBlock } from "./typings.block.js";
/**
 * captures the next logical group/block in the provided multi-line comment
 * content, based on a set of rules.
 *
 * 1) Everything within a set of back-ticks (``) is ignored, as this is used
 * to explicitly declare that the content should not be auto-fixed.
 *
 * 2) Lines that are not on the same indentation-level will not be recognized
 * as part of the same block.
 *
 * 3) Lines separated by a new-line will not be considered as part of the same
 * block.
 *
 * 4) Lines will only be grouped in case the current line of the block to be
 * constructed actually is overflowing. This avoids issues where auto-fixing
 * 'sucks' a line up even though the previous line should have been considered
 * a logical end to a block.
 */
export declare function captureNextBlock(ignoreFollowingLines: boolean, initialStartIndex: number, context: Context): [Omit<MultilineBlock, "value">, boolean];
//# sourceMappingURL=util.capture-next-block.d.ts.map