cmdgo

package module

Go to main page

Versions in this module

v0

v0.5.4

Sep 14, 2023

v0.5.3

Sep 14, 2023

Changes in this version

type Property

+ func (prop Property) HasCustomPromptText() bool

v0.5.2

Sep 14, 2023

Changes in this version

+ func DisplayEntryHelp(opts *Options, entry *Entry) error

+ func DisplayHelp(opts *Options, registry Registry, help string) error

+ func DisplayRootHelp(opts *Options, registry Registry)

v0.5.1

Jan 27, 2023

v0.5.0

Jan 26, 2023

Changes in this version

type PromptOptions

+ Validate func(value any, text string) error

+ ValidateText func(text string) error

v0.4.1

Jan 26, 2023

v0.4.0

Dec 5, 2022

Changes in this version

+ type Entry struct

+ Aliases []string

+ Command any

+ HelpLong string

+ HelpShort string

+ Name string

+ Sub Registry

v0.3.1

Nov 16, 2022

v0.3.0

Nov 16, 2022

Changes in this version

+ var ErrDiscard = errors.New("DISCARD")

+ var ErrInvalidConversion = errors.New("invalid conversion")

+ var ErrInvalidFormat = errors.New("invalid format")

+ var ErrInvalidUnmarshalError = errors.New("non-pointer passed to Unmarshal")

+ var ErrNoCommand = errors.New("no command given, try running with --help")

+ var ErrNoPrompt = errors.New("NOPROMPT")

+ var ErrQuit = errors.New("QUIT")

+ var ErrRegexFailed = errors.New("NOREGEX")

+ var ErrUnsupportedType = errors.New("unsupported type")

+ var ErrVerifyFailed = errors.New("NOVERIFY")

+ func Peek(opts *Options) any

type Options

+ ArgsOriginal []string

+ func (opts *Options) Context() context.Context

+ func (opts *Options) RestorArgs() *Options

+ func (opts *Options) WithContext(ctx context.Context) *Options

type Registry

+ func CreateRegistry(entries []RegistryEntry) Registry

+ func (r Registry) EntriesAll() []RegistryEntry

+ func (r Registry) EntryForDeep(namePartials []string) (*RegistryEntry, int)

+ func (r Registry) ExecuteReturn(opts *Options) (any, error)

+ func (r Registry) GetDeep(namePartials []string) (any, int)

+ func (r Registry) HasDeep(namePartials []string) bool

+ func (r Registry) IsEmpty() bool

type RegistryEntry

+ Sub Registry

v0.2.1

Nov 15, 2022

Changes in this version

type Registry

+ func (r Registry) Peek(opts *Options) any

v0.2.0

Oct 17, 2022

Changes in this version

+ var CaptureImports = map[string]CaptureImporter

+ var Discard = errors.New("DISCARD")

+ var GlobalRegistry = NewRegistry()

+ var InvalidConversion = errors.New("Invalid conversion.")

+ var InvalidFormat = errors.New("Invalid format.")

+ var InvalidUnmarshalError = errors.New("non-pointer passed to Unmarshal")

+ var NoCommand = errors.New("No command given, try running with --help.")

+ var NoPrompt = errors.New("NOPROMPT")

+ var Quit = errors.New("QUIT")

+ var RegexFailed = errors.New("NOREGEX")

+ var UnsupportedType = errors.New("Unsupported type.")

+ var VerifyFailed = errors.New("NOVERIFY")

+ func Capture(opts *Options) (any, error)

+ func CaptureExitSignal(f func())

+ func Execute(opts *Options) error

+ func Get(name string) any

+ func GetArg(name string, defaultValue string, args *[]string, argPrefix string, flag bool) string

+ func Normalize(x string) string

+ func ParseType(t reflect.Type, s string) (any, error)

+ func Register(entry RegistryEntry)

+ func SetString(value reflect.Value, s string) error

+ func Unmarshal(opts *Options, v any) error

+ type ArgValue interface

+ FromArgs func(opts *Options, prop *Property, ...) error

+ type CaptureImporter func(data []byte, target any) error

+ type Dynamic interface

+ Update func(opts *Options, updated *Property, instance *Instance) error

+ type Executable interface

+ Execute func(opts *Options) error

+ type Flags struct

+ func (f *Flags[T]) Clear()

+ func (f *Flags[T]) Only(flags T)

+ func (f *Flags[T]) Remove(flags T)

+ func (f *Flags[T]) Set(flags T)

+ func (f *Flags[T]) Toggle(flags T)

+ func (f Flags[T]) Get() T

+ func (f Flags[T]) Is(match Match[T]) bool

+ func (f Flags[T]) IsEmpty() bool

+ type HasChoices interface

+ GetChoices func(opts *Options, prop *Property) PromptChoices

+ type Instance struct

+ PropertyList []*Property

+ PropertyMap map[string]*Property

+ Value reflect.Value

+ func GetInstance(value any) Instance

+ func GetSubInstance(value any, prop Property) Instance

+ func (inst *Instance) AddProperty(prop *Property)

+ func (inst *Instance) Capture(opts *Options) error

+ func (inst Instance) Count(match Match[PropertyFlags]) int

+ func (inst Instance) Flags() Flags[PropertyFlags]

+ func (inst Instance) IsDefault() bool

+ type Match func(value T) bool

+ func MatchAll(test T) Match[T]

+ func MatchAnd(ands ...Match[T]) Match[T]

+ func MatchAny(test T) Match[T]

+ func MatchEmpty() Match[T]

+ func MatchExact(test T) Match[T]

+ func MatchNone(test T) Match[T]

+ func MatchNot(not Match[T]) Match[T]

+ func MatchOnly(test T) Match[T]

+ func MatchOr(ors ...Match[T]) Match[T]

+ type Options struct

+ ArgArrayTemplate *template.Template

+ ArgMapKeyTemplate *template.Template

+ ArgMapValueTemplate *template.Template

+ ArgPrefix string

+ ArgSliceTemplate *template.Template

+ ArgStartIndex int

+ ArgStructTemplate *template.Template

+ Args []string

+ DisablePrompt bool

+ DiscardPrompt string

+ DisplayHelp func(help string, prop *Property)

+ ForcePrompt bool

+ HelpIndentWidth int

+ HelpPrompt string

+ HelpTemplate *template.Template

+ HelpWrapWidth int

+ PromptContext PromptContext

+ PromptEnd func(prop Property) error

+ PromptMore func(prop Property) (bool, error)

+ PromptMoreOptions map[string]bool

+ PromptMoreSuffix string

+ PromptOnce func(prompt string, options PromptOnceOptions) (string, error)

+ PromptStart func(prop Property) (bool, error)

+ PromptStartOptions map[string]bool

+ PromptStartSuffix string

+ PromptTemplate *template.Template

+ QuitPrompt string

+ RepromptMapValues bool

+ RepromptOnInvalid int

+ RepromptSliceElements bool

+ Values map[string]any

+ func NewOptions() *Options

+ func (opts *Options) CanPrompt() bool

+ func (opts *Options) CaptureExitSignal()

+ func (opts *Options) ClearArgs() *Options

+ func (opts *Options) ClearFiles() *Options

+ func (opts *Options) Cli() *Options

+ func (opts *Options) Close() error

+ func (opts *Options) Printf(format string, args ...any) error

+ func (opts *Options) Program() *Options

+ func (opts *Options) Prompt(options PromptOptions) (any, error)

+ func (opts *Options) Std() *Options

+ func (opts *Options) WithArgs(args []string) *Options

+ func (opts *Options) WithFiles(in *os.File, out *os.File) *Options

+ type PromptChoice struct

+ Text string

+ Value string

+ type PromptChoices map[string]PromptChoice

+ func (pc PromptChoices) Add(input string, value string)

+ func (pc PromptChoices) Convert(input string) (string, error)

