Skip to main content

Function: lintMarkdownWithRetext()

lintMarkdownWithRetext(text: string, configureProcessor: (processor: RetextConfigurableProcessor) => void, filter?: Readonly<RetextMessageFilterOptions>): readonly Readonly<{ actual: string | null; endOffset: number; expected: readonly string[]; note: string | null; reason: string; ruleId: string | null; source: RetextMessageSource; startOffset: number; }>[]

Defined in: _internal/retext.ts:235

Run one markdown-aware retext analysis pass against projected comment text.

Parameters​

text​

string

configureProcessor​

(processor: RetextConfigurableProcessor) => void

filter?​

Readonly<RetextMessageFilterOptions> = {}

Returns​

readonly Readonly<{ actual: string | null; endOffset: number; expected: readonly string[]; note: string | null; reason: string; ruleId: string | null; source: RetextMessageSource; startOffset: number; }>[]