rules

type Confidence string

type Config struct {
	// Disabled lists rule IDs to skip entirely.
	Disabled map[string]bool
	// SeverityOverride maps a rule ID to the severity to report it at.
	SeverityOverride map[string]Severity
}

type Context struct {
	Project *ir.Project
	// Host is never nil. When no context was gathered it is an
	// unknown-everything implementation, so rules need no nil checks.
	Host hostctx.Context
	// BindSourceUsage counts how many units mount each bind source. Computed
	// once and shared, which is what keeps QD001 and QD002 from
	// contradicting each other.
	BindSourceUsage map[string]int
	// contains filtered or unexported fields
}

type Engine struct {
	Config Config
	Host   hostctx.Context
}

type Finding struct {
	RuleID     string     `json:"rule"`
	Severity   Severity   `json:"-"`
	SeverityJS string     `json:"severity"`
	Confidence Confidence `json:"confidence"`
	// Unit is the path of the unit the finding concerns.
	Unit string `json:"unit"`
	// Line is where in that unit, or 0 when the finding is about the unit
	// as a whole rather than a particular line.
	Line int `json:"line,omitempty"`
	// Message states what is wrong, in one sentence.
	Message string `json:"message"`
	// Remediation is copy-pasteable, or an explicit statement that no
	// mechanical fix exists and what decision the user must make instead.
	Remediation string `json:"remediation"`

	// Fix carries the structured detail the fix engine needs, so that it
	// applies exactly what the rule decided rather than re-deriving it from
	// the prose. Empty for findings with no mechanical fix.
	Fix map[string]string `json:"-"`
}

type Rule struct {
	// ID is the QD### identifier.
	ID string
	// Summary is a one-line description, shown in listings.
	Summary string
	// Rationale explains why this matters, in prose, for the reference page.
	Rationale string
	// Citation names the documentation or observed behaviour the rule
	// encodes. A rule without one does not ship: see CLAUDE.md.
	Citation string
	// DefaultSeverity applies unless configuration overrides it.
	DefaultSeverity Severity
	// NeedsHostContext marks rules whose findings are only confirmed with a
	// host context, and which must degrade gracefully without one.
	NeedsHostContext bool
	// Fixable marks rules whose remediation is mechanically applicable and
	// provably semantics-preserving.
	Fixable bool
	// Check runs the rule.
	Check func(*Context) []Finding
}

type Severity int