ci

package

v1.1.0 Latest Latest Go to latest Published: May 21, 2026 License: MIT Imports: 3 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type HighestUserWastedPercent struct {
	Threshold float64
}

HighestUserWastedPercent fails if wasted bytes as a fraction of total size exceed the threshold.

func (r HighestUserWastedPercent) Evaluate(result *image.EfficiencyResult, totalSize int64) RuleResult

func (r HighestUserWastedPercent) Name() string

type HighestWastedBytes struct {
	Threshold int64
}

HighestWastedBytes fails if wasted bytes exceed the threshold. A threshold of 0 disables this rule (always passes).

func (r HighestWastedBytes) Evaluate(result *image.EfficiencyResult, _ int64) RuleResult

func (r HighestWastedBytes) Name() string

type LowestEfficiency struct {
	Threshold float64
}

LowestEfficiency fails if the efficiency score is below the threshold.

func (r LowestEfficiency) Evaluate(result *image.EfficiencyResult, _ int64) RuleResult

func (r LowestEfficiency) Name() string

type Report struct {
	Passed   bool
	Results  []RuleResult
	TopWaste []image.WastedFile
	Score    float64
}

Report holds the results of all rule evaluations.

func Evaluate(efficiency *image.EfficiencyResult, totalSize int64, rules []Rule) *Report

Evaluate runs all rules against the efficiency result and returns a report.

func (r *Report) ExitCode() int

ExitCode returns 0 if all rules passed, 1 otherwise.

func (r *Report) Print(w io.Writer)

Print writes the human-readable report to w.

type Rule interface {
	Name() string
	Evaluate(result *image.EfficiencyResult, totalSize int64) RuleResult
}

Rule evaluates one aspect of image efficiency.

type RuleResult struct {
	Passed    bool
	Name      string
	Actual    string
	Threshold string
}

RuleResult holds the outcome of evaluating a single rule.