goprogram

Dec 2, 2022

Changes in this version

type Context

+ func GetContext(ctx context.Context) *Context[E, P, F, R]

Nov 27, 2022

Changes in this version

type Context

+ Context context.Context

+ func (context Context[E, P, F, R]) AddCleanupFunction(f ContextCleanupFunc[E, P, F, R])

+ type ContextCleanupFunc func(context *Context[E, P, F, R])

type Program

+ NewContext func(params *P, parent context.Context) (context.Context, ContextCleanupFunc[E, P, F, R], error)

Sep 7, 2022

Changes in this version

type Context

+ func (context Context[E, P, F, R]) Exec(command string, args ...string) error

+ func (context Context[E, P, F, R]) InExec() bool

type Program

+ func (p Program[E, P, F, R]) Exec(context Context[E, P, F, R], command string, pos ...string) error

Aug 26, 2022

Changes in this version

type Program

+ BeforeAlias func(context Context[E, P, F, R], alias Alias) error

+ BeforeCommand func(context Context[E, P, F, R], command Command[E, P, F, R]) error

+ BeforeKeyword func(context Context[E, P, F, R], keyword Keyword[F]) error

May 2, 2022

Changes in this version

type Context

+ Program Program[E, P, F, R]

Apr 18, 2022

Changes in this version

type Program

+ func (p Program[E, P, F, R]) Command(name string) (Command[E, P, F, R], bool)

Apr 15, 2022

Changes in this version

+ type AfterParseCommand interface

+ AfterParse func() error

type Description

+ ParserConfig parser.Config

Mar 28, 2022

Changes in this version

+ type EmptyRequirement struct

+ func (EmptyRequirement[F]) AllowsFlag(meta.Flag) bool

+ func (EmptyRequirement[F]) Validate(Arguments[F]) error

Mar 9, 2022

Changes in this version

+ func ValidateAllowedFlags(r Requirement[F], args Arguments[F]) error

+ type Alias struct

+ Args []string

+ Command string

+ Description string

+ Name string

+ func (a Alias) Expansion() []string

+ func (a Alias) Invoke(args []string) (command string, arguments []string)

+ type Arguments struct

+ Command string

+ Flags F

+ Pos []string

+ Universals Universals

+ type Command interface

+ AfterParse func() error

+ BeforeRegister func(program *Program[E, P, F, R])

+ Description func() Description[F, R]

+ Run func(context Context[E, P, F, R]) error

+ func CloneCommand(command Command[E, P, F, R]) (cmd Command[E, P, F, R])

+ type Context struct

+ Args Arguments[F]

+ Description Description[F, R]

+ Environment E

+ type Description struct

+ Command string

+ Description string

+ Positional meta.Positional

+ Requirements R

+ type Keyword func(args *Arguments[F]) error

+ type Program struct

+ Info meta.Info

+ NewEnvironment func(params P, context Context[E, P, F, R]) (E, error)

+ func (p *Program[E, P, F, R]) RegisterKeyword(name string, keyword Keyword[F])

+ func (p *Program[R, P, Flags, Requirements]) Register(c Command[R, P, Flags, Requirements])

+ func (p *Program[Runtime, Parameters, Flags, Requirements]) RegisterAlias(alias Alias)

+ func (p Program[E, P, F, R]) AliasUsage(context Context[E, P, F, R], alias Alias) meta.Meta

+ func (p Program[E, P, F, R]) CommandUsage(context Context[E, P, F, R]) meta.Meta

+ func (p Program[E, P, F, R]) Commands() []string

+ func (p Program[E, P, F, R]) FmtCommands() string

+ func (p Program[E, P, F, R]) Main(stream stream.IOStream, params P, argv []string) (err error)

+ func (p Program[E, P, F, R]) MainUsage() meta.Meta

+ func (p Program[Runtime, Parameters, Flags, Requirements]) Aliases() []string

+ type Requirement interface

+ AllowsFlag func(flag meta.Flag) bool

+ Validate func(arguments Arguments[F]) error

+ type Universals struct

+ Help bool

+ Version bool