tui

Documentation

Index

• Variables
• func AddDependencyCheck(cmd *cobra.Command, deps ...Dependency) *cobra.Command
• func CheckErr(err error)
• func DebugColors() string
• func DockerAvailable() error
• func DockerBuildxAvailable() error
• func IsTerminal() bool
• func PodmanAvailable() error
• type ColorPalette
• type DefaultKeyMap
• type Dependency
• type DependencyError
  • func RequireDocker() *DependencyError
  • func RequirePodman() *DependencyError
  • func (d *DependencyError) Assist() string
  • func (d *DependencyError) Error() string
• type TagPrinter
  • func (t *TagPrinter) Printfln(message string, a ...interface{})
  • func (t *TagPrinter) Println(message string)

Variables

var (
	Debug = TagPrinter{
		Prefix: addPrefix("debug", Colors.White, Colors.TextMuted),
	}
	Error = TagPrinter{
		Prefix: addPrefix("error", Colors.White, Colors.Red),
	}
	Info = TagPrinter{
		Prefix: addPrefix("info", Colors.White, Colors.TextMuted),
	}
	Warning = TagPrinter{
		Prefix: addPrefix("warning", Colors.Black, Colors.Yellow),
	}
)

var KeyMap = DefaultKeyMap{
	Enter: key.NewBinding(
		key.WithKeys("enter"),
		key.WithHelp("enter", "submit input"),
	),
	Quit: key.NewBinding(
		key.WithKeys("esc", "ctrl+c"),
		key.WithHelp("esc", "exit"),
	),
	Up: key.NewBinding(
		key.WithKeys("up"),
		key.WithHelp("↑", "up"),
	),
	Down: key.NewBinding(
		key.WithKeys("down"),
		key.WithHelp("↓", "down"),
	),
}

KeyMap contains our standard keybinding for CLI input

var RequireContainerBuilder = atLeastOne(RequireDocker, RequirePodman)

Functions

func AddDependencyCheck

func AddDependencyCheck(cmd *cobra.Command, deps ...Dependency) *cobra.Command

AddDependencyCheck - Wraps a cobra command with a pre-run that will check for dependencies

func CheckErr

func CheckErr(err error)

func DebugColors

func DebugColors() string

DebugColors returns the entire color palette as a string

Use for testing various terminals to confirm output

func DockerAvailable

func DockerAvailable() error

func DockerBuildxAvailable

func DockerBuildxAvailable() error

func IsTerminal

func IsTerminal() bool

IsTerminal returns true if the current process is running in an interactive terminal

func PodmanAvailable

func PodmanAvailable() error

Types

type ColorPalette

type ColorPalette struct {
	White         lipgloss.CompleteAdaptiveColor
	Gray          lipgloss.CompleteAdaptiveColor
	Black         lipgloss.CompleteAdaptiveColor
	Red           lipgloss.CompleteAdaptiveColor
	Orange        lipgloss.CompleteAdaptiveColor
	Yellow        lipgloss.CompleteAdaptiveColor
	Green         lipgloss.CompleteAdaptiveColor
	Teal          lipgloss.CompleteAdaptiveColor
	Blue          lipgloss.CompleteAdaptiveColor
	Purple        lipgloss.CompleteAdaptiveColor
	Text          lipgloss.CompleteAdaptiveColor
	TextMuted     lipgloss.CompleteAdaptiveColor
	TextHighlight lipgloss.CompleteAdaptiveColor
	TextActive    lipgloss.CompleteAdaptiveColor
}

ColorPalette of standard CLI UI colors

var Colors *ColorPalette = &ColorPalette{
	White:  lipgloss.CompleteAdaptiveColor{Light: white, Dark: white},
	Gray:   lipgloss.CompleteAdaptiveColor{Light: gray, Dark: gray},
	Black:  lipgloss.CompleteAdaptiveColor{Light: black, Dark: black},
	Red:    lipgloss.CompleteAdaptiveColor{Light: red, Dark: red},
	Orange: lipgloss.CompleteAdaptiveColor{Light: orange, Dark: orange},
	Yellow: lipgloss.CompleteAdaptiveColor{Light: yellow, Dark: yellow},
	Green:  lipgloss.CompleteAdaptiveColor{Light: green, Dark: green},
	Teal:   lipgloss.CompleteAdaptiveColor{Light: teal, Dark: teal},
	Blue:   lipgloss.CompleteAdaptiveColor{Light: blue, Dark: blue},
	Purple: lipgloss.CompleteAdaptiveColor{Light: purple, Dark: purple},
	Text: lipgloss.CompleteAdaptiveColor{
		Light: black,
		Dark:  white,
	},
	TextMuted: lipgloss.CompleteAdaptiveColor{
		Light: lipgloss.CompleteColor{TrueColor: "#4E4E4E", ANSI256: "242", ANSI: "8"},
		Dark:  lipgloss.CompleteColor{TrueColor: "#9E9E9E", ANSI256: "249", ANSI: "7"},
	},
	TextHighlight: lipgloss.CompleteAdaptiveColor{
		Light: blue,
		Dark:  purple,
	},
	TextActive: lipgloss.CompleteAdaptiveColor{
		Light: blue,
		Dark:  blue,
	},
}

Colors contains our standard UI colors for CLI output

type DefaultKeyMap

type DefaultKeyMap struct {
	Enter key.Binding
	Quit  key.Binding
	Up    key.Binding
	Down  key.Binding
}

type Dependency

type Dependency = func() *DependencyError

type DependencyError

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

func RequireDocker

func RequireDocker() *DependencyError

func RequirePodman

func RequirePodman() *DependencyError

func (*DependencyError) Assist

func (d *DependencyError) Assist() string

func (*DependencyError) Error

func (d *DependencyError) Error() string

type TagPrinter

type TagPrinter struct {
	Prefix string
}

func (*TagPrinter) Printfln

func (t *TagPrinter) Printfln(message string, a ...interface{})

func (*TagPrinter) Println

func (t *TagPrinter) Println(message string)