archiveprune

type Options struct {
	ProjectsRoot string
	// Filter restricts to repositories whose "org/name" slug contains this
	// substring, matching the fleet-wide --filter convention used elsewhere.
	Filter string
	// Apply performs deletions. Without it, Clean only plans: it runs the
	// exact same evaluation and reports the exact same eligibility, but never
	// calls os.RemoveAll.
	Apply bool
	// Progress, when set, receives one "[n/N] org/repo" line per repository as
	// it is evaluated, so a long fleet sweep is distinguishable from a hang.
	Progress io.Writer
}

type Outcome struct {
	Apply   bool     `json:"apply" yaml:"apply"`
	Results []Result `json:"results" yaml:"results"`
}

type Result struct {
	Repository string `json:"repository" yaml:"repository"`
	Path       string `json:"path" yaml:"path"`
	// Eligible reports whether the clone satisfies every safety check,
	// independent of whether Apply was requested.
	Eligible bool `json:"eligible" yaml:"eligible"`
	// Applied is true only when Apply was requested, the clone was eligible,
	// and the deletion itself succeeded.
	Applied bool `json:"applied" yaml:"applied"`
	// Reason names, for an eligible clone, why it is safe; for an ineligible
	// one, every failing check, joined so the report is self-explanatory
	// without cross-referencing anything else.
	Reason string `json:"reason" yaml:"reason"`
	// Error is set only when the deletion itself failed after the clone was
	// judged eligible.
	Error string `json:"error,omitempty" yaml:"error,omitempty"`
}