Skip to content

markdownlint

markdownlint-cli2 documentation

toolroom._stubs.markdownlint.Markdownlint

Bases: Tool[_R]

__call__ 

__call__(
    *args: str | PathLike[str],
    config: Value = ...,
    configPointer: Value = ...,
    fix: Flag = ...,
    format: Flag = ...,
    no_globs: Flag = ...,
    **flags: Any,
) -> _R

Run this verb.

Parameters:

Name Type Description Default
config Value

specifies the path to a configuration file to define the base configuration.

 ...
configPointer Value

specifies a JSON Pointer to a configuration object within the --config file. Added in 0.22.0.

 ...
fix Flag

updates files to resolve fixable issues (can be overridden in configuration).

 ...
format Flag

reads standard input (stdin), applies fixes, writes standard output (stdout). Added in 0.19.0.

 ...
no_globs Flag

ignores the "globs" property if present in the top-level options object.

 ...