Interface CheckContext

Everything a check is given to do its work.

interface CheckContext {
    Options: Readonly<Record<string, unknown>>;
    RepoRoot: string;
    Roots: string[];
}

Properties

Options: Readonly<Record<string, unknown>>

The check's own options block from .mj-standards.json, verbatim.

RepoRoot: string

Absolute path to the repository root.

Roots: string[]

Roots to scan, repo-relative. Comes from the check's own config, falling back to the repo's.