lint-files.ts

7 documented symbols. Read the signatures first, then expand each item for parameters, return types, and examples.

7 symbols 3 functions 4 interfaces 5 parameters 15 members 3 returns

Reference

fnlintMarkdownFile(filePath: string, options: MarkdownLintFileOptions = {}): Promise<MarkdownLintFileResult>Lints a single Markdown file using project-style include/exclude settings. If t…2 paramsreturns Promise<MarkdownLintFileResult>

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.

Signature

export async function lintMarkdownFile(filePath: string, options: MarkdownLintFileOptions = {}): Promise<MarkdownLintFileResult>

View source

Parameters

filePath string
options MarkdownLintFileOptions

optional · default: {}

Returns

Promise<MarkdownLintFileResult>

fnlintMarkdownFiles(options: MarkdownLintFileOptions = {}): Promise<MarkdownLintFilesResult>Lints all Markdown files matched by the configured include/exclude patterns.1 paramreturns Promise<MarkdownLintFilesResult>

Lints all Markdown files matched by the configured include/exclude patterns.

Signature

export async function lintMarkdownFiles(options: MarkdownLintFileOptions = {}): Promise<MarkdownLintFilesResult>

View source

Parameters

options MarkdownLintFileOptions

optional · default: {}

Returns

Promise<MarkdownLintFilesResult>

interfaceMarkdownLintFileDiagnostic extends MarkdownLintDiagnosticA lint diagnostic annotated with file metadata.2 members

A lint diagnostic annotated with file metadata.

Signature

export interface MarkdownLintFileDiagnostic extends MarkdownLintDiagnostic

View source

Members

Properties

Name	Type	Description
`filePath`	`string`
`relativePath`	`string`

interfaceMarkdownLintFileOptions extends MarkdownLintOptionsFile-oriented Markdown lint options for end-user configuration. This extends th…4 members

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.

Signature

export interface MarkdownLintFileOptions extends MarkdownLintOptions

View source

Members

Properties

Name	Type	Description
`cwd`optional	`string`	Base directory used to resolve `include` and `exclude` patterns. Default `process.cwd()`
`exclude`optional	`string[]`	Glob patterns for files to exclude from linting. Default `['\/node_modules/', '\/.git/', '\/dist/']`
`ignore`optional	`string[]`	Alias of `exclude`. When omitted, only `exclude` is used. Default `undefined`
`include`optional	`string[]`	Glob patterns for files to lint. Default `['*\/.md', '*\/.markdown', '*\/.mdx']`

interfaceMarkdownLintFileResult extends MarkdownLintResultLint result for a single file.3 members

Lint result for a single file.

Signature

export interface MarkdownLintFileResult extends MarkdownLintResult

View source

Members

Properties

Name	Type	Description
`filePath`	`string`
`relativePath`	`string`
`skipped`	`boolean`

interfaceMarkdownLintFilesResultAggregated lint result for multiple files.6 members

Aggregated lint result for multiple files.

Signature

export interface MarkdownLintFilesResult

View source

Members

Properties

Name	Type	Description
`checkedFileCount`	`number`
`diagnostics`	`MarkdownLintFileDiagnostic[]`
`errorCount`	`number`
`files`	`MarkdownLintFileResult[]`
`infoCount`	`number`
`warningCount`	`number`

fnshouldLintMarkdownFile(filePath: string, options: MarkdownLintFileOptions = {}): booleanReturns true if the file path is included by the configured glob filters.2 paramsreturns boolean

Returns true if the file path is included by the configured glob filters.

Signature

export function shouldLintMarkdownFile(filePath: string, options: MarkdownLintFileOptions = {}): boolean

View source

Parameters

filePath string
options MarkdownLintFileOptions

optional · default: {}

Returns

boolean