utils

Documentation

Index

• Variables
• func NewColorable(f *os.File) io.Writer
• func OpenInBrowser(url string) error
• func Pluralize(num int, thing string) string
• func RenderMarkdown(text string) string
• func SetPrepareCmd(fn func(*exec.Cmd) Runnable) func()
• type CmdError
  • func (e CmdError) Error() string
• type Runnable
• type TablePrinter
  • func NewTablePrinter(w io.Writer) TablePrinter

Variables

var Blue = makeColorFunc("blue")

Blue outputs ANSI color if stdout is a tty

var Bold = makeColorFunc("default+b")

Bold outputs ANSI color if stdout is a tty

var Cyan = makeColorFunc("cyan")

Cyan outputs ANSI color if stdout is a tty

var Gray = makeColorFunc("black+h")

Gray outputs ANSI color if stdout is a tty

var Green = makeColorFunc("green")

Green outputs ANSI color if stdout is a tty

var Magenta = makeColorFunc("magenta")

Magenta outputs ANSI color if stdout is a tty

var PrepareCmd = func(cmd *exec.Cmd) Runnable {
	return &cmdWithStderr{cmd}
}

PrepareCmd extends exec.Cmd with extra error reporting features and provides a hook to stub command execution in tests

var Red = makeColorFunc("red")

Red outputs ANSI color if stdout is a tty

var Yellow = makeColorFunc("yellow")

Yellow outputs ANSI color if stdout is a tty

Functions

func NewColorable

func NewColorable(f *os.File) io.Writer

NewColorable returns an output stream that handles ANSI color sequences on Windows

func OpenInBrowser

func OpenInBrowser(url string) error

func Pluralize

func Pluralize(num int, thing string) string

func RenderMarkdown

func RenderMarkdown(text string) string

func SetPrepareCmd

func SetPrepareCmd(fn func(*exec.Cmd) Runnable) func()

SetPrepareCmd overrides PrepareCmd and returns a func to revert it back

Types

type CmdError

type CmdError struct {
	Stderr *bytes.Buffer
	Args   []string
	Err    error
}

CmdError provides more visibility into why an exec.Cmd had failed

func (CmdError) Error

func (e CmdError) Error() string

type Runnable

type Runnable interface {
	Output() ([]byte, error)
	Run() error
}

Runnable is typically an exec.Cmd or its stub in tests

type TablePrinter

type TablePrinter interface {
	IsTTY() bool
	AddField(string, func(int, string) string, func(string) string)
	EndRow()
	Render() error
}

func NewTablePrinter

func NewTablePrinter(w io.Writer) TablePrinter