command

Documentation

Index

• Constants
• func BuildCompleter() *readline.PrefixCompleter
• func RegisterCommand(cmd Command)
• type ArgumentDefintion
• type BaseCommand
  • func NewBaseCommand(cmd string, argDefs []ArgumentDefintion, flagDefs []FlagDefintion) *BaseCommand
  • func (cmd *BaseCommand) GetCommand() string
  • func (cmd *BaseCommand) GetFlags() map[string]bool
  • func (cmd *BaseCommand) GetParameter(idx int, defaultValue string) string
  • func (cmd *BaseCommand) GetParams() []string
  • func (cmd *BaseCommand) IsFlagSet(flag ...string) bool
  • func (cmd *BaseCommand) SetFlags(flags map[string]bool)
  • func (cmd *BaseCommand) SetParams(params []string)
• type Command
  • func FindCommand(cmd string) (Command, error)
  • func ParseEditorCommand(editorCmd string) (Command, error)
• type FlagDefintion
• type GenericArgumentDefinition
  • func (fd *GenericArgumentDefinition) GetDescription(selection uint) string
  • func (fd *GenericArgumentDefinition) GetExample() string
  • func (fd *GenericArgumentDefinition) GetName() string
  • func (fd *GenericArgumentDefinition) IsOptional() bool
• type GenericFlagDefinition
  • func (fd *GenericFlagDefinition) GetDefaultValue() interface{}
  • func (fd *GenericFlagDefinition) GetDescription(selection uint) string
  • func (fd *GenericFlagDefinition) GetExample() string
  • func (fd *GenericFlagDefinition) GetName() string
  • func (fd *GenericFlagDefinition) GetShortName() string
• type ParamDefinition

Constants

const (
	// CommandCd ...
	CommandCd = "cd"

	// CommandClearCache ...
	CommandClearCache = "clearCache"

	// CommandLs ...
	CommandLs = "ls"

	//CommandDir ...
	CommandDir = "dir"

	// CommandHelp ...
	CommandHelp = "help"

	// CommandCreate ...
	CommandCreate = "create"

	// CommandEcho ...
	CommandEcho = "echo"

	// CommandRm ...
	CommandRm = "rm"

	// CommandCopy ...
	CommandCopy = "cp"

	// CommandWatch ...
	CommandWatch = "watch"
)

Functions

func BuildCompleter

func BuildCompleter() *readline.PrefixCompleter

BuildCompleter ...

func RegisterCommand

func RegisterCommand(cmd Command)

RegisterCommand ...

Types

type ArgumentDefintion

type ArgumentDefintion interface {
	ParamDefinition

	IsOptional() bool
}

ArgumentDefintion ...

type BaseCommand

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

BaseCommand ...

func NewBaseCommand

func NewBaseCommand(cmd string, argDefs []ArgumentDefintion, flagDefs []FlagDefintion) *BaseCommand

NewBaseCommand ...

func (*BaseCommand) GetCommand

func (cmd *BaseCommand) GetCommand() string

GetCommand ...

func (*BaseCommand) GetFlags

func (cmd *BaseCommand) GetFlags() map[string]bool

GetFlags ...

func (*BaseCommand) GetParameter

func (cmd *BaseCommand) GetParameter(idx int, defaultValue string) string

GetParameter ...

func (*BaseCommand) GetParams

func (cmd *BaseCommand) GetParams() []string

GetParams ...

func (*BaseCommand) IsFlagSet

func (cmd *BaseCommand) IsFlagSet(flag ...string) bool

IsFlagSet ...

func (*BaseCommand) SetFlags

func (cmd *BaseCommand) SetFlags(flags map[string]bool)

SetFlags ...

func (*BaseCommand) SetParams

func (cmd *BaseCommand) SetParams(params []string)

SetParams ...

type Command

type Command interface {
	GetParameter(idx int, defaultValue string) string
	GetCommand() string
	GetParams() []string
	GetFlags() map[string]bool
	IsFlagSet(flag ...string) bool
	SetParams(params []string)
	SetFlags(flags map[string]bool)

	Execute(ctx context.Container, buffer *string) (uint, error)
	Completer(ctx context.Container, input string) []string
}

Command ...

func FindCommand

func FindCommand(cmd string) (Command, error)

FindCommand ...

func ParseEditorCommand

func ParseEditorCommand(editorCmd string) (Command, error)

ParseEditorCommand ...

type FlagDefintion

type FlagDefintion interface {
	ParamDefinition

	GetShortName() string
	GetDefaultValue() interface{}
}

FlagDefintion ...

type GenericArgumentDefinition

type GenericArgumentDefinition struct {
	Name        string
	Description *text.Template
	Example     string
	Optional    bool
}

GenericArgumentDefinition ...

func (*GenericArgumentDefinition) GetDescription

func (fd *GenericArgumentDefinition) GetDescription(selection uint) string

GetDescription ...

func (*GenericArgumentDefinition) GetExample

func (fd *GenericArgumentDefinition) GetExample() string

GetExample ...

func (*GenericArgumentDefinition) GetName

func (fd *GenericArgumentDefinition) GetName() string

GetName ...

func (*GenericArgumentDefinition) IsOptional

func (fd *GenericArgumentDefinition) IsOptional() bool

IsOptional ...

type GenericFlagDefinition

type GenericFlagDefinition struct {
	ShortName    string
	Name         string
	Description  *text.Template
	Example      string
	DefaultValue interface{}
}

GenericFlagDefinition ...

func (*GenericFlagDefinition) GetDefaultValue

func (fd *GenericFlagDefinition) GetDefaultValue() interface{}

GetDefaultValue ...

func (*GenericFlagDefinition) GetDescription

func (fd *GenericFlagDefinition) GetDescription(selection uint) string

GetDescription ...

func (*GenericFlagDefinition) GetExample

func (fd *GenericFlagDefinition) GetExample() string

GetExample ...

func (*GenericFlagDefinition) GetName

func (fd *GenericFlagDefinition) GetName() string

GetName ...

func (*GenericFlagDefinition) GetShortName

func (fd *GenericFlagDefinition) GetShortName() string

GetShortName ...

type ParamDefinition

type ParamDefinition interface {
	GetName() string
	GetDescription(selection uint) string
	GetExample() string
}

ParamDefinition ...