OptionalbaseOptionalchecksOptionalconfigOptionalcwdOptionalextendHow 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.OptionalfullReview 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.
OptionalheadOptionallanguagesOverride language detection (e.g. PRValidator passes its already-detected type).
OptionalonlyWhitelist of check names — when set, only these run.
OptionalreporterWhere the report goes:
'none': nothing (just return the report)'stdout': print the summary table'github': print + upsert a PR commentCheckReport (e.g. forward to Slack).OptionalskipBlacklist of check names — always excluded.
OptionalstagedPre-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.
OptionalwriteAllow file-modifying checks to write. Default false.
Extra checks to run. Combined with the built-in registry per
extendRegistry. Lets consumers (e.g. PRValidator) plug their ownChecks into the same pipeline.