/** * @packageDocumentation * Shared helpers for linting natural-language source comments. */ import { type TSESLint, type TSESTree } from "@typescript-eslint/utils"; /** * Prefix families for comments that should be ignored rather than linted as * prose. */ export type IgnoredCommentPrefixes = Readonly<{ directive: readonly string[]; namespace: readonly string[]; }>; /** * Prefix families for comments that should be ignored rather than linted as * prose. */ export declare const ignoredCommentPrefixes: IgnoredCommentPrefixes; /** * Determine whether a comment should be ignored entirely. * * @param commentText - Trimmed comment text after block-comment normalization. * * @returns `true` when the comment is a directive or empty. */ export declare const isIgnoredCommentText: (commentText: string) => boolean; /** * Neutralize decorative block-comment prefixes while preserving source offsets. * * @param comment - Source comment token. * * @returns Lint text with stable indexing relative to `comment.value`. */ export declare const createCommentLintText: (comment: Readonly) => string; /** * Convert a comment-relative text span into an ESLint source location. * * @param comment - Source comment token. * @param sourceCode - Source code utility object. * @param startOffset - Inclusive start offset within `comment.value`. * @param endOffset - Exclusive end offset within `comment.value`. * * @returns ESLint location for the requested span. */ export declare const createCommentValueSourceLocation: (comment: Readonly, sourceCode: Readonly, startOffset: number, endOffset: number) => TSESLint.AST.SourceLocation; //# sourceMappingURL=comment-prose.d.ts.map