utils

Documentation

Index

• Variables
• func Compress(zipFilename string, filename string) error
• func CompressDir(w *zip.Writer, dirName string) error
• func CompressFile(w *zip.Writer, filename string) error
• func DisplayURL(urlStr string) string
• func ExpandUser(pathname string) string
• func FileExists(filename string) bool
• func FuzzyAgo(ago time.Duration) string
• func GreenCheck() string
• func Humanize(s string) string
• func IsCygwinTerminal(w interface{}) bool
• func IsURL(s string) bool
• func NewColorable(w io.Writer) io.Writer
• func OpenInBrowser(url string) error
• func Pluralize(num int, thing string) string
• func RandStringRunes(n int) string
• func RenderMarkdown(text string) (string, error)
• func Spinner(w io.Writer) *spinner.Spinner
• type TablePrinter
  • func NewTablePrinter(io *iostreams.IOStreams) TablePrinter

Variables

var (
	// Outputs ANSI color if stdout is a tty
	Magenta = makeColorFunc("magenta")
	Cyan    = makeColorFunc("cyan")
	Red     = makeColorFunc("red")
	Yellow  = makeColorFunc("yellow")
	Blue    = makeColorFunc("blue")
	Green   = makeColorFunc("green")
	Gray    = makeColorFunc("black+h")
	Bold    = makeColorFunc("default+b")
)

var IsTerminal = func(w interface{}) bool {
	if f, isFile := w.(*os.File); isFile {
		return isatty.IsTerminal(f.Fd()) || IsCygwinTerminal(f)
	}

	return false
}

var StartSpinner = func(s *spinner.Spinner) {
	s.Start()
}

We do this so we can stub out the spinner in tests -- it made things really flakey. this is not an elegant solution.

var StopSpinner = func(s *spinner.Spinner) {
	s.Stop()
}

var TerminalSize = func(w interface{}) (int, int, error) {
	if f, isFile := w.(*os.File); isFile {
		return terminal.GetSize(int(f.Fd()))
	}

	return 0, 0, fmt.Errorf("%v is not a file", w)
}

Functions

func Compress

func Compress(zipFilename string, filename string) error

func CompressDir

func CompressDir(w *zip.Writer, dirName string) error

func CompressFile

func CompressFile(w *zip.Writer, filename string) error

func DisplayURL

func DisplayURL(urlStr string) string

func ExpandUser

func ExpandUser(pathname string) string

func FileExists

func FileExists(filename string) bool

FileExists checks if a file exists and is not a directory before we try using it to prevent further errors.

func FuzzyAgo

func FuzzyAgo(ago time.Duration) string

func GreenCheck

func GreenCheck() string

func Humanize

func Humanize(s string) string

func IsCygwinTerminal

func IsCygwinTerminal(w interface{}) bool

func IsURL

func IsURL(s string) bool

func NewColorable

func NewColorable(w io.Writer) io.Writer

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

func OpenInBrowser

func OpenInBrowser(url string) error

OpenInBrowser opens the url in a web browser based on OS and $BROWSER environment variable

func Pluralize

func Pluralize(num int, thing string) string

func RandStringRunes

func RandStringRunes(n int) string

func RenderMarkdown

func RenderMarkdown(text string) (string, error)

func Spinner

func Spinner(w io.Writer) *spinner.Spinner

Types

type TablePrinter

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

func NewTablePrinter

func NewTablePrinter(io *iostreams.IOStreams) TablePrinter