flags

Documentation

Index

• func IsSet(short, long string, args []string) bool
• func LoadFlagsWithDefaults(options KilnfileOptions, args []string, statOverride StatFunc) ([]string, error)
• type KilnfileOptions
• type Standard
  • func (options Standard) KilnfileLockPath() string
  • func (options Standard) KilnfilePathPrefix() string
  • func (options *Standard) LoadKilnfiles(fsOverride billy.Basic, variablesServiceOverride VariablesService) (_ cargo.Kilnfile, _ cargo.KilnfileLock, err error)
  • func (options *Standard) SaveKilnfileLock(fsOverride billy.Basic, kilnfileLock cargo.KilnfileLock) error
• type StatFunc
• type VariablesService

Functions

func IsSet

func IsSet(short, long string, args []string) bool

IsSet can be used to check if a flag is set in a set of arguments. Both "long" and "short" flag names must be passed.

func LoadFlagsWithDefaults

func LoadFlagsWithDefaults(options KilnfileOptions, args []string, statOverride StatFunc) ([]string, error)

LoadFlagsWithDefaults only sets default values if the flag is not set this permits explicitly setting "zero values" for in arguments without them being overwritten.

Types

type KilnfileOptions

type KilnfileOptions interface {
	KilnfilePathPrefix() string
}

type Standard

type Standard struct {
	Kilnfile      string   `short:"kf"  long:"kilnfile"                   default:"Kilnfile"         description:"path to Kilnfile"`
	VariableFiles []string `` /* 137-byte string literal not displayed */
	Variables     []string `` /* 130-byte string literal not displayed */
}

func (Standard) KilnfileLockPath

func (options Standard) KilnfileLockPath() string

func (Standard) KilnfilePathPrefix

func (options Standard) KilnfilePathPrefix() string

func (*Standard) LoadKilnfiles

func (options *Standard) LoadKilnfiles(fsOverride billy.Basic, variablesServiceOverride VariablesService) (_ cargo.Kilnfile, _ cargo.KilnfileLock, err error)

LoadKilnfiles parses and interpolates the Kilnfile and parsed the Kilnfile.lock. The function parameters are for overriding default services. These parameters are helpful for testing, in most cases nil can be passed for both.

func (*Standard) SaveKilnfileLock

func (options *Standard) SaveKilnfileLock(fsOverride billy.Basic, kilnfileLock cargo.KilnfileLock) error

type StatFunc

type StatFunc func(string) (os.FileInfo, error)

type VariablesService

type VariablesService interface {
	FromPathsAndPairs(paths []string, pairs []string) (templateVariables map[string]interface{}, err error)
}