Interface PRCheckMateConfig

interface PRCheckMateConfig {
    bannedImports?: {
        message?: string;
        name: string;
        severity?: "warn" | "error";
    }[];
    caseCollision?: { enabled?: boolean };
    circularDeps?: {
        enabled?: boolean;
        ignore?: string[];
        severity?: "warn" | "error";
        timeoutMs?: number;
    };
    commitlint?: { enabled?: boolean; ignores?: string[]; types?: string[] };
    configValidation?: {
        allowUnknownKeys?: string[];
        enabled?: boolean;
        severity?: "warn" | "error";
        validateCheckNames?: boolean;
    };
    coverage?: {
        enabled?: boolean;
        reportPath?: string
        | string[];
        severity?: "warn" | "error";
    };
    cpp?: { clangFormat?: { style?: string }; enabled?: boolean };
    csharp?: { enabled?: boolean };
    cspell?: {
        dictionaries?: string[];
        enabled?: boolean;
        ignorePaths?: string[];
        ignoreRegExpList?: string[];
        language?: string;
        words?: string[];
    };
    customRules?: {
        exclude?: string[];
        flags?: string;
        include?: string[];
        message?: string;
        name: string;
        pattern: string;
        severity?: "warn"
        | "error";
    }[];
    deadCode?: { enabled?: boolean; ignoreFiles?: string[] };
    dependency?: { enabled?: boolean; ignore?: string[] };
    detect?: {
        disable?: Language[];
        excludePaths?: string[];
        minFiles?: number;
    };
    diffSecurity?: {
        commentHandling?: "off"
        | "language"
        | "legacy";
        dataflowWindow?: number;
        disablePatterns?: string[];
        enabled?: boolean;
        extraPatterns?: {
            flags?: string;
            label: string;
            pattern: string;
            severity?: "warn" | "error";
            view?: "code" | "raw";
        }[];
        failOn?: "warn"
        | "error"
        | "never";
        ignore?: string[];
        ignorePaths?: string[];
        severityOverrides?: Record<string, "warn" | "error" | "off">;
    };
    diffSmell?: { enabled?: boolean; ignorePaths?: string[] };
    dockerfileSecurity?: {
        enabled?: boolean;
        failOn?: "warn" | "error" | "never";
        ignore?: string[];
        ignorePaths?: string[];
        severityOverrides?: Record<string, "warn" | "error" | "off">;
    };
    duplicate?: {
        enabled?: boolean;
        formats?: string[];
        ignore?: string[];
        minLines?: number;
        minTokens?: number;
    };
    excludePaths?: string[];
    go?: { enabled?: boolean };
    grypeScan?: {
        enabled?: boolean;
        ignore?: string[];
        minSeverity?: "negligible" | "low" | "medium" | "high" | "critical";
        timeoutMs?: number;
    };
    ignoreDirs?: string[];
    install?: InstallConfig;
    kotlin?: { enabled?: boolean };
    languages?: Language[];
    largeFiles?: {
        allow?: string[];
        enabled?: boolean;
        maxSizeKb?: number;
        severity?: "warn" | "error";
    };
    leftoverDebug?: {
        commentHandling?: "off"
        | "language"
        | "legacy";
        enabled?: boolean;
        severity?: "warn" | "error";
    };
    licenseCheck?: { allowLicenses?: string[]; allowPackages?: string[] };
    licenseHeader?: { enabled?: boolean; lines?: number; pattern?: string };
    lint?: { ignorePatterns?: string[]; rules?: Record<string, any> };
    lockfileDrift?: { enabled?: boolean; severity?: "warn" | "error" };
    log?: {
        color?: "auto" | "always" | "never";
        format?: "pretty" | "ci" | "json";
        level?: "log" | "info" | "warn" | "error" | "debug";
        sampleLimit?: number;
        stderrLevels?: ("log" | "info" | "warn" | "error" | "debug")[];
        timestamps?: boolean;
    };
    mergeConflict?: { enabled?: boolean; severity?: "warn"
    | "error" };
    migrationSafety?: {
        enabled?: boolean;
        paths?: string[];
        severity?: "warn" | "error";
    };
    missingTests?: {
        enabled?: boolean;
        ignore?: string[];
        severity?: "warn"
        | "error";
    };
    outdatedDeps?: { enabled?: boolean; ignore?: string[]; timeoutMs?: number };
    packageSize?: {
        compareWith?: string;
        enabled?: boolean;
        maxGrowthPercent?: number;
    };
    php?: { enabled?: boolean };
    prBody?: { enabled?: boolean; minLength?: number; requireTicket?: boolean };
    prettier?: { config?: Record<string, any> };
    prSize?: { enabled?: boolean; maxFiles?: number; maxLines?: number };
    python?: {
        enabled?: boolean;
        ruff?: { format?: boolean; lint?: boolean };
        typecheck?: boolean;
        typeChecker?: "mypy" | "pyright";
    };
    reporter?: ReporterConfig;
    ruby?: { enabled?: boolean };
    run?: {
        checkTimeoutMs?: number;
        concurrency?: number | "auto" | "unlimited";
        fullScanBehaviour?: "skip" | "scan";
        heavyConcurrency?: number;
        onDegradedScope?: "warn" | "error" | "off";
        reportSkipped?: "auto" | "always" | "never";
        timings?: boolean;
    };
    rust?: { enabled?: boolean };
    security?: {
        gitleaks?: { depth?: number; enabled?: boolean; version?: string };
        "npm-audit"?: {
            auditLevel?: string;
            enabled?: boolean;
            ignore?: string[];
        };
    };
    sensitiveFileGuard?: {
        enabled?: boolean;
        failOn?: "warn"
        | "error"
        | "never";
        ignore?: string[];
        ignorePaths?: string[];
        severityOverrides?: Record<string, "warn" | "error" | "off">;
    };
    severity?: Record<string, "warn" | "error" | "off">;
    severityDefaults?: { failOn?: "warn" | "error" | "never" };
    shellcheck?: {
        enabled?: boolean;
        ignore?: string[];
        minSeverity?: "info" | "error" | "warning" | "style";
    };
    sourcePath: string
    | string[];
    spellcheck?: {
        enabled?: boolean;
        ignorePaths?: string[];
        ignoreWords?: string[];
        words?: string[];
    };
    swift?: { enabled?: boolean };
    symlinks?: {
        enabled?: boolean;
        ignore?: string[];
        severity?: "warn" | "error";
    };
    todoFixme?: {
        enabled?: boolean;
        keywords?: string[];
        requireTicket?: boolean;
        severity?: "warn"
        | "error";
    };
    typecheck?: { enabled?: boolean };
    vulnScan?: { enabled?: boolean; timeoutMs?: number };
    workflowSecurity?: {
        enabled?: boolean;
        failOn?: "warn" | "error" | "never";
        ignore?: string[];
        ignorePaths?: string[];
        severityOverrides?: Record<string, "warn" | "error" | "off">;
    };
    yamlLint?: {
        enabled?: boolean;
        ignore?: string[];
        severity?: "warn"
        | "error";
    };
}

