Skip to content

LintMarkdownContentParams

Parameters for lintMarkdownContent.

Import:

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

Signature:

export interface LintMarkdownContentParams

Properties

PropertyTypeDescription
contentstringThe markdown to lint.
cwd?string | undefinedA folder inside the project whose markdownlint configuration applies. Defaults to the current working folder. In a workspace, a package's own folder has no configuration of its own, so a caller linting for the workspace root names it here.
filePathstringThe path the content is linted AS — normally the path it is about to be written to. It decides how the path-relative rules resolve (relative-links walks from the file's own folder), and it is what every reported finding is named after.

Links to this page: