appcli

Documentation

Index

• func InstallCompletion(meta *Metadata) error
• func IsCompleting(args []string) bool
• func NewApp(args []string, meta *Metadata) (*cli.App, error)
• func ShowAppHelp(logger *ui.Logger, app *cli.App)
• func UninstallCompletion(meta *Metadata) error
• type Metadata
  • func NewConfiglessMetadata(logger *ui.Logger) *Metadata
  • func NewMetadata(logger *ui.Logger, args []string) (*Metadata, error)

Functions

func InstallCompletion

func InstallCompletion(meta *Metadata) error

InstallCompletion installs command line tab completion for a given shell.

func IsCompleting

func IsCompleting(args []string) bool

IsCompleting returns whether tab-completion is currently occurring.

func NewApp

func NewApp(args []string, meta *Metadata) (*cli.App, error)

NewApp creates a cli.App that executes tasks.

func ShowAppHelp

func ShowAppHelp(logger *ui.Logger, app *cli.App)

ShowAppHelp shows the help for a given app.

func UninstallCompletion

func UninstallCompletion(meta *Metadata) error

UninstallCompletion uninstalls command line tab completion for a given shell.

Types

type Metadata

type Metadata struct {
	CfgPath     string
	CfgText     []byte
	Interpreter []string
	Logger      *ui.Logger

	InstallCompletion   string
	UninstallCompletion string
	PrintHelp           bool
	PrintVersion        bool
	CleanCache          bool
	CleanProjectCache   bool
	CleanTaskCache      string
}

Metadata contains global configuration settings.

func NewConfiglessMetadata

func NewConfiglessMetadata(logger *ui.Logger) *Metadata

NewConfiglessMetadata returns a metadata object with application defaults, without any user configuration. This can be used to provide basic functionality in case of user error.

func NewMetadata

func NewMetadata(logger *ui.Logger, args []string) (*Metadata, error)

NewMetadata returns a metadata object based on global options passed.