upterm

Documentation

Index

• Variables
• func NewNopTextPrinter() pterm.TextPrinter
• func StepCounter(msg string, index, total int) string
• func WrapWithSuccessSpinner(msg string, spinner *pterm.SpinnerPrinter, f func() error) error
• type ObjectPrinter
  • func (p *ObjectPrinter) Print(obj any, fieldNames []string, extractFields func(any) []string) error
  • func (p *ObjectPrinter) PrintTemplate(obj any, tmpl string) error
• type Printer
  • func NewNopObjectPrinter() Printer

Variables

var (
	EyesPrefix = pterm.Prefix{
		Style: &pterm.Style{pterm.FgLightMagenta},
		Text:  " 👀",
	}

	RaisedPrefix = pterm.Prefix{
		Style: &pterm.Style{pterm.FgLightMagenta},
		Text:  " 🙌",
	}

	CheckmarkSuccessSpinner = pterm.DefaultSpinner.WithStyle(spinnerStyle).WithMessageStyle(msgStyle)
	EyesInfoSpinner         = pterm.DefaultSpinner.WithStyle(spinnerStyle).WithMessageStyle(msgStyle)

	ComponentText = pterm.DefaultBasicText.WithStyle(&pterm.ThemeDefault.TreeTextStyle)
)

var (
	DefaultObjPrinter = ObjectPrinter{
		Quiet:        false,
		Pretty:       false,
		DryRun:       false,
		Format:       config.Default,
		TablePrinter: pterm.DefaultTable.WithSeparator("   "),
	}
)

Functions

func NewNopTextPrinter

func NewNopTextPrinter() pterm.TextPrinter

NewNopTextPrinter returns a TextPrinter that does nothing.

func StepCounter

func StepCounter(msg string, index, total int) string

func WrapWithSuccessSpinner

func WrapWithSuccessSpinner(msg string, spinner *pterm.SpinnerPrinter, f func() error) error

Types

type ObjectPrinter

type ObjectPrinter struct {
	Quiet  config.QuietFlag
	Pretty bool
	DryRun bool
	Format config.Format

	TablePrinter *pterm.TablePrinter
}

The ObjectPrinter is intended to make it easy to print individual structs and lists of structs for the 'get' and 'list' commands. It can print as a human-readable table, or computer-readable (JSON or YAML)

func (*ObjectPrinter) Print

func (p *ObjectPrinter) Print(obj any, fieldNames []string, extractFields func(any) []string) error

Print will print a single option or an array/slice of objects. When printing with default table output, it will only print a given set of fields. To specify those fields, the caller should provide the human-readable names for those fields (used for column headers) and a function that can be called on a single struct that returns those fields as strings. When printing JSON or YAML, this will print *all* fields, regardless of the list of fields.

func (*ObjectPrinter) PrintTemplate

func (p *ObjectPrinter) PrintTemplate(obj any, tmpl string) error

type Printer

type Printer interface {
	Print(obj any, fieldNames []string, extractFields func(any) []string) error

	// PrintTemplate prints the object using the provided Go template, if format
	// is set to default, otherwise prints to JSON or YAML.
	PrintTemplate(obj any, template string) error
}

Printer describes interactions for working with the ObjectPrinter below. NOTE(tnthornton) ideally this would be called "ObjectPrinter". TODO(tnthornton) rename this to ObjectPrinter.

func NewNopObjectPrinter

func NewNopObjectPrinter() Printer

NewNopObjectPrinter returns a Printer that does nothing.