say

README

Say

A collection of simple Go helpers for easily producing formatted CLI output

Documentation

Index

• Constants
• Variables
• func Ask(f string, args ...any) string
• func AskForBoolWithDefault(text string, defaultResponse bool) bool
• func AskForIntegerWithDefault(text string, defaultResponse int) int
• func AskWithDefault(text string, defaultResponse string) string
• func AskWithValidation(text string, validation func(string) error) string
• func ExitIfError(context string, err error)
• func ExitWith(format string, args ...any)
• func F(format string, args ...interface{}) string
• func Fi(indentation uint, format string, args ...interface{}) string
• func Fiw(indentation uint, maxWidth uint, format string, args ...interface{}) string
• func Flniw(writer io.Writer, indentation uint, maxWidth uint, format string, ...)
• func Fp(writer io.Writer, format string, args ...interface{})
• func Fpi(writer io.Writer, indentation uint, format string, args ...interface{})
• func Fpiw(writer io.Writer, indentation uint, maxWidth uint, format string, ...)
• func Fpln(writer io.Writer, format string, args ...interface{})
• func Fplni(writer io.Writer, indentation uint, format string, args ...interface{})
• func Invoke(executable Executable)
• func P(format string, args ...interface{})
• func Pi(indentation uint, format string, args ...interface{})
• func Pick(text string, options []string) string
• func Piw(indentation uint, maxWidth uint, format string, args ...interface{})
• func Pln(format string, args ...interface{})
• func Plni(indentation uint, format string, args ...interface{})
• func Plniw(indentation uint, maxWidth uint, format string, args ...interface{})
• type ColorMode
• type Command
• type CommandGroup
• type Executable
• type Formatter
  • func New(colorMode ColorMode) Formatter
  • func NewWithNoColorBool(noColor bool) Formatter
  • func (f Formatter) CycleJoin(elements []string, joiner string, cycle []string) string
  • func (f Formatter) F(format string, args ...interface{}) string
  • func (f Formatter) Fi(indentation uint, format string, args ...interface{}) string
  • func (f Formatter) Fiw(indentation uint, maxWidth uint, format string, args ...interface{}) string

Constants

const COLS = 80

const SAY_VERSION = "1.1.0"

Variables

var SingletonFormatter = New(ColorModeTerminal)

Functions

func Ask

func Ask(f string, args ...any) string

func AskForBoolWithDefault

func AskForBoolWithDefault(text string, defaultResponse bool) bool

func AskForIntegerWithDefault

func AskForIntegerWithDefault(text string, defaultResponse int) int

func AskWithDefault

func AskWithDefault(text string, defaultResponse string) string

func AskWithValidation

func AskWithValidation(text string, validation func(string) error) string

func ExitIfError

func ExitIfError(context string, err error)

func ExitWith

func ExitWith(format string, args ...any)

func F

func F(format string, args ...interface{}) string

func Fi

func Fi(indentation uint, format string, args ...interface{}) string

func Fiw

func Fiw(indentation uint, maxWidth uint, format string, args ...interface{}) string

func Flniw

func Flniw(writer io.Writer, indentation uint, maxWidth uint, format string, args ...interface{})

func Fp

func Fp(writer io.Writer, format string, args ...interface{})

func Fpi

func Fpi(writer io.Writer, indentation uint, format string, args ...interface{})

func Fpiw

func Fpiw(writer io.Writer, indentation uint, maxWidth uint, format string, args ...interface{})

func Fpln

func Fpln(writer io.Writer, format string, args ...interface{})

func Fplni

func Fplni(writer io.Writer, indentation uint, format string, args ...interface{})

func Invoke

func Invoke(executable Executable)

func P

func P(format string, args ...interface{})

func Pi

func Pi(indentation uint, format string, args ...interface{})

func Pick

func Pick(text string, options []string) string

func Piw

func Piw(indentation uint, maxWidth uint, format string, args ...interface{})

func Pln

func Pln(format string, args ...interface{})

func Plni

func Plni(indentation uint, format string, args ...interface{})

func Plniw

func Plniw(indentation uint, maxWidth uint, format string, args ...interface{})

Types

type ColorMode

type ColorMode uint8

const (
	ColorModeNone ColorMode = iota
	ColorModeTerminal
	ColorModePassthrough
)

type Command

type Command struct {
	Name        string
	Description string
	FlagSet     *flag.FlagSet
	Run         func(args []string)
}

type CommandGroup

type CommandGroup struct {
	Name        string
	Description string
	Commands    []Command
}

type Executable

type Executable struct {
	Name          string
	Description   string
	CommandGroups []CommandGroup
}

type Formatter

type Formatter struct {
	ColorMode ColorMode
	// contains filtered or unexported fields
}

func New

func New(colorMode ColorMode) Formatter

func NewWithNoColorBool

func NewWithNoColorBool(noColor bool) Formatter

func (Formatter) CycleJoin

func (f Formatter) CycleJoin(elements []string, joiner string, cycle []string) string

func (Formatter) F

func (f Formatter) F(format string, args ...interface{}) string

func (Formatter) Fi

func (f Formatter) Fi(indentation uint, format string, args ...interface{}) string

func (Formatter) Fiw

func (f Formatter) Fiw(indentation uint, maxWidth uint, format string, args ...interface{}) string