+ func (pc PromptChoices) FromTag(tag string, pairDelimiter string, keyValueDelimiter string)

+ func (pc PromptChoices) HasChoices() bool

+ type PromptContext struct

+ IsMapKey bool

+ IsMapValue bool

+ IsSlice bool

+ MapKey string

+ Reprompt bool

+ SliceIndex int

+ type PromptCustom interface

+ Prompt func(opts *Options, prop *Property) error

+ type PromptOnceOptions struct

+ Hidden bool

+ Multi bool

+ MultiStop string

+ type PromptOptions struct

+ Choices PromptChoices

+ GetPrompt func(status PromptStatus) (string, error)

+ Help string

+ Hidden bool

+ Multi bool

+ MultiStop string

+ Optional bool

+ Prompt string

+ Prop *Property

+ Regex string

+ Tries int

+ Type reflect.Type

+ Verify bool

+ type PromptStatus struct

+ AfterHelp bool

+ InvalidChoice int

+ InvalidFormat int

+ InvalidVerify int

+ PromptCount int

+ Verify bool

+ type PromptValue interface

+ FromPrompt func(opts *Options, value string) error

+ type Property struct

+ Arg string

+ Choices PromptChoices

+ Default string

+ DefaultText string

+ Env []string

+ Flags Flags[PropertyFlags]

+ Help string

+ HideDefault bool

+ HidePrompt bool

+ InputHidden bool

+ Max *float64

+ Min *float64

+ Name string

+ PromptEmpty bool

+ PromptEnd string

+ PromptMore string

+ PromptMulti bool

+ PromptStart string

+ PromptText string

+ PromptTries int

+ PromptVerify bool

+ Regex string

+ Reprompt bool

+ Type reflect.Type

+ Value reflect.Value

+ func (prop *Property) FromArgs(opts *Options) error

+ func (prop *Property) GetPromptChoices(opts *Options) PromptChoices

+ func (prop *Property) Load(opts *Options) error

+ func (prop *Property) Prompt(opts *Options) error

+ func (prop *Property) Set(opts *Options, input string, addFlags PropertyFlags) error

+ func (prop Property) CanFromArgs() bool

+ func (prop Property) CanLoad() bool

+ func (prop Property) CanPrompt() bool

+ func (prop Property) ConcreteType() reflect.Type

+ func (prop Property) ConcreteValue() any

+ func (prop Property) IsArray() bool

+ func (prop Property) IsBool() bool

+ func (prop Property) IsDefault() bool

+ func (prop Property) IsIgnored() bool

+ func (prop Property) IsKind(kind reflect.Kind) bool

+ func (prop Property) IsKinds(kinds map[reflect.Kind]struct{}) bool

+ func (prop Property) IsMap() bool

+ func (prop Property) IsNil() bool

+ func (prop Property) IsOptional() bool

+ func (prop Property) IsSimple() bool

+ func (prop Property) IsSlice() bool

+ func (prop Property) IsStruct() bool

+ func (prop Property) Size() float64

+ func (prop Property) Validate(opts *Options) error

+ type PropertyFlags uint

+ const PropertyFlagArgs

+ const PropertyFlagDefault

+ const PropertyFlagEnv

+ const PropertyFlagNone

+ const PropertyFlagPrompt

+ type Registry struct

+ func NewRegistry() Registry

+ func (r *Registry) Add(entry RegistryEntry)

+ func (r Registry) Capture(opts *Options) (any, error)

+ func (r Registry) Entries() []*RegistryEntry

+ func (r Registry) EntryFor(namePartial string) *RegistryEntry

+ func (r Registry) Execute(opts *Options) error

+ func (r Registry) Get(namePartial string) any

+ func (r Registry) Has(namePartial string) bool

+ func (r Registry) Matches(namePartial string) []*RegistryEntry

+ type RegistryEntry struct

+ Aliases []string

+ Command any

+ HelpLong string

+ HelpShort string

+ Name string

+ type Validator interface

+ Validate func(opts *Options) error

v0.1.0

Oct 11, 2022

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL