@mermaid-lint/core
    Preparing search index...

    Interface MermaidLintConfig

    Resolved mermaid-lint configuration, as loaded from a config file or the mermaidLint field in package.json.

    interface MermaidLintConfig {
        extensions?: string[];
        fences?: FenceMarker[];
        files?: string[];
        format?: "text" | "json";
        ignore?: string[];
        rules?: Partial<Record<RuleId, RuleSeverity>>;
        semantic?: boolean;
        strict?: boolean;
    }
    Index

    Properties

    extensions? fences? files? format? ignore? rules? semantic? strict?

    Properties

    extensions?: string[]

    Extra file extensions to include in auto-discovery, beyond the built-in markdown family (.md, .mdx, .markdown, .mmd). E.g. ["crv"] to lint Mermaid fences in Carve files. Merges with the --ext CLI flag.

    fences?: FenceMarker[]

    Which code-fence markers to recognize for Mermaid blocks. Defaults to both "backtick" (```mermaid) and "tilde" (~~~mermaid), matching CommonMark. Restrict to e.g. ["backtick"] to ignore tilde fences.

    files?: string[]

    Glob patterns of files to lint.

    format?: "text" | "json"

    Output format for the CLI.

    ignore?: string[]

    Glob patterns to exclude.

    rules?: Partial<Record<RuleId, RuleSeverity>>

    Per-rule severity overrides ("off" | "warn" | "error"), layered over the built-in defaults. E.g. { "prefer-flowchart": "off", "duplicate-ids": "error" }. Ignored when semantic is false (which disables every rule).

    semantic?: boolean

    Enable semantic checks (e.g. duplicate-id detection).

    strict?: boolean

    Treat semantic warnings as errors.

    Settings

    Member Visibility

    On This Page

    Properties