runner

Documentation

Index

• func Run(checks ...Runnable) []common.Printable
• type Runnable

Functions

func Run

func Run(checks ...Runnable) []common.Printable

Run evaluates all the Runnables and returns the outcomes.

Types

type Runnable

type Runnable interface {
	// Run executes a check and returns an outcome (outcomes.Outcome).
	Run() outcomes.Outcome

	// Description returns human-readable information on what check is being executed.
	Description() string

	// Suggestion returns a human-readable suggestion on how to fix the issue.
	Suggestion() string

	// FixIt attempts to fix the issue at hand.
	FixIt() error
}

Runnable is a type of generic function that can be executed; it returns pass/fail on a given check.