Documentation
¶
Overview ¶
Package engine orchestrates gate execution and applies diff scoping. It's the layer that turns per-gate results into the top-level Verdict a report formatter renders.
Index ¶
Constants ¶
View Source
const SchemaVersion = "gauntlet/v1"
SchemaVersion is the stable identifier stamped into every JSON verdict. Bump when the JSON schema gains a breaking change; goldens then update.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Options ¶
type Options struct {
Root string // absolute path to repo root
GateNames []string // in run order; each must be registered
Scope gitdiff.Scope
ScopeLabel string // "staged" | "since:main" | "whole-tree"
// FailFast stops the engine on the first gate that reports FAIL.
// Remaining gates emit GateResult{Status: GateSkip, SkipReason: "fail-fast"}
// so nothing is silently dropped from the verdict.
FailFast bool
}
Options controls one engine run. Zero-value is invalid (Root must be set).
Click to show internal directories.
Click to hide internal directories.