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
	// DeleteUntracked authorizes the deliberately narrow exception to the usual
	// clean-working-tree predicate. It has no effect without Apply. Clean still
	// plans and itemizes untracked paths by default; this flag is the separate,
	// explicit authority required before it can delete them.
	DeleteUntracked 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
	// contains filtered or unexported fields
}

type Outcome struct {
	Apply           bool     `json:"apply" yaml:"apply"`
	DeleteUntracked bool     `json:"delete_untracked" yaml:"delete_untracked"`
	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"`
	// Untracked itemizes every untracked file and directory found during the
	// plan. It is present for dry runs and refusals, never inferred from a count.
	Untracked []UntrackedEntry `json:"untracked,omitempty" yaml:"untracked,omitempty"`
	// ReceiptPath names the durable, itemized WB receipt written before an
	// explicitly authorised untracked deletion and finalized before pruning.
	ReceiptPath string `json:"receipt_path,omitempty" yaml:"receipt_path,omitempty"`
	// Error is set only when the deletion itself failed after the clone was
	// judged eligible.
	Error string `json:"error,omitempty" yaml:"error,omitempty"`
	// contains filtered or unexported fields
}

type UntrackedEntry struct {
	Path string `json:"path" yaml:"path"`
	Kind string `json:"kind" yaml:"kind"`
	Size int64  `json:"size" yaml:"size"`
	// contains filtered or unexported fields
}