PR CheckMate API - v1.22.3
    Preparing search index...

    Interface PRCheckMateConfig

    interface PRCheckMateConfig {
        commitlint?: { enabled?: boolean; ignores?: string[]; types?: string[] };
        cpp?: { clangFormat?: { style?: string }; enabled?: boolean };
        deadCode?: { enabled?: boolean };
        diffSecurity?: { enabled?: boolean };
        diffSmell?: { enabled?: boolean };
        duplicate?: { enabled?: boolean; minLines?: number; minTokens?: number };
        kotlin?: { enabled?: boolean };
        languages?: Language[];
        licenseCheck?: { allowLicenses?: string[]; allowPackages?: string[] };
        lint?: { ignorePatterns?: string[]; rules?: Record<string, any> };
        prBody?: { enabled?: boolean; minLength?: number; requireTicket?: boolean };
        prettier?: { config?: Record<string, any> };
        python?: { enabled?: boolean; ruff?: { format?: boolean; lint?: boolean } };
        security?: {
            gitleaks?: { enabled: boolean };
            "npm-audit"?: { auditLevel: string; enabled: boolean };
        };
        sensitiveFileGuard?: { enabled?: boolean };
        sourcePath: string;
        spellcheck?: {
            ignorePaths?: string[];
            ignoreWords?: string[];
            words?: string[];
        };
        swift?: { enabled?: boolean };
        typecheck?: { enabled?: boolean };
    }
    Index
    commitlint? cpp? deadCode? diffSecurity? diffSmell? duplicate? kotlin? languages? licenseCheck? lint? prBody? prettier? python? security? sensitiveFileGuard? sourcePath spellcheck? swift? typecheck?
    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[]
    cpp?: { clangFormat?: { style?: string }; enabled?: boolean }
    deadCode?: { enabled?: boolean }
    diffSecurity?: { enabled?: boolean }
    diffSmell?: { enabled?: boolean }
    duplicate?: { enabled?: boolean; minLines?: number; minTokens?: number }
    kotlin?: { enabled?: boolean }
    languages?: Language[]
    licenseCheck?: { allowLicenses?: string[]; allowPackages?: string[] }
    lint?: { ignorePatterns?: string[]; rules?: Record<string, any> }
    prBody?: { enabled?: boolean; minLength?: number; requireTicket?: boolean }
    prettier?: { config?: Record<string, any> }
    python?: { enabled?: boolean; ruff?: { format?: boolean; lint?: boolean } }
    security?: {
        gitleaks?: { enabled: boolean };
        "npm-audit"?: { auditLevel: string; enabled: boolean };
    }
    sensitiveFileGuard?: { enabled?: boolean }
    sourcePath: string
    spellcheck?: {
        ignorePaths?: string[];
        ignoreWords?: string[];
        words?: string[];
    }
    swift?: { enabled?: boolean }
    typecheck?: { enabled?: boolean }

    Settings
    Member Visibility

    On This Page
    Properties