couleuvre

Documentation

Index

• type App
  • func NewApp[T Config](envPrefix, envReplaceFrom, envReplaceTo string) (a App[T])
  • func (a *App[T]) AddCommands(commands ...Command) error
  • func (a App[T]) Commands() []Command
  • func (a *App[T]) NewCommand(name, description string, executer ExecuterFunc, aliases ...string) error
  • func (a *App[T]) Parse() (err error)
  • func (a App[T]) ParseCommand(cmd string) (found Command, err error)
  • func (a App[T]) ParseToDestination(destination any) (err error)
• type Command
  • func NewCommand(name string, description string, executer ExecuterFunc, aliases ...string) (command Command, err error)
  • func ParseCommand(cmds []Command, cmd string) (found Command, err error)
  • func (c Command) Complete() bool
  • func (c Command) Execute() error
  • func (c Command) String() string
• type Config
• type ExecuterFunc

Types

type App

type App[T Config] struct {
	// String to use as prefix for environment variables parsing
	EnvPrefix string

	// String to replace for environment variables parsing
	EnvReplaceFrom string

	// String to replace to for environment variables parsing
	EnvReplaceTo string

	Config T
	// contains filtered or unexported fields
}

func NewApp

func NewApp[T Config](envPrefix, envReplaceFrom, envReplaceTo string) (a App[T])

func (*App[T]) AddCommands

func (a *App[T]) AddCommands(commands ...Command) error

func (App[T]) Commands

func (a App[T]) Commands() []Command

func (*App[T]) NewCommand

func (a *App[T]) NewCommand(name, description string, executer ExecuterFunc, aliases ...string) error

func (*App[T]) Parse

func (a *App[T]) Parse() (err error)

func (App[T]) ParseCommand

func (a App[T]) ParseCommand(cmd string) (found Command, err error)

func (App[T]) ParseToDestination

func (a App[T]) ParseToDestination(destination any) (err error)

type Command

type Command struct {
	// flag.FlagSet
	Name        string
	Aliases     []string
	Description string
	// Subcommands []Command
	Executer ExecuterFunc
}

func NewCommand

func NewCommand(name string, description string, executer ExecuterFunc, aliases ...string) (command Command, err error)

func ParseCommand

func ParseCommand(cmds []Command, cmd string) (found Command, err error)

func (Command) Complete

func (c Command) Complete() bool

func (Command) Execute

func (c Command) Execute() error

func (Command) String

func (c Command) String() string

type Config

type Config interface{}

type ExecuterFunc

type ExecuterFunc func() error