output

Documentation

Overview

Package output is responsible for formatting the final output / errors the user sees in the CLI.

Index

• func FormatError(summary string, err error) string
• type UI
  • func (u *UI) Ask(query string) (string, error)
  • func (u *UI) AskSecret(query string) (string, error)
  • func (u *UI) Error(message string)
  • func (u *UI) Info(message string)
  • func (u *UI) Output(message string)
  • func (u *UI) Warn(message string)

Functions

func FormatError

func FormatError(summary string, err error) string

FormatError outputs the error with proper formatting for CLI.

Types

type UI

type UI struct {
	BasicUI cli.Ui
}

UI is used for interfacing with the terminal

func (*UI) Ask

func (u *UI) Ask(query string) (string, error)

Ask asks the user for input using the given query. The response is returned as the given string, or an error.

func (*UI) AskSecret

func (u *UI) AskSecret(query string) (string, error)

AskSecret asks the user for input using the given query, but does not echo the keystrokes to the terminal.

func (*UI) Error

func (u *UI) Error(message string)

Error is used to output error messages

func (*UI) Info

func (u *UI) Info(message string)

Info is used to output info messages

func (*UI) Output

func (u *UI) Output(message string)

Output is used to output messages with no formatting applied

func (*UI) Warn

func (u *UI) Warn(message string)

Warn is used to output warn messages