PR CheckMate API - v3.0.2
    Preparing search index...

    Interface RunOptions

    interface RunOptions {
        baseSha?: string;
        checks?: Check[];
        config?: PRCheckMateConfig;
        cwd?: string;
        extendRegistry?: boolean;
        full?: boolean;
        headSha?: string;
        languages?: Language[];
        only?: string[];
        reporter?: ReporterKind | ReporterFn;
        skip?: string[];
        staged?: boolean;
        write?: boolean;
    }
    Index
    baseSha?: string
    checks?: Check[]

    Extra checks to run. Combined with the built-in registry per extendRegistry. Lets consumers (e.g. PRValidator) plug their own Checks into the same pipeline.

    cwd?: string
    extendRegistry?: boolean

    How checks combines with the built-in registry:

    • true (default when checks is set): append; a custom check overrides a built-in one with the same name.
    • false: run ONLY the provided checks, ignoring the built-in registry.
    full?: boolean

    Review every tracked file instead of a diff (--full on the CLI, and the default when no CI environment is detected). Takes precedence over every other range source, including CI variables — see planDiffRange. The 16 checks that are about a diff by definition (PR Size, Diff Security, Merge Conflict, …) gate their own applies on baseSha, so they drop out of the report rather than misreporting.

    headSha?: string
    languages?: Language[]

    Override language detection (e.g. PRValidator passes its already-detected type).

    only?: string[]

    Whitelist of check names — when set, only these run.

    Where the report goes:

    • 'none': nothing (just return the report)
    • 'stdout': print the summary table
    • 'github': print + upsert a PR comment
    • a function: receives the CheckReport (e.g. forward to Slack).
    skip?: string[]

    Blacklist of check names — always excluded.

    staged?: boolean

    Pre-commit / local mode: check the staged changes (index vs HEAD) instead of a PR range. Implemented by diffing HEAD against the index tree (git write-tree), so every delta-aware check works unchanged.

    write?: boolean

    Allow file-modifying checks to write. Default false.