workspace

Documentation

Index

• type Context
  • func (s *Context) Flag(name string, flag *kingpin.FlagClause) (cliFlag *kingpinCli.FlagClause)
  • func (s *Context) GetStringValue(field string) (value string, found, isDefault bool, _ error)
• type Info
• type Workspace
  • func (w *Workspace) Action(action string)
  • func (w *Workspace) DefineContext(context clier.ParseContexter)
  • func (w *Workspace) GetStringValue(field string) (value string, found, isDefault bool, _ error)
  • func (w *Workspace) Init(app *kingpin.Application, data *forjfile.Workspace, isParsePhase func() bool, ...)

Types

type Context

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

func (*Context) Flag

func (s *Context) Flag(name string, flag *kingpin.FlagClause) (cliFlag *kingpinCli.FlagClause)

Create a cli flag from a kingpin flag (for forjj-modules/cli)

func (*Context) GetStringValue

func (s *Context) GetStringValue(field string) (value string, found, isDefault bool, _ error)

GetStringValue return value and status where the value were found.

WARNING: Default status can be set only in cli load context phase (before parse) If we need to incorporate some data feed between real value and default value it must be done and saved during load context phase. (ie ParseContext() in cli_context.go)

type Info

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

type Workspace

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

Workspace represents cli subcommand actions and options

func (*Workspace) Action

func (w *Workspace) Action(action string)

Action executed for workspace cli command

func (*Workspace) DefineContext

func (w *Workspace) DefineContext(context clier.ParseContexter)

DefineContext define cli Context to permit ParseContext to retrieve common variable set.

func (*Workspace) GetStringValue

func (w *Workspace) GetStringValue(field string) (value string, found, isDefault bool, _ error)

GetStringValue Return a field value from the given context (parse time, or after)

func (*Workspace) Init

func (w *Workspace) Init(app *kingpin.Application, data *forjfile.Workspace, isParsePhase func() bool, initCommon func(context *Context, cmd *kingpin.CmdClause))

Init configure the workspace cli command