Properties

`Optional`bannedImports

bannedImports?: { message?: string; name: string; severity?: "warn" | "error" }[]

`Optional`caseCollision

caseCollision?: { enabled?: boolean }

`Optional`circularDeps

circularDeps?: {
    enabled?: boolean;
    ignore?: string[];
    severity?: "warn" | "error";
    timeoutMs?: number;
}

`Optional`commitlint

commitlint?: { enabled?: boolean; ignores?: string[]; types?: string[] }

Type Declaration

Optionalenabled?: boolean
Optionalignores?: string[]

Regex sources (matched case-insensitively) for commit messages to skip, e.g. release PRs or squash-merge titles that don't follow conventional commits. Applied in addition to commitlint's built-in merge/revert ignores.
Optionaltypes?: string[]

`Optional`configValidation

configValidation?: {
    allowUnknownKeys?: string[];
    enabled?: boolean;
    severity?: "warn" | "error";
    validateCheckNames?: boolean;
}

`Optional`coverage

coverage?: {
    enabled?: boolean;
    reportPath?: string | string[];
    severity?: "warn" | "error";
}

`Optional`cpp

cpp?: { clangFormat?: { style?: string }; enabled?: boolean }

`Optional`csharp

csharp?: { enabled?: boolean }

`Optional`cspell

cspell?: {
    dictionaries?: string[];
    enabled?: boolean;
    ignorePaths?: string[];
    ignoreRegExpList?: string[];
    language?: string;
    words?: string[];
}

`Optional`customRules

customRules?: {
    exclude?: string[];
    flags?: string;
    include?: string[];
    message?: string;
    name: string;
    pattern: string;
    severity?: "warn" | "error";
}[]

`Optional`deadCode

deadCode?: { enabled?: boolean; ignoreFiles?: string[] }

Type Declaration

Optionalenabled?: boolean
OptionalignoreFiles?: string[]

Regex sources matched against reported file paths; matching files are dropped from the dead-code report. Use to exempt intentional public surface — a package entry point (src/index.ts) or re-export barrels whose exports are consumed by external installers, not within the repo. Applied to the report (not ts-unused-exports' own --ignoreFiles), so it never removes a file from analysis and cannot cascade onto other files. Defaults to test/mock files (see DEAD_CODE_IGNORE_DEFAULTS), whose exports are consumed only by the test runner and would otherwise show as unused. Setting this replaces the default list.

`Optional`dependency

dependency?: { enabled?: boolean; ignore?: string[] }

Type Declaration

Optionalenabled?: boolean
Optionalignore?: string[]

Dependency names to exclude from the unused/missing check (knip). Supports globs matched against the whole name, e.g. "@types/" — so "eslint-" covers "eslint-plugin-x" but never "eslint" itself. Use for packages that are invoked only as CLI binaries or referenced from config — knip sees no import for them and would otherwise report them as unused. Compiled into a temporary knip config, so a repo that ships its own knip config keeps full control instead.

`Optional`detect

detect?: { disable?: Language[]; excludePaths?: string[]; minFiles?: number }

`Optional`diffSecurity

diffSecurity?: {
    commentHandling?: "off" | "language" | "legacy";
    dataflowWindow?: number;
    disablePatterns?: string[];
    enabled?: boolean;
    extraPatterns?: {
        flags?: string;
        label: string;
        pattern: string;
        severity?: "warn" | "error";
        view?: "code" | "raw";
    }[];
    failOn?: "warn"
    | "error"
    | "never";
    ignore?: string[];
    ignorePaths?: string[];
    severityOverrides?: Record<string, "warn" | "error" | "off">;
}

`Optional`diffSmell

diffSmell?: { enabled?: boolean; ignorePaths?: string[] }

`Optional`dockerfileSecurity

dockerfileSecurity?: {
    enabled?: boolean;
    failOn?: "warn" | "error" | "never";
    ignore?: string[];
    ignorePaths?: string[];
    severityOverrides?: Record<string, "warn" | "error" | "off">;
}

`Optional`duplicate

duplicate?: {
    enabled?: boolean;
    formats?: string[];
    ignore?: string[];
    minLines?: number;
    minTokens?: number;
}

Type Declaration

Optionalenabled?: boolean
Optionalformats?: string[]

jscpd formats to scan. Defaults to source-code formats only (see DUPLICATE_CODE_FORMATS) — data formats like yaml, json and markdown are intentionally NOT scanned, since their repetition is rarely meaningful duplication. Add them back (e.g. ["typescript", "yaml"]) if you do want to detect duplication in those files. Setting this replaces the list.
Optionalignore?: string[]

Glob patterns excluded from duplicate detection, in addition to the always-on node_modules/dist/.git ignores. Defaults to test files/folders (see DUPLICATE_IGNORE_DEFAULTS). Setting this replaces the default list.
OptionalminLines?: number
OptionalminTokens?: number

`Optional`excludePaths

excludePaths?: string[]

`Optional`go

go?: { enabled?: boolean }

`Optional`grypeScan

grypeScan?: {
    enabled?: boolean;
    ignore?: string[];
    minSeverity?: "negligible" | "low" | "medium" | "high" | "critical";
    timeoutMs?: number;
}

Type Declaration

Optionalenabled?: boolean
Optionalignore?: string[]
OptionalminSeverity?: "negligible" | "low" | "medium" | "high" | "critical"
OptionaltimeoutMs?: number

Max time (ms) for the grype scan before the check skips. Default 120000. ignoreDirs already keeps node_modules, dist and friends out of the walk, which is what makes the scan fast; this is the backstop so an advisory check can never stall a commit.

`Optional`ignoreDirs

ignoreDirs?: string[]

`Optional`install

install?: InstallConfig

`Optional`kotlin

kotlin?: { enabled?: boolean }

`Optional`languages

languages?: Language[]

`Optional`largeFiles

largeFiles?: {
    allow?: string[];
    enabled?: boolean;
    maxSizeKb?: number;
    severity?: "warn" | "error";
}

`Optional`leftoverDebug

leftoverDebug?: {
    commentHandling?: "off" | "language" | "legacy";
    enabled?: boolean;
    severity?: "warn" | "error";
}

`Optional`licenseCheck

licenseCheck?: { allowLicenses?: string[]; allowPackages?: string[] }

`Optional`licenseHeader

licenseHeader?: { enabled?: boolean; lines?: number; pattern?: string }

`Optional`lint

lint?: { ignorePatterns?: string[]; rules?: Record<string, any> }

`Optional`lockfileDrift

lockfileDrift?: { enabled?: boolean; severity?: "warn" | "error" }

`Optional`log

log?: {
    color?: "auto" | "always" | "never";
    format?: "pretty" | "ci" | "json";
    level?: "log" | "info" | "warn" | "error" | "debug";
    sampleLimit?: number;
    stderrLevels?: ("log" | "info" | "warn" | "error" | "debug")[];
    timestamps?: boolean;
}

`Optional`mergeConflict

mergeConflict?: { enabled?: boolean; severity?: "warn" | "error" }

`Optional`migrationSafety

migrationSafety?: {
    enabled?: boolean;
    paths?: string[];
    severity?: "warn" | "error";
}

`Optional`missingTests

missingTests?: {
    enabled?: boolean;
    ignore?: string[];
    severity?: "warn" | "error";
}

`Optional`outdatedDeps

outdatedDeps?: { enabled?: boolean; ignore?: string[]; timeoutMs?: number }

Type Declaration

Optionalenabled?: boolean
Optionalignore?: string[]

Exact package names to exclude from the outdated-deps warning, e.g. "commander". Use for dependencies deliberately pinned behind their latest major (a breaking upgrade you have chosen not to take, or one held back by an overrides entry) so npm outdated no longer flags them as major-behind. Matched by exact name — no globs or version ranges.
OptionaltimeoutMs?: number

`Optional`packageSize

packageSize?: {
    compareWith?: string;
    enabled?: boolean;
    maxGrowthPercent?: number;
}

`Optional`php

php?: { enabled?: boolean }

`Optional`prBody

prBody?: { enabled?: boolean; minLength?: number; requireTicket?: boolean }

`Optional`prettier

prettier?: { config?: Record<string, any> }

`Optional`prSize

prSize?: { enabled?: boolean; maxFiles?: number; maxLines?: number }

`Optional`python

python?: {
    enabled?: boolean;
    ruff?: { format?: boolean; lint?: boolean };
    typecheck?: boolean;
    typeChecker?: "mypy" | "pyright";
}

`Optional`reporter

reporter?: ReporterConfig

`Optional`ruby

ruby?: { enabled?: boolean }

`Optional`run

run?: {
    checkTimeoutMs?: number;
    concurrency?: number | "auto" | "unlimited";
    fullScanBehaviour?: "skip" | "scan";
    heavyConcurrency?: number;
    onDegradedScope?: "warn" | "error" | "off";
    reportSkipped?: "auto" | "always" | "never";
    timings?: boolean;
}

`Optional`rust

rust?: { enabled?: boolean }

`Optional`security

security?: {
gitleaks?: { depth?: number; enabled?: boolean; version?: string };
"npm-audit"?: { auditLevel?: string; enabled?: boolean; ignore?: string[] };
}

`Optional`sensitiveFileGuard

sensitiveFileGuard?: {
    enabled?: boolean;
    failOn?: "warn" | "error" | "never";
    ignore?: string[];
    ignorePaths?: string[];
    severityOverrides?: Record<string, "warn" | "error" | "off">;
}

`Optional`severity

severity?: Record<string, "warn" | "error" | "off">

`Optional`severityDefaults

severityDefaults?: { failOn?: "warn" | "error" | "never" }

`Optional`shellcheck

shellcheck?: {
    enabled?: boolean;
    ignore?: string[];
    minSeverity?: "info" | "error" | "warning" | "style";
}

sourcePath

sourcePath: string | string[]

`Optional`spellcheck

spellcheck?: {
    enabled?: boolean;
    ignorePaths?: string[];
    ignoreWords?: string[];
    words?: string[];
}

`Optional`swift

swift?: { enabled?: boolean }

`Optional`symlinks

symlinks?: { enabled?: boolean; ignore?: string[]; severity?: "warn" | "error" }

`Optional`todoFixme

todoFixme?: {
    enabled?: boolean;
    keywords?: string[];
    requireTicket?: boolean;
    severity?: "warn" | "error";
}

`Optional`typecheck

typecheck?: { enabled?: boolean }

`Optional`vulnScan

vulnScan?: { enabled?: boolean; timeoutMs?: number }

`Optional`workflowSecurity

workflowSecurity?: {
    enabled?: boolean;
    failOn?: "warn" | "error" | "never";
    ignore?: string[];
    ignorePaths?: string[];
    severityOverrides?: Record<string, "warn" | "error" | "off">;
}

`Optional`yamlLint

yamlLint?: { enabled?: boolean; ignore?: string[]; severity?: "warn" | "error" }

Interface PRCheckMateConfig

Index

Properties

Properties

OptionalbannedImports

OptionalcaseCollision

OptionalcircularDeps

Optionalcommitlint

Type Declaration

Optionalenabled?: boolean

Optionalignores?: string[]

Optionaltypes?: string[]

OptionalconfigValidation

Optionalcoverage

Optionalcpp

Optionalcsharp

Optionalcspell

OptionalcustomRules

OptionaldeadCode

Type Declaration

Optionalenabled?: boolean

OptionalignoreFiles?: string[]

Optionaldependency

Type Declaration

Optionalenabled?: boolean

Optionalignore?: string[]

Optionaldetect

OptionaldiffSecurity

OptionaldiffSmell

OptionaldockerfileSecurity

Optionalduplicate

Type Declaration

Optionalenabled?: boolean

Optionalformats?: string[]

Optionalignore?: string[]

OptionalminLines?: number

OptionalminTokens?: number

OptionalexcludePaths

Optionalgo

OptionalgrypeScan

Type Declaration

Optionalenabled?: boolean

Optionalignore?: string[]

OptionalminSeverity?: "negligible" | "low" | "medium" | "high" | "critical"

OptionaltimeoutMs?: number

OptionalignoreDirs

Optionalinstall

Optionalkotlin

Optionallanguages

OptionallargeFiles

OptionalleftoverDebug

OptionallicenseCheck

OptionallicenseHeader

Optionallint

OptionallockfileDrift

Optionallog

OptionalmergeConflict

OptionalmigrationSafety

OptionalmissingTests

OptionaloutdatedDeps

Type Declaration

Optionalenabled?: boolean

Optionalignore?: string[]

OptionaltimeoutMs?: number

OptionalpackageSize

Optionalphp

OptionalprBody

Optionalprettier

OptionalprSize

Optionalpython

Optionalreporter

Optionalruby

Optionalrun

Optionalrust

Optionalsecurity

OptionalsensitiveFileGuard

Optionalseverity

OptionalseverityDefaults

Optionalshellcheck

sourcePath

`Optional`bannedImports

`Optional`caseCollision

`Optional`circularDeps

`Optional`commitlint

`Optional`enabled?: boolean

`Optional`ignores?: string[]

`Optional`types?: string[]

`Optional`configValidation

`Optional`coverage

`Optional`cpp

`Optional`csharp

`Optional`cspell

`Optional`customRules

`Optional`deadCode

`Optional`enabled?: boolean

`Optional`ignoreFiles?: string[]

`Optional`dependency

`Optional`enabled?: boolean

`Optional`ignore?: string[]

`Optional`detect

`Optional`diffSecurity

`Optional`diffSmell

`Optional`dockerfileSecurity

`Optional`duplicate

`Optional`enabled?: boolean

`Optional`formats?: string[]

`Optional`ignore?: string[]

`Optional`minLines?: number

`Optional`minTokens?: number

`Optional`excludePaths

`Optional`go

`Optional`grypeScan

`Optional`enabled?: boolean

`Optional`ignore?: string[]

`Optional`minSeverity?: "negligible" | "low" | "medium" | "high" | "critical"

`Optional`timeoutMs?: number

`Optional`ignoreDirs

`Optional`install

`Optional`kotlin

`Optional`languages

`Optional`largeFiles

`Optional`leftoverDebug

`Optional`licenseCheck

`Optional`licenseHeader

`Optional`lint

`Optional`lockfileDrift

`Optional`log

`Optional`mergeConflict

`Optional`migrationSafety

`Optional`missingTests

`Optional`outdatedDeps

`Optional`enabled?: boolean

`Optional`ignore?: string[]

`Optional`timeoutMs?: number

`Optional`packageSize

`Optional`php

`Optional`prBody

`Optional`prettier

`Optional`prSize

`Optional`python

`Optional`reporter

`Optional`ruby

`Optional`run

`Optional`rust

`Optional`security

`Optional`sensitiveFileGuard

`Optional`severity

`Optional`severityDefaults

`Optional`shellcheck

`Optional`spellcheck

`Optional`swift

`Optional`symlinks

`Optional`todoFixme

`Optional`typecheck

`Optional`vulnScan

`Optional`workflowSecurity

`Optional`yamlLint