provider

Documentation

Index

• Constants
• func NewInvalidParameterSpecError(reason string) error
• type Parameter
  • func NewParameter(content []byte) (*Parameter, error)
  • func (param *Parameter) CLIFlagName() string
  • func (param *Parameter) CreateCLIFlag() cli.Flag
  • func (param *Parameter) SetDefaultValue()
  • func (param *Parameter) SetValue(value interface{})
  • func (param *Parameter) Validate() error
  • func (param *Parameter) Value() interface{}
• type ParameterSet
  • func (ps ParameterSet) CreateCLIFlags() []cli.Flag
  • func (ps ParameterSet) InjectValues(str string) string
  • func (ps ParameterSet) Optional() ParameterSet
  • func (ps ParameterSet) Required() ParameterSet
  • func (ps ParameterSet) ResolveValues(ctx *cli.Context) error
  • func (ps ParameterSet) Validate() error
• type Provider

Constants

const (
	// BoolParamType is a bool parameter.
	BoolParamType = "bool"

	// IntParamType is an int parameter.
	IntParamType = "int"

	// NumberParamType is a number parameter.
	NumberParamType = "number"

	// StringParamType is a string parameter.
	StringParamType = "string"
)

Functions

func NewInvalidParameterSpecError

func NewInvalidParameterSpecError(reason string) error

NewInvalidParameterSpecError creates a new error indicating that a parameter spec is invalid.

Types

type Parameter

type Parameter struct {
	Name        string      `json:"name"                  yaml:"name"`
	Description string      `json:"description,omitempty" yaml:"description,omitempty"`
	Type        string      `json:"type"                  yaml:"type"`
	Required    bool        `json:"required"              yaml:"required"`
	Default     interface{} `json:"default,omitempty"     yaml:"default,omitempty"`
	AsFlag      string      `json:"as_flag,omitempty"     yaml:"as_flag,omitempty"`
	// contains filtered or unexported fields
}

A Parameter specifies a command parameter.

func NewParameter

func NewParameter(content []byte) (*Parameter, error)

NewParameter creates a new Parameter from the provided spec.

func (*Parameter) CLIFlagName

func (param *Parameter) CLIFlagName() string

CLIFlagName returns the parameter name formatted as a CLI flag name.

func (*Parameter) CreateCLIFlag

func (param *Parameter) CreateCLIFlag() cli.Flag

CreateCLIFlag creates a CLI flag for this parameter.

func (*Parameter) SetDefaultValue

func (param *Parameter) SetDefaultValue()

SetDefaultValue assigns the default value to the parameter.

func (*Parameter) SetValue

func (param *Parameter) SetValue(value interface{})

SetValue assigns a value to the parameter.

func (*Parameter) Validate

func (param *Parameter) Validate() error

Validate validates a Parameter.

func (*Parameter) Value

func (param *Parameter) Value() interface{}

Value returns the parameter's assigned value.

type ParameterSet

type ParameterSet []*Parameter

A ParameterSet is a slice of parameter pointers.

func (ParameterSet) CreateCLIFlags

func (ps ParameterSet) CreateCLIFlags() []cli.Flag

CreateCLIFlags creates a set of CLI flags for this parameter set.

func (ParameterSet) InjectValues

func (ps ParameterSet) InjectValues(str string) string

InjectValues replaces all param references with their corresponding values in the given string.

func (ParameterSet) Optional

func (ps ParameterSet) Optional() ParameterSet

Optional returns a subset of the ParameterSet containing only optional parameters.

func (ParameterSet) Required

func (ps ParameterSet) Required() ParameterSet

Required returns a subset of the ParameterSet containing only required parameters.

func (ParameterSet) ResolveValues

func (ps ParameterSet) ResolveValues(ctx *cli.Context) error

ResolveValues assigns values to the parameters from defaults and the CLI context.

func (ParameterSet) Validate

func (ps ParameterSet) Validate() error

Validate validates the parameter set, returning the first error it encounters, if any.

type Provider

type Provider interface {
	ArgsUsage() string
	CLIActionFn() cli.ActionFunc
	CLIFlags() []cli.Flag
	Type() string
	Validate() error
}

A Provider defines what happens when a command is invoked on the command line.