lint.ts
9 documented symbols. Read the signatures first, then expand each item for parameters, return types, and examples.
Reference
fnlintMarkdown(source: string, options: MarkdownLintOptions = {}): MarkdownLintResultLints Markdown prose with the Rust-backed built-in rule engine.
Lints Markdown prose with the Rust-backed built-in rule engine.
Parameters
-
sourcestring -
paramunknown
Returns
MarkdownLintResult
fnlintMarkdownAsync(source: string, options: MarkdownLintOptions = {}): Promise<MarkdownLintResult>Async Markdown linter that supports opt-in standard dictionaries.
Async Markdown linter that supports opt-in standard dictionaries.
Parameters
-
sourcestring -
paramunknown
Returns
Promise
fnlintMarkdownDocumentsAsync(sources: string[], options: MarkdownLintOptions = {}): Promise<MarkdownLintResult[]>Internal batched Markdown linting entry point used by file-based workflows.
Internal batched Markdown linting entry point used by file-based workflows.
Parameters
-
sourcesstring[] -
paramunknown
Returns
Promise
interfaceMarkdownLintDiagnosticA single Markdown lint diagnostic.
A single Markdown lint diagnostic.
interfaceMarkdownLintDictionaryOptionsAdditional dictionary configuration for the Markdown linter.
Additional dictionary configuration for the Markdown linter.
interfaceMarkdownLintOptionsOptions for linting Markdown documents.
Options for linting Markdown documents.
interfaceMarkdownLintResultMarkdown lint report.
Markdown lint report.
interfaceMarkdownLintRuleOptionsRule switches for Markdown linting.
Rule switches for Markdown linting.
interfaceMarkdownLintStandardDictionaryOptionsOpt-in standard dictionary sources. The default provider uses CSpell dictionary…
Opt-in standard dictionary sources. The default provider uses CSpell dictionary packages because those packages are actively maintained and expose locale-specific dictionaries in a stable config format. Languages without a bundled preset can still be added through custom imports.