ui

Documentation

Index

• Variables
• func Fatal(v ...interface{})
• func Fatalf(format string, a ...interface{})
• func GetOutput() io.Writer
• func IsVerbose() bool
• func MarkFlagsDirname(command *cobra.Command, dirnameFlags ...string)
• func MarkFlagsFilename(command *cobra.Command, filenameFlags ...string)
• func MarkFlagsRequired(command *cobra.Command, requiredFlags ...string)
• func Printf(format string, a ...interface{})
• func Println(a ...interface{})
• func PromptForBoolean(prompt string, defaultValue *bool) bool
• func PromptForString(prompt string, defaultValue string, matchers ...func(string) error) string
• func SetOutput(writer io.Writer)
• func SetVerbose(value bool)
• func VPrintf(format string, a ...interface{})
• func VPrintln(a ...interface{})
• type UiSpinner
  • func StartProgressf(format string, a ...interface{}) UiSpinner

Variables

var (
	IsTerminalOutput bool
	IsTerminalInput  bool
)

var NotDirectoryCheck = func(input string) error {
	stat, err := os.Stat(input)
	if os.IsNotExist(err) {
		return nil
	} else {
		if !stat.IsDir() {
			return fmt.Errorf("%s is not a directory", input)
		}
	}
	return nil
}

var NotEmptyCheck = func(input string) error {
	if strings.TrimSpace(input) == "" {
		return fmt.Errorf("no value entered")
	}

	return nil
}

Functions

func Fatal

func Fatal(v ...interface{})

* Prints the message and exits with an error

func Fatalf

func Fatalf(format string, a ...interface{})

* Prints the message and exits with an error

func GetOutput

func GetOutput() io.Writer

func IsVerbose

func IsVerbose() bool

func MarkFlagsDirname

func MarkFlagsDirname(command *cobra.Command, dirnameFlags ...string)

func MarkFlagsFilename

func MarkFlagsFilename(command *cobra.Command, filenameFlags ...string)

func MarkFlagsRequired

func MarkFlagsRequired(command *cobra.Command, requiredFlags ...string)

func Printf

func Printf(format string, a ...interface{})

func Println

func Println(a ...interface{})

func PromptForBoolean

func PromptForBoolean(prompt string, defaultValue *bool) bool

func PromptForString

func PromptForString(prompt string, defaultValue string, matchers ...func(string) error) string

func SetOutput

func SetOutput(writer io.Writer)

func SetVerbose

func SetVerbose(value bool)

func VPrintf

func VPrintf(format string, a ...interface{})

* Prints the message only if verbose is enabled

func VPrintln

func VPrintln(a ...interface{})

* Prints the message only if verbose is enabled

Types

type UiSpinner

type UiSpinner interface {
	Stop()
}

func StartProgressf

func StartProgressf(format string, a ...interface{}) UiSpinner