lint-files.ts
7 documented symbols. Read the signatures first, then expand each item for parameters, return types, and examples.
Reference
fnlintMarkdownFile(filePath: string, options: MarkdownLintFileOptions = {}): Promise<MarkdownLintFileResult>Lints a single Markdown file using project-style include/exclude settings. If t…
Lints a single Markdown file using project-style include/exclude settings. If the file is filtered out by include / exclude, the returned result is marked as skipped and contains no diagnostics.
Parameters
-
filePathstring -
paramunknown
Returns
Promise
fnlintMarkdownFiles(options: MarkdownLintFileOptions = {}): Promise<MarkdownLintFilesResult>Lints all Markdown files matched by the configured include/exclude patterns.
Lints all Markdown files matched by the configured include/exclude patterns.
Parameters
-
paramunknown
Returns
Promise
interfaceMarkdownLintFileDiagnostic extends MarkdownLintDiagnosticA lint diagnostic annotated with file metadata.
A lint diagnostic annotated with file metadata.
interfaceMarkdownLintFileOptions extends MarkdownLintOptionsFile-oriented Markdown lint options for end-user configuration. This extends th…
File-oriented Markdown lint options for end-user configuration. This extends the content-level lint options with project-level targeting, so consumers can decide which files should be checked and which paths should be ignored.
interfaceMarkdownLintFileResult extends MarkdownLintResultLint result for a single file.
Lint result for a single file.
interfaceMarkdownLintFilesResultAggregated lint result for multiple files.
Aggregated lint result for multiple files.
fnshouldLintMarkdownFile(filePath: string, options: MarkdownLintFileOptions = {}): booleanReturns true if the file path is included by the configured glob filters.
Returns true if the file path is included by the configured glob filters.
Parameters
-
filePathstring -
paramunknown
Returns
boolean