app

Documentation

Index

• func Run() error
• type GatheredConfig
• type RunContext
• type Watch
  • func (w *Watch) Block()

Functions

func Run

func Run() error

Runs the program. This is called from the main package. Any error should be displayed to the user.

Types

type GatheredConfig

type GatheredConfig struct {
	Checks []checks.Params
}

Holds the data parsed from the TOML configuration file. Very important.

type RunContext

type RunContext struct {
	// TOML file to load.
	TomlPath string
	// Raw bytes loaded.
	TomlBytes []byte
	// Parsed configuration from the TOML file.
	Config *GatheredConfig
	// Checks available to run, if configured.
	Registry *checks.CheckRegistry
}

Holds per-execution configuration.

type Watch

type Watch struct {
	// contains filtered or unexported fields
}

A Watch is used for its Block method, which blocks the caller until either a set amount of time elapses, or the user presses the Enter key.

func (*Watch) Block

func (w *Watch) Block()

Blocks the caller until either a set amount of time elapses, or the user presses the Enter key.