cui

Documentation

Overview

Package cui defines charcter user interfaces for I/O.

Index

• type Option
  • func ErrWriter(ew io.Writer) Option
  • func Writer(w io.Writer) Option
• type UI
  • func New(opts ...Option) UI
  • func NewColored(ui UI) UI

Types

type Option

type Option func(*basicUI)

Option represents an option for New.

func ErrWriter

func ErrWriter(ew io.Writer) Option

ErrWriter modifies the default error writer to w.

func Writer

func Writer(w io.Writer) Option

Writer modifies the default writer to w.

type UI

type UI interface {
	Output(s string)
	Info(s string)
	Warn(s string)
	Error(s string)

	Writer() io.Writer
}

UI provides formatted I/O interfaces. It is used from Evans's standard I/O and CLI mode I/O.

func New

func New(opts ...Option) UI

New creates a new UI with passed options.

func NewColored

func NewColored(ui UI) UI

NewColored wraps provided `ui` with coloredUI. If `ui` is *coloredUI, NewColored returns it as it is. Colored output works fine in Windows environment.