cli

package module
v0.16.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 19, 2024 License: MIT Imports: 22 Imported by: 0

README

CLI

A project that attempts to rewrite the PHP package symfony/console (with added features from the Laravel package illuminate/console), to Golang as an exercise, and for personal usage.

Work in progress.

Documentation

Index

Constants

View Source 
const (
	InputArgumentRequired = 1
	InputArgumentOptional = 2
	InputArgumentIsArray  = 4
)
View Source 
const (
	InputOptionBool      = 1
	InputOptionRequired  = 2
	InputOptionOptional  = 4
	InputOptionIsArray   = 8
	InputOptionNegatable = 16
)
View Source 
const (
	VerbosityQuiet       uint = 16
	VerbosityNormal      uint = 32
	VerbosityVerbose     uint = 64
	VerbosityVeryVerbose uint = 128
	VerbosityDebug       uint = 256
)
View Source 
const (
	OutputNormal uint = 1
	OutputRaw    uint = 2
	OutputPlain  uint = 4
)
View Source 
const (
	PromptStateInitial   = 1
	PromptStateActive    = 2
	PromptStateSubmit    = 3
	PromptStateCancel    = 4
	PromptStateError     = 5
	PromptStateSearching = 6
)
View Source 
const (
	SeparatorTop                 = 0
	SeparatorTopBottom           = 1
	SeparatorMid                 = 2
	SeparatorBottom              = 3
	BorderOutside                = 0
	BorderInside                 = 1
	DisplayOrientationDefault    = "default"
	DisplayOrientationHorizontal = "horizontal"
	DisplayOrientationVertical   = "vertical"
	TableCellAlignLeft           = "left"
	TableCellAlignRight          = "right"
	TableCellAlignCenter         = "center"
	DefaultTableCellAlign        = TableCellAlignLeft
)
View Source 
const ChoiceQuestionDefaultErrorMessage = `Value "%s" is invalid`
View Source 
const ChoiceQuestionDefaultPrompt = " > "

Variables

View Source 
var CustomOutputTheme = map[string]*OutputFormatterStyle{}
View Source 
var DefaultOutputTheme = map[string]*OutputFormatterStyle{
	"error":    NewOutputFormatterStyle("white", "red", nil),
	"info":     NewOutputFormatterStyle("white", "blue", nil),
	"success":  NewOutputFormatterStyle("white", "green", nil),
	"ok":       NewOutputFormatterStyle("white", "green", nil),
	"warn":     NewOutputFormatterStyle("black", "yellow", nil),
	"warning":  NewOutputFormatterStyle("black", "yellow", nil),
	"caution":  NewOutputFormatterStyle("black", "yellow", nil),
	"comment":  NewOutputFormatterStyle("yellow", "", nil),
	"alert":    NewOutputFormatterStyle("red", "", []string{"bold"}),
	"primary":  NewOutputFormatterStyle("yellow", "", nil),
	"accent":   NewOutputFormatterStyle("green", "", nil),
	"prompt":   NewOutputFormatterStyle("cyan", "", nil),
	"question": NewOutputFormatterStyle("black", "cyan", nil),
}
View Source 
var TrueAnswerRegex = regexp.MustCompile("(?i)^y")

Functions

func AddTheme added in v0.13.0 

func AddTheme(tag string, theme Theme)

func Ask 

func Ask[T any](i *Input, o *Output, question QuestionInterface) (T, error)

func BgBlack 

func BgBlack(text string) string

func BgBlue 

func BgBlue(text string) string

func BgCyan 

func BgCyan(text string) string

func BgGreen 

func BgGreen(text string) string

func BgMagenta 

func BgMagenta(text string) string

func BgRed 

func BgRed(text string) string

func BgWhite 

func BgWhite(text string) string

func BgYellow 

func BgYellow(text string) string

func Black 

func Black(text string) string

func Blue 

func Blue(text string) string

func Bold 

func Bold(text string) string

func ColorMode 

func ColorMode() uint8

func ConvertFromHexToAnsiColorCode 

func ConvertFromHexToAnsiColorCode(mode uint8, hexColor string) (string, error)

func Cyan 

func Cyan(text string) string

func Dim 

func Dim(text string) string

func Escape 

func Escape(s string) string

func EscapeTrailingBackslash 

func EscapeTrailingBackslash(s string) string

func FormatBlock 

func FormatBlock(messages []string, style string, large bool) string

func FormatSection 

func FormatSection(section string, message string, style string) string

func Gray 

func Gray(text string) string

func Green 

func Green(text string) string

func HasColorSupport 

func HasColorSupport() bool

func Hidden 

func Hidden(text string) string

func InputTypeToArray 

func InputTypeToArray(value InputType) []string

func InputTypeToString 

func InputTypeToString(value InputType) string

func Inverse 

func Inverse(text string) string

func Italic 

func Italic(text string) string

func Magenta 

func Magenta(text string) string

func Red 

func Red(text string) string

func RegisterTableStyle added in v0.16.0 

func RegisterTableStyle(name string, style *TableStyle)

func RenderSpinner added in v0.12.0 

func RenderSpinner(s *Spinner) string

func Reset 

func Reset(text string) string

func SetBaseTheme added in v0.15.0 

func SetBaseTheme(primary string, accent string)

func Strikethrough 

func Strikethrough(text string) string

func StringToInputArgs 

func StringToInputArgs(cmd string) []string

func TerminalHeight 

func TerminalHeight() (int, error)

func TerminalIsInteractive 

func TerminalIsInteractive() bool

func TerminalSize 

func TerminalSize() (int, int, error)

func TerminalWidth 

func TerminalWidth() (int, error)

func Truncate 

func Truncate(message string, length int, suffix string) string

func Underline 

func Underline(text string) string

func White 

func White(text string) string

func Yellow 

func Yellow(text string) string

Types

type AnyFunc added in v0.12.0 

type AnyFunc func() any

type Application 

type Application struct {
	Name           string
	Version        string
	LongVersion    string
	DefaultCommand string

	CatchErrors   bool
	AutoExit      bool
	SingleCommand bool
	// contains filtered or unexported fields
}

func (*Application) Abbreviations 

func (app *Application) Abbreviations(names []string) map[string][]string

func (*Application) Add 

func (app *Application) Add(commands ...*Command)

func (*Application) AddCommands 

func (app *Application) AddCommands(commands []*Command)

func (*Application) All 

func (app *Application) All(namespace string) map[string]*Command

func (*Application) Definition 

func (app *Application) Definition() *InputDefinition

func (*Application) ExtractNamespace 

func (app *Application) ExtractNamespace(name string, limit int) string

func (*Application) Find 

func (app *Application) Find(name string) (*Command, error)

func (*Application) FindNamespace 

func (app *Application) FindNamespace(namespace string) (string, error)

func (*Application) Get 

func (app *Application) Get(name string) (*Command, error)

func (*Application) Has 

func (app *Application) Has(name string) bool

func (*Application) Help 

func (app *Application) Help() string

func (*Application) Namespaces 

func (app *Application) Namespaces() []string

func (*Application) RenderError 

func (app *Application) RenderError(o *Output, err error)

func (*Application) Run 

func (app *Application) Run(args ...string) (exitCode int, err error)

func (*Application) RunWith 

func (app *Application) RunWith(i *Input, o *Output) (exitCode int, err error)

func (*Application) SetDefaultCommand 

func (app *Application) SetDefaultCommand(commandName string, isSingleCommand bool) error

func (*Application) SetDefinition 

func (app *Application) SetDefinition(definition *InputDefinition)

type ApplicationDescription 

type ApplicationDescription struct {
	Application *Application
	Namespace   string
	ShowHidden  bool
	// contains filtered or unexported fields
}

func (*ApplicationDescription) Command 

func (d *ApplicationDescription) Command(name string) (*Command, error)

func (*ApplicationDescription) Commands 

func (d *ApplicationDescription) Commands() map[string]*Command

func (*ApplicationDescription) Namespaces 

func (d *ApplicationDescription) Namespaces() map[string]*NamespaceCommands

type AvailableOption 

type AvailableOption struct {
	// contains filtered or unexported fields
}

type ChildProcess 

type ChildProcess struct {
	Cmd     string
	Args    []string
	Shell   string
	Pipe    bool
	Inherit bool
	Stdin   *os.File
	Stdout  *os.File
	Stderr  *os.File

	Env []string
	// contains filtered or unexported fields
}

func (*ChildProcess) AddEnv added in v0.14.0 

func (cp *ChildProcess) AddEnv(name string, value string)

func (*ChildProcess) Run 

func (cp *ChildProcess) Run() (string, error)

func (*ChildProcess) Start 

func (cp *ChildProcess) Start() error

func (*ChildProcess) String added in v0.14.1 

func (cp *ChildProcess) String() string

func (*ChildProcess) Wait 

func (cp *ChildProcess) Wait() error

type ChoiceQuestion 

type ChoiceQuestion struct {
	*Question[string]
	Prompt string

	Choices map[string]string
	// contains filtered or unexported fields
}

func (*ChoiceQuestion) DefaultValidator 

func (cq *ChoiceQuestion) DefaultValidator() QuestionValidator[string]

func (*ChoiceQuestion) SetErrorMessage 

func (cq *ChoiceQuestion) SetErrorMessage(message string)

type Color 

type Color struct {
	Foreground string
	Background string
	Options    []string
	// contains filtered or unexported fields
}

func (*Color) Apply 

func (c *Color) Apply(text string) string

func (*Color) Set 

func (c *Color) Set() string

func (*Color) Unset 

func (c *Color) Unset() string

type Command 

type Command struct {
	Handle      CommandHandle
	Initializer CommandInitializer
	Interacter  CommandInteracter

	Name        string
	Description string
	Aliases     []string
	Help        string

	Hidden bool

	IgnoreValidationErrors bool
	// contains filtered or unexported fields
}

func (*Command) AddArgument 

func (c *Command) AddArgument(arg *InputArgument) *Command

func (*Command) AddOption 

func (c *Command) AddOption(option *InputOption) *Command

func (*Command) AddUsage 

func (c *Command) AddUsage(usage string) *Command

func (*Command) Alert added in v0.12.0 

func (c *Command) Alert(messages ...string)

func (*Command) ApplicationDefinition 

func (c *Command) ApplicationDefinition() *InputDefinition

func (*Command) Arguments 

func (c *Command) Arguments() map[string]InputType

func (*Command) ArrayArgument 

func (c *Command) ArrayArgument(name string) ([]string, error)

func (*Command) ArrayOption 

func (c *Command) ArrayOption(name string) ([]string, error)

func (*Command) BoolOption 

func (c *Command) BoolOption(name string) (bool, error)

func (*Command) Comment added in v0.12.0 

func (c *Command) Comment(messages ...string)

func (*Command) DefineArgument 

func (c *Command) DefineArgument(name string, mode InputArgumentMode, description string, defaultValue InputType, validator InputValidator) *Command

func (*Command) DefineOption 

func (c *Command) DefineOption(name string, shortcut string, mode InputOptionMode, description string, defaultValue InputType, validator InputValidator) *Command

func (*Command) Definition 

func (c *Command) Definition() *InputDefinition

func (*Command) Describe 

func (c *Command) Describe(output *Output, options uint)

func (*Command) Err added in v0.12.0 

func (c *Command) Err(err error)

func (*Command) Error added in v0.16.0 

func (c *Command) Error(messages ...string)

func (*Command) Exec 

func (c *Command) Exec(cmd string, shell string, inherit bool) (string, error)

func (*Command) Fail 

func (c *Command) Fail(e string) (int, error)

func (*Command) Info added in v0.12.0 

func (c *Command) Info(messages ...string)

func (*Command) Input 

func (c *Command) Input() *Input

func (*Command) IsDebug added in v0.14.0 

func (c *Command) IsDebug() bool

func (*Command) IsDecorated added in v0.14.0 

func (c *Command) IsDecorated() bool

func (*Command) IsEnabled 

func (c *Command) IsEnabled() bool

func (*Command) IsQuiet added in v0.14.0 

func (c *Command) IsQuiet() bool

func (*Command) IsVerbose added in v0.14.0 

func (c *Command) IsVerbose() bool

func (*Command) IsVeryVerbose added in v0.14.0 

func (c *Command) IsVeryVerbose() bool

func (*Command) MergeApplication 

func (c *Command) MergeApplication(mergeArgs bool)

func (*Command) Meta 

func (c *Command) Meta() any

func (*Command) NativeDefinition 

func (c *Command) NativeDefinition() *InputDefinition

func (*Command) NewLine added in v0.12.0 

func (c *Command) NewLine(count uint)

func (*Command) Ok added in v0.12.0 

func (c *Command) Ok(messages ...string)

func (*Command) Options 

func (c *Command) Options() map[string]InputType

func (*Command) Output 

func (c *Command) Output() *Output

func (*Command) ProcessedHelp 

func (c *Command) ProcessedHelp() string

func (*Command) Run 

func (c *Command) Run(i *Input, o *Output) (int, error)

func (*Command) SetAliases 

func (c *Command) SetAliases(aliases []string) *Command

func (*Command) SetApplicationDefinition 

func (c *Command) SetApplicationDefinition(definition *InputDefinition)

func (*Command) SetDefinition 

func (c *Command) SetDefinition(definition *InputDefinition)

func (*Command) SetDescription 

func (c *Command) SetDescription(description string) *Command

func (*Command) SetHelp 

func (c *Command) SetHelp(help string) *Command

func (*Command) SetHidden 

func (c *Command) SetHidden(hidden bool) *Command

func (*Command) SetMeta 

func (c *Command) SetMeta(meta any)

func (*Command) SetName 

func (c *Command) SetName(name string) *Command

func (*Command) Spawn added in v0.14.0 

func (c *Command) Spawn(cmd string, shell string, inherit bool) *ChildProcess

func (*Command) Spinner added in v0.12.0 

func (c *Command) Spinner(fn func(), message string)

func (*Command) StringArgument 

func (c *Command) StringArgument(name string) (string, error)

func (*Command) StringOption 

func (c *Command) StringOption(name string) (string, error)

func (*Command) Synopsis 

func (c *Command) Synopsis(short bool) string

func (*Command) Usages 

func (c *Command) Usages() []string

func (*Command) Warn added in v0.12.0 

func (c *Command) Warn(messages ...string)

func (*Command) Write added in v0.13.1 

func (c *Command) Write(message string)

func (*Command) Writeln added in v0.12.0 

func (c *Command) Writeln(message string)

func (*Command) Writelns added in v0.12.0 

func (c *Command) Writelns(messages []string)

type CommandHandle 

type CommandHandle func(c *Command) (int, error)

type CommandInitializer 

type CommandInitializer func(i *Input, o *Output)

type CommandInteracter 

type CommandInteracter func(i *Input, o *Output)

type CommandNotFoundError 

type CommandNotFoundError struct {
	// contains filtered or unexported fields
}

func (*CommandNotFoundError) Alternatives 

func (e *CommandNotFoundError) Alternatives() []string

func (*CommandNotFoundError) Error 

func (e *CommandNotFoundError) Error() string

type ConfirmationQuestion 

type ConfirmationQuestion struct {
	*Question[bool]
	// contains filtered or unexported fields
}

func (*ConfirmationQuestion) DefaultNormalizer 

func (q *ConfirmationQuestion) DefaultNormalizer() QuestionNormalizer[bool]

type ConsoleSectionOutput added in v0.16.0 

type ConsoleSectionOutput struct {
	*Output
	// contains filtered or unexported fields
}

func NewConsoleSectionOutput added in v0.16.0 

func NewConsoleSectionOutput(o *Output, sections []*ConsoleSectionOutput) *ConsoleSectionOutput

func (*ConsoleSectionOutput) AddContent added in v0.16.0 

func (c *ConsoleSectionOutput) AddContent(input string, newLine bool) int

func (*ConsoleSectionOutput) AddNewLineOfInputSubmit added in v0.16.0 

func (c *ConsoleSectionOutput) AddNewLineOfInputSubmit()

func (*ConsoleSectionOutput) Clear added in v0.16.0 

func (c *ConsoleSectionOutput) Clear(lines int)

func (*ConsoleSectionOutput) Content added in v0.16.0 

func (c *ConsoleSectionOutput) Content() string

func (*ConsoleSectionOutput) DoWrite added in v0.16.0 

func (c *ConsoleSectionOutput) DoWrite(message string, newLine bool)

func (*ConsoleSectionOutput) Overwrite added in v0.16.0 

func (c *ConsoleSectionOutput) Overwrite(message string)

func (*ConsoleSectionOutput) OverwriteMany added in v0.16.0 

func (c *ConsoleSectionOutput) OverwriteMany(message []string)

func (*ConsoleSectionOutput) SetMaxHeight added in v0.16.0 

func (c *ConsoleSectionOutput) SetMaxHeight(maxHeight int)

func (*ConsoleSectionOutput) VisibleContent added in v0.16.0 

func (c *ConsoleSectionOutput) VisibleContent() string

type Cursor 

type Cursor struct {
	Output *Output
	Input  *os.File
	// contains filtered or unexported fields
}

func (*Cursor) ClearLine 

func (c *Cursor) ClearLine() *Cursor

func (*Cursor) ClearLineAfter 

func (c *Cursor) ClearLineAfter() *Cursor

func (*Cursor) ClearOutput 

func (c *Cursor) ClearOutput() *Cursor

func (*Cursor) ClearScreen 

func (c *Cursor) ClearScreen() *Cursor

func (*Cursor) CurrentPosition 

func (c *Cursor) CurrentPosition() (int, int)

func (*Cursor) Hide 

func (c *Cursor) Hide() *Cursor

func (*Cursor) Move 

func (c *Cursor) Move(x int, y int) *Cursor

func (*Cursor) MoveDown 

func (c *Cursor) MoveDown(lines int) *Cursor

func (*Cursor) MoveLeft 

func (c *Cursor) MoveLeft(columns int) *Cursor

func (*Cursor) MoveRight 

func (c *Cursor) MoveRight(columns int) *Cursor

func (*Cursor) MoveToColumn 

func (c *Cursor) MoveToColumn(column int) *Cursor

func (*Cursor) MoveToPosition 

func (c *Cursor) MoveToPosition(column int, row int) *Cursor

func (*Cursor) MoveUp 

func (c *Cursor) MoveUp(lines int) *Cursor

func (*Cursor) RestorePosition 

func (c *Cursor) RestorePosition() *Cursor

func (*Cursor) SavePosition 

func (c *Cursor) SavePosition() *Cursor

func (*Cursor) Show 

func (c *Cursor) Show() *Cursor

type DescriptorOptions 

type DescriptorOptions struct {
	// contains filtered or unexported fields
}

type ErrorWithAlternatives 

type ErrorWithAlternatives interface {
	error
	Alternatives() []string
}

func CommandNotFound 

func CommandNotFound(message string, alternatives []string) ErrorWithAlternatives

func NamespaceNotFound 

func NamespaceNotFound(message string, alternatives []string) ErrorWithAlternatives

type Input 

type Input struct {
	Stream *os.File

	Args []string
	// contains filtered or unexported fields
}

func NewInput 

func NewInput(args ...string) *Input

func (*Input) Arguments 

func (i *Input) Arguments() map[string]InputType

func (*Input) ArrayArgument 

func (i *Input) ArrayArgument(name string) ([]string, error)

func (*Input) ArrayOption 

func (i *Input) ArrayOption(name string) ([]string, error)

func (*Input) Bind 

func (i *Input) Bind(definition *InputDefinition) error

func (*Input) BoolOption 

func (i *Input) BoolOption(name string) (bool, error)

func (*Input) EscapeToken 

func (i *Input) EscapeToken(token string) string

func (*Input) FirstArgument 

func (i *Input) FirstArgument() InputType

func (*Input) HasArgument 

func (i *Input) HasArgument(name string) bool

func (*Input) HasOption 

func (i *Input) HasOption(name string) bool

func (*Input) HasParameterOption 

func (i *Input) HasParameterOption(value string, onlyParams bool) bool

func (*Input) IsInteractive 

func (i *Input) IsInteractive() bool

func (*Input) Options 

func (i *Input) Options() map[string]InputType

func (*Input) ParameterOption 

func (i *Input) ParameterOption(value string, defaultValue InputType, onlyParams bool) InputType

func (*Input) Parse 

func (i *Input) Parse() error

func (*Input) SetArgument 

func (i *Input) SetArgument(name string, value InputType) error

func (*Input) SetDefinition 

func (i *Input) SetDefinition(definition *InputDefinition) error

func (*Input) SetInteractive 

func (i *Input) SetInteractive(interactive bool)

func (*Input) SetOption 

func (i *Input) SetOption(name string, value InputType) error

func (*Input) String 

func (i *Input) String() string

func (*Input) StringArgument 

func (i *Input) StringArgument(name string) (string, error)

func (*Input) StringOption 

func (i *Input) StringOption(name string) (string, error)

func (*Input) Validate 

func (i *Input) Validate() error

type InputArgument 

type InputArgument struct {
	Name         string
	Description  string
	Mode         InputArgumentMode
	DefaultValue InputType
	Validator    InputValidator
	// contains filtered or unexported fields
}

func (*InputArgument) Clone 

func (a *InputArgument) Clone() *InputArgument

func (*InputArgument) IsArray 

func (a *InputArgument) IsArray() bool

func (*InputArgument) IsRequired 

func (a *InputArgument) IsRequired() bool

func (*InputArgument) SetDefaultValue 

func (a *InputArgument) SetDefaultValue(value InputType) *InputArgument

func (*InputArgument) SetValidator 

func (a *InputArgument) SetValidator(validator InputValidator) *InputArgument

type InputArgumentMode 

type InputArgumentMode uint8

type InputDefinition 

type InputDefinition struct {
	Arguments []*InputArgument
	Options   []*InputOption
	// contains filtered or unexported fields
}

func (*InputDefinition) AddArgument 

func (d *InputDefinition) AddArgument(argument *InputArgument)

func (*InputDefinition) AddArguments 

func (d *InputDefinition) AddArguments(arguments []*InputArgument)

func (*InputDefinition) AddOption 

func (d *InputDefinition) AddOption(option *InputOption)

func (*InputDefinition) AddOptions 

func (d *InputDefinition) AddOptions(options []*InputOption)

func (*InputDefinition) Argument 

func (d *InputDefinition) Argument(name string) (*InputArgument, error)

func (*InputDefinition) ArgumentByIndex 

func (d *InputDefinition) ArgumentByIndex(index uint) (*InputArgument, error)

func (*InputDefinition) ArgumentCount 

func (d *InputDefinition) ArgumentCount() uint

func (*InputDefinition) ArgumentDefaults 

func (d *InputDefinition) ArgumentDefaults() map[string]InputType

func (*InputDefinition) ArgumentRequiredCount 

func (d *InputDefinition) ArgumentRequiredCount() uint

func (*InputDefinition) GetArguments 

func (d *InputDefinition) GetArguments() []*InputArgument

func (*InputDefinition) GetOptions 

func (d *InputDefinition) GetOptions() []*InputOption

func (*InputDefinition) HasArgument 

func (d *InputDefinition) HasArgument(name string) bool

func (*InputDefinition) HasNegation 

func (d *InputDefinition) HasNegation(name string) bool

func (*InputDefinition) HasOption 

func (d *InputDefinition) HasOption(name string) bool

func (*InputDefinition) HasShortcut 

func (d *InputDefinition) HasShortcut(name string) bool

func (*InputDefinition) NegationToName 

func (d *InputDefinition) NegationToName(negation string) string

func (*InputDefinition) Option 

func (d *InputDefinition) Option(name string) (*InputOption, error)

func (*InputDefinition) OptionDefaults 

func (d *InputDefinition) OptionDefaults() map[string]InputType

func (*InputDefinition) OptionForShortcut 

func (d *InputDefinition) OptionForShortcut(shortcut string) (*InputOption, error)

func (*InputDefinition) SetArguments 

func (d *InputDefinition) SetArguments(arguments []*InputArgument)

func (*InputDefinition) SetDefinition 

func (d *InputDefinition) SetDefinition(arguments []*InputArgument, options []*InputOption)

func (*InputDefinition) SetOptions 

func (d *InputDefinition) SetOptions(options []*InputOption)

func (*InputDefinition) ShortcutToName 

func (d *InputDefinition) ShortcutToName(shortcut string) string

func (*InputDefinition) Synopsis 

func (d *InputDefinition) Synopsis(short bool) string

type InputOption 

type InputOption struct {
	// Should not be prefixed with dashes (e.g. "foo" is ok, "--foo" is not)
	Name string
	// Pipe separated string of shortcuts (e.g. "f|F")
	Shortcut     string
	Description  string
	Mode         InputOptionMode
	DefaultValue InputType
	Validator    InputValidator
	// contains filtered or unexported fields
}

func (*InputOption) AcceptValue 

func (o *InputOption) AcceptValue() bool

func (*InputOption) Clone 

func (o *InputOption) Clone() *InputOption

func (*InputOption) Equals 

func (o *InputOption) Equals(opt *InputOption) bool

func (*InputOption) IsArray 

func (o *InputOption) IsArray() bool

func (*InputOption) IsNegatable 

func (o *InputOption) IsNegatable() bool

func (*InputOption) IsValueOptional 

func (o *InputOption) IsValueOptional() bool

func (*InputOption) IsValueRequired 

func (o *InputOption) IsValueRequired() bool

func (*InputOption) SetDefaultValue 

func (o *InputOption) SetDefaultValue(value InputType) *InputOption

func (*InputOption) SetValidator 

func (o *InputOption) SetValidator(validator InputValidator) *InputOption

type InputOptionMode 

type InputOptionMode uint8

type InputParser 

type InputParser func(self any) error

type InputType 

type InputType any

type InputValidator 

type InputValidator func(value InputType) error

type Listener added in v0.12.0 

type Listener func(key string)

type NamespaceCommands 

type NamespaceCommands struct {
	// contains filtered or unexported fields
}

type NamespaceNotFoundError 

type NamespaceNotFoundError struct {
	// contains filtered or unexported fields
}

func (*NamespaceNotFoundError) Alternatives 

func (e *NamespaceNotFoundError) Alternatives() []string

func (*NamespaceNotFoundError) Error 

func (e *NamespaceNotFoundError) Error() string

type Output 

type Output struct {
	Stream *os.File
	Stderr *Output
	// contains filtered or unexported fields
}

func NewOutput 

func NewOutput(input *Input) *Output

func (*Output) Ask 

func (o *Output) Ask(question string, defaultValue string, validator func(string) (string, error)) (string, error)

func (*Output) AskHidden 

func (o *Output) AskHidden(question string, validator func(string) (string, error)) (string, error)

func (*Output) Block added in v0.11.0 

func (o *Output) Block(messages []string, tag string, style string, prefix string, padding bool, escape bool)

func (*Output) Box 

func (o *Output) Box(title string, body string, footer string, color string, info string)

TODO: impl

func (*Output) Caution 

func (o *Output) Caution(messages ...string)

func (*Output) Choice 

func (o *Output) Choice(question string, choices map[string]string, defaultValue string) (string, error)

func (*Output) Comment added in v0.11.0 

func (o *Output) Comment(messages ...string)

func (*Output) Confirm 

func (o *Output) Confirm(q string, defaultValue bool) (bool, error)

func (*Output) CreateTable added in v0.16.0 

func (o *Output) CreateTable(headers []string, rows [][]*TableCell, options *TableOptions) *Table

func (*Output) CreateTableRowsFromMaps added in v0.16.0 

func (o *Output) CreateTableRowsFromMaps(headers []string, rows []map[string]any) [][]*TableCell

func (*Output) CreateTableRowsFromSlices added in v0.16.0 

func (o *Output) CreateTableRowsFromSlices(rows [][]any) [][]*TableCell

func (*Output) DoWrite 

func (o *Output) DoWrite(message string, newLine bool)

func (*Output) Err 

func (o *Output) Err(messages ...string)

func (*Output) Formatter 

func (o *Output) Formatter() *OutputFormatter

func (*Output) Info 

func (o *Output) Info(messages ...string)

func (*Output) IsDebug 

func (o *Output) IsDebug() bool

func (*Output) IsDecorated 

func (o *Output) IsDecorated() bool

func (*Output) IsQuiet 

func (o *Output) IsQuiet() bool

func (*Output) IsVerbose 

func (o *Output) IsVerbose() bool

func (*Output) IsVeryVerbose 

func (o *Output) IsVeryVerbose() bool

func (*Output) Listing 

func (o *Output) Listing(elements []string, prefix string)

func (*Output) NewLine 

func (o *Output) NewLine(count int)

func (*Output) Note 

func (o *Output) Note(messages ...string)

func (*Output) ProgressAdvance 

func (o *Output) ProgressAdvance(step uint)

TODO: impl

func (*Output) ProgressFinish 

func (o *Output) ProgressFinish()

TODO: impl

func (*Output) ProgressStart 

func (o *Output) ProgressStart(max uint)

TODO: impl

func (*Output) Section 

func (o *Output) Section(message string)

func (*Output) SetDecorated 

func (o *Output) SetDecorated(decorated bool)

func (*Output) SetFormatter 

func (o *Output) SetFormatter(formatter *OutputFormatter)

func (*Output) SetVerbosity 

func (o *Output) SetVerbosity(verbose uint)

func (*Output) Success 

func (o *Output) Success(messages ...string)

func (*Output) Table 

func (o *Output) Table(headers []string, rows [][]*TableCell, options *TableOptions)

func (*Output) TableFromMap added in v0.16.0 

func (o *Output) TableFromMap(rows []map[string]any, headers []string, options *TableOptions)

func (*Output) TableFromSlices added in v0.16.0 

func (o *Output) TableFromSlices(headers []string, rows [][]any, options *TableOptions)

func (*Output) Text 

func (o *Output) Text(messages ...string)

func (*Output) Title 

func (o *Output) Title(message string)

func (*Output) Verbosity 

func (o *Output) Verbosity() uint

func (*Output) Warning 

func (o *Output) Warning(messages ...string)

func (*Output) Write 

func (o *Output) Write(message string, newLine bool, options uint)

func (*Output) WriteMany 

func (o *Output) WriteMany(messages []string, newLine bool, options uint)

func (*Output) Writeln 

func (o *Output) Writeln(s string, options uint)

func (*Output) Writelnf added in v0.12.0 

func (o *Output) Writelnf(f string, options uint, args ...any)

func (*Output) Writelns 

func (o *Output) Writelns(s []string, options uint)

type OutputFormatter 

type OutputFormatter struct {
	Decorated  bool
	Styles     map[string]*OutputFormatterStyle
	StyleStack *OutputFormatterStyleStack
}

func (*OutputFormatter) Clone 

func (o *OutputFormatter) Clone() *OutputFormatter

func (*OutputFormatter) Format 

func (o *OutputFormatter) Format(message string) string

func (*OutputFormatter) FormatAndWrap 

func (o *OutputFormatter) FormatAndWrap(message string, width int) string

func (*OutputFormatter) HasStyle 

func (o *OutputFormatter) HasStyle(name string) bool

func (*OutputFormatter) RemoveDecoration 

func (o *OutputFormatter) RemoveDecoration(str string) string

func (*OutputFormatter) SetStyle 

func (o *OutputFormatter) SetStyle(name string, style *OutputFormatterStyle)

func (*OutputFormatter) Style 

func (o *OutputFormatter) Style(name string) (*OutputFormatterStyle, error)

type OutputFormatterStyle 

type OutputFormatterStyle struct {
	// contains filtered or unexported fields
}

func NewOutputFormatterStyle 

func NewOutputFormatterStyle(foreground string, background string, options []string) *OutputFormatterStyle

func (*OutputFormatterStyle) Apply 

func (s *OutputFormatterStyle) Apply(text string) string

func (*OutputFormatterStyle) Clone 

func (s *OutputFormatterStyle) Clone() *OutputFormatterStyle

func (*OutputFormatterStyle) SetBackground 

func (s *OutputFormatterStyle) SetBackground(c string)

func (*OutputFormatterStyle) SetForeground 

func (s *OutputFormatterStyle) SetForeground(c string)

func (*OutputFormatterStyle) SetHref 

func (s *OutputFormatterStyle) SetHref(href string)

func (*OutputFormatterStyle) SetOption 

func (s *OutputFormatterStyle) SetOption(option string)

func (*OutputFormatterStyle) SetOptions 

func (s *OutputFormatterStyle) SetOptions(options []string)

func (*OutputFormatterStyle) UnsetOption 

func (s *OutputFormatterStyle) UnsetOption(option string)

type OutputFormatterStyleStack 

type OutputFormatterStyleStack struct {
	Styles     []*OutputFormatterStyle
	EmptyStyle *OutputFormatterStyle
}

func (*OutputFormatterStyleStack) Clone 

func (s *OutputFormatterStyleStack) Clone() *OutputFormatterStyleStack

func (*OutputFormatterStyleStack) Current 

func (s *OutputFormatterStyleStack) Current() *OutputFormatterStyle

func (*OutputFormatterStyleStack) Pop 

func (s *OutputFormatterStyleStack) Pop(style *OutputFormatterStyle) *OutputFormatterStyle

func (*OutputFormatterStyleStack) Push 

func (s *OutputFormatterStyleStack) Push(style *OutputFormatterStyle)

func (*OutputFormatterStyleStack) Reset 

func (s *OutputFormatterStyleStack) Reset()

type OutputTheme 

type OutputTheme map[string]*OutputFormatterStyle

type Prompt added in v0.12.0 

type Prompt struct {
	Name          string
	State         uint
	Error         string
	CancelMessage string
	Required      bool
	Validator     func(string) string
	Scroll        int
	Highlighted   int
	FirstVisible  int
	DefaultValue  string
	Input         *Input
	Output        *Output

	CancelUsingFn   AnyFunc
	ValidateUsingFn func(any) string
	RevertUsingFn   AnyFunc
	// contains filtered or unexported fields
}

func NewPrompt added in v0.12.0 

func NewPrompt(name string, i *Input, o *Output) *Prompt

func (*Prompt) Fallback added in v0.12.0 

func (p *Prompt) Fallback() string

func (*Prompt) Prompt added in v0.12.0 

func (p *Prompt) Prompt(renderer func() string) (string, error)

func (*Prompt) Render added in v0.12.0 

func (p *Prompt) Render(frame string)

func (*Prompt) Restore added in v0.12.0 

func (p *Prompt) Restore()

func (*Prompt) ShouldFallback added in v0.12.0 

func (p *Prompt) ShouldFallback() bool

func (*Prompt) Value added in v0.12.0 

func (p *Prompt) Value() string

type Question 

type Question[T any] struct {
	Query           string
	Attempts        int
	Hidden          bool
	HiddenFallback  bool
	Validator       QuestionValidator[T]
	Normalizer      QuestionNormalizer[T]
	PreventTrimming bool
	Multiline       bool
	DefaultValue    T
}

func (*Question[any]) DefaultNormalizer 

func (q *Question[any]) DefaultNormalizer() QuestionNormalizer[any]

func (*Question[any]) DefaultValidator 

func (q *Question[any]) DefaultValidator() QuestionValidator[any]

func (*Question[any]) IsQuestion 

func (q *Question[any]) IsQuestion() bool

type QuestionInterface 

type QuestionInterface interface {
	IsQuestion() bool
}

type QuestionNormalizer 

type QuestionNormalizer[T any] func(string) T

type QuestionValidator 

type QuestionValidator[T any] func(T) (T, error)

type Renderer added in v0.12.0 

type Renderer struct {
	// contains filtered or unexported fields
}

func NewRenderer added in v0.12.0 

func NewRenderer() *Renderer

func (*Renderer) Err added in v0.12.0 

func (r *Renderer) Err(message string)

func (*Renderer) Hint added in v0.12.0 

func (r *Renderer) Hint(message string)

func (*Renderer) Line added in v0.12.0 

func (r *Renderer) Line(message string, newLine bool)

func (*Renderer) NewLine added in v0.12.0 

func (r *Renderer) NewLine(count int)

func (*Renderer) ToString added in v0.12.0 

func (r *Renderer) ToString(state uint) string

func (*Renderer) Warning added in v0.12.0 

func (r *Renderer) Warning(message string)

func (*Renderer) When added in v0.12.0 

func (r *Renderer) When(condition bool, cb func(*Renderer), defaultCb func(*Renderer))

type RendererInterface added in v0.12.0 

type RendererInterface interface {
	Render(prompt any)
	String() string
}

func NewSpinnerRenderer added in v0.12.0 

func NewSpinnerRenderer(s *Spinner) RendererInterface

type ScrollBar 

type ScrollBar struct{}

func (ScrollBar) Draw 

func (s ScrollBar) Draw(visible []string, firstVisible string, height int, total int, width int, color string) string

TODO: impl

type Spinner added in v0.12.0 

type Spinner struct {
	*Prompt
	Interval int
	Count    int
	Message  string
	Frames   []string
	Color    string
	// contains filtered or unexported fields
}

func NewSpinner added in v0.12.0 

func NewSpinner(i *Input, o *Output, message string, frames []string, color string) *Spinner

func (*Spinner) Spin added in v0.12.0 

func (s *Spinner) Spin(fn func())

type Table added in v0.16.0 

type Table struct {
	// contains filtered or unexported fields
}

func NewTable added in v0.16.0 

func NewTable(o *Output) *Table

func (*Table) AddRow added in v0.16.0 

func (t *Table) AddRow(rows []*TableCell)

func (*Table) AddRows added in v0.16.0 

func (t *Table) AddRows(rows [][]*TableCell)

func (*Table) AppendRow added in v0.16.0 

func (t *Table) AppendRow(row []*TableCell)

func (*Table) ColumnStyle added in v0.16.0 

func (t *Table) ColumnStyle(columnIndex int) *TableStyle

func (*Table) Render added in v0.16.0 

func (t *Table) Render()

func (*Table) SetColumnMaxWidth added in v0.16.0 

func (t *Table) SetColumnMaxWidth(columnIndex int, maxWidth int)

func (*Table) SetColumnStyle added in v0.16.0 

func (t *Table) SetColumnStyle(i uint, style *TableStyle)

func (*Table) SetColumnStyleByName added in v0.16.0 

func (t *Table) SetColumnStyleByName(i uint, name string)

func (*Table) SetColumnWidth added in v0.16.0 

func (t *Table) SetColumnWidth(columnIndex int, width int)

func (*Table) SetColumnWidths added in v0.16.0 

func (t *Table) SetColumnWidths(widths []int)

func (*Table) SetFooterTitle added in v0.16.0 

func (t *Table) SetFooterTitle(title string)

func (*Table) SetHeaderTitle added in v0.16.0 

func (t *Table) SetHeaderTitle(title string)

func (*Table) SetHeaders added in v0.16.0 

func (t *Table) SetHeaders(headers []string)

func (*Table) SetHorizontal added in v0.16.0 

func (t *Table) SetHorizontal(horizontal bool)

func (*Table) SetRow added in v0.16.0 

func (t *Table) SetRow(columnIndex int, row []*TableCell)

func (*Table) SetRows added in v0.16.0 

func (t *Table) SetRows(rows [][]*TableCell)

func (*Table) SetStyle added in v0.16.0 

func (t *Table) SetStyle(style *TableStyle)

func (*Table) SetStyleByName added in v0.16.0 

func (t *Table) SetStyleByName(style string)

func (*Table) SetVertical added in v0.16.0 

func (t *Table) SetVertical(vertical bool)

func (*Table) Style added in v0.16.0 

func (t *Table) Style() *TableStyle

type TableCell added in v0.16.0 

type TableCell struct {
	Value       string
	RowSpan     uint
	ColSpan     uint
	Style       *TableCellStyle
	IsSeparator bool
}

func NewTableCell added in v0.16.0 

func NewTableCell(value string) *TableCell

func NewTableSeparator added in v0.16.0 

func NewTableSeparator() *TableCell

func (*TableCell) String added in v0.16.0 

func (c *TableCell) String() string

type TableCellStyle added in v0.16.0 

type TableCellStyle struct {
	Foreground string
	Background string
	Options    []string
	// left, center or right
	Align      string
	CellFormat string
}

type TableOptions added in v0.16.0 

type TableOptions struct {
	DisplayOrientation string
	HeaderTitle        string
	FooterTitle        string
	Style              string
	Align              string
}

type TableStyle added in v0.16.0 

type TableStyle struct {
	PaddingChar                 string
	HorizontalOutsideBorderChar string
	HorizontalInsideBorderChar  string
	VerticalOutsideBorderChar   string
	VerticalInsideBorderChar    string
	CrossingChar                string
	CrossingTopRightChar        string
	CrossingTopMidChar          string
	CrossingTopLeftChar         string
	CrossingMidRightChar        string
	CrossingBottomRightChar     string
	CrossingBottomMidChar       string
	CrossingBottomLeftChar      string
	CrossingMidLeftChar         string
	CrossingTopLeftBottomChar   string
	CrossingTopMidBottomChar    string
	CrossingTopRightBottomChar  string
	HeaderTitleFormat           string
	FooterTitleFormat           string
	CellHeaderFormat            string
	CellRowFormat               string
	CellRowContentFormat        string
	BorderFormat                string
	PadType                     string
}

func NewTableStyle added in v0.16.0 

func NewTableStyle(name string) *TableStyle

func (*TableStyle) Clone added in v0.16.0 

func (s *TableStyle) Clone() *TableStyle

func (*TableStyle) SetDefaultCrossingChar added in v0.16.0 

func (ts *TableStyle) SetDefaultCrossingChar(char string)

type TextDescriptor 

type TextDescriptor struct {
	Output *Output
}

func (*TextDescriptor) DescribeApplication 

func (d *TextDescriptor) DescribeApplication(app *Application, options *DescriptorOptions)

func (*TextDescriptor) DescribeCommand 

func (d *TextDescriptor) DescribeCommand(command *Command, options *DescriptorOptions)

func (*TextDescriptor) DescribeInputArgument 

func (d *TextDescriptor) DescribeInputArgument(argument *InputArgument, options *DescriptorOptions)

func (*TextDescriptor) DescribeInputDefinition 

func (d *TextDescriptor) DescribeInputDefinition(definition *InputDefinition, options *DescriptorOptions)

func (*TextDescriptor) DescribeInputOption 

func (d *TextDescriptor) DescribeInputOption(option *InputOption, options *DescriptorOptions)

func (*TextDescriptor) Write 

func (d *TextDescriptor) Write(content string, decorated bool)

type Theme added in v0.13.0 

type Theme struct {
	Foreground string
	Background string
	Options    []string
}

type TrimmedBufferOutput 

type TrimmedBufferOutput struct {
	*Output
	// contains filtered or unexported fields
}

func (*TrimmedBufferOutput) DoWrite 

func (o *TrimmedBufferOutput) DoWrite(message string, newLine bool)

func (*TrimmedBufferOutput) Fetch 

func (o *TrimmedBufferOutput) Fetch() string

Source Files

View all Source files

Directories

Path Synopsis
array
keys
maps

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.
JackTT - Gopher 🇻🇳