ux

Documentation

Overview

Package ux contains functions and types for human-readable views and observers on parts of c4t, as well as various common 'user experience' functions such as standard flag parsers.

Index

• Constants
• func LoadPlan(f string) (*plan.Plan, error)
• func LogTopError(err error)
• func RunOnCliPlan(ctx *c.Context, r plan.Runner, outw io.Writer) error
• func RunOnPlanFile(ctx context.Context, r plan.Runner, inf string, outw io.Writer) error

Constants

const StdinFile = "-"

StdinFile is the special file path that the plan loader treats as a request to load from stdin instead.

Functions

func LoadPlan

func LoadPlan(f string) (*plan.Plan, error)

LoadPlan loads a plan pointed to by f. If f is empty or StdinFile, Load loads from standard input instead.

func LogTopError

func LogTopError(err error)

LogTopError logs err if non-nil, in a 'fatal top-level error' sort of way.

func RunOnCliPlan

func RunOnCliPlan(ctx *c.Context, r plan.Runner, outw io.Writer) error

RunOnCliPlan runs r on the plan pointed to by the arguments of ctx, dumping the resulting plan to outw.

func RunOnPlanFile

func RunOnPlanFile(ctx context.Context, r plan.Runner, inf string, outw io.Writer) error

RunOnPlanFile runs r on the plan pointed to by inf, dumping the resulting plan to outw.