LintOptions

Parameters for the lint function.

Import:

import type { LintOptions } from '@mnaoumov/typescript-dev-toolkit/linters/markdownlint';

Signature:

export interface LintOptions

Properties

Property	Type	Description
defaultConfigFilePath?	string | undefined	The configuration file copied to the project root when the project has none. Without it, markdownlint-cli2 runs with its own defaults.
linkCheckExcludeGlobs?	readonly string[] | undefined	Globs, relative to the root folder, of markdown files to leave out of the linkinator pass only; markdownlint-cli2 still lints them. For a documentation site whose pages link to each other base-absolutely (/<site-base>/guides/...): those links resolve only against the BUILT site, so linkinator reports each one as a 404, and the site's own build is what checks them.
paths?	string[] | undefined	Optional file paths to lint. If omitted, lints the entire project.
shouldFix?	boolean | undefined	Whether to fix linting issues automatically.

---

Links to this page:

• lint