Documentation
¶
Overview ¶
Package gc holds the Pruner registry used by `lore doctor --prune`. A Pruner owns the lifecycle of one family of Lore-generated artifacts (polish backups, polish.log, *.corrupt-* quarantine files). It exposes a stable Name, a file Pattern for invariant coverage, and a Prune method that applies the family's retention policy to a given working directory.
Story 8-23 / invariant I32: every growing artifact produced by Lore is either (a) an overwritten single-version file, or (b) has a Pruner registered in this package. A test walks the known patterns and verifies each maps to a registered Pruner — adding a new growing-artifact family without a Pruner fails the build.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Register ¶
func Register(p Pruner)
Register adds a Pruner to the default registry. Safe for init() calls from sibling files in this package. Registering the same Pruner.Name() twice panics — this is a programmer error that should surface loudly at test time.
func RegisteredPatterns ¶
func RegisteredPatterns() []string
RegisteredPatterns returns the sorted list of Pattern values for every registered Pruner. Used by the I32 invariant test.
Types ¶
type PruneReport ¶
type PruneReport struct {
Feature string // stable human identifier: "polish-backups", "polish-log", "corrupt-quarantine"
Removed int // number of items pruned (files, lines — unit is Pruner-specific)
Kept int // number of items retained
Bytes int64 // bytes freed (or would have been freed in dry-run)
DryRun bool // true when the Pruner was asked to simulate only
Err error
}
PruneReport describes the outcome of one Pruner's run.
Error semantics: a non-nil Err means the Pruner encountered an I/O error and the report may be partial. RunAll always returns every Pruner's report regardless of errors, so callers can surface partial progress + the error.
type Pruner ¶
type Pruner interface {
// Name returns the stable identifier for this Pruner. Used as
// the PruneReport.Feature field and in invariant test output.
Name() string
// Pattern returns the file glob (relative to the state dir) that
// this Pruner manages. Purely descriptive — used by the I32
// invariant test to ensure every known growing artifact has
// coverage.
Pattern() string
// Prune applies the retention policy. workDir is the repo root;
// cfg carries the user's configured retention values. When
// dryRun is true the Pruner must compute what it WOULD remove
// without touching the filesystem. A non-nil PruneReport.Err
// indicates partial failure — the report still carries the
// counts that succeeded before the error surfaced.
Prune(ctx context.Context, workDir string, cfg *config.Config, dryRun bool) PruneReport
}
Pruner is implemented by each family of artifact-managing code. Implementations live next to the writers they prune (e.g. polish_backup_pruner.go sits next to polish_backup.go). They register themselves with the package-level DefaultRegistry via init().
func Registered ¶
func Registered() []Pruner
Registered returns a snapshot of the current Pruner set. Callers mutate the slice safely — it is a copy.
Source Files