PR CheckMate API - v4.1.0
    Preparing search index...

    Interface Finding

    One thing a check found, with where it is. Optional on every result: only the checks that can say where report it, and a result without any is not an error — it just has a summary and no location.

    interface Finding {
        file: string;
        line?: number;
        rule: string;
        severity: "warn" | "error";
        snippet?: string;
    }
    Index
    file: string
    line?: number

    1-based line in the file as it will be committed.

    rule: string

    Which rule or pattern matched, as the check names it.

    severity: "warn" | "error"
    snippet?: string

    The offending text, shortened. Never a secret: scanners that find those leave it out.