cliparamsatisfier

README

problem statement

lib for satisfying CLI params

features

• cross platform terminal support
• hiding secret param prompts
• API exposed via interface
• fake implementation to allow faking interactions

Documentation

Index

• type CLIParamSatisfier
  • func New(cliExiter cliexiter.CliExiter, cliOutput clioutput.CliOutput) CLIParamSatisfier
• type InputSourcer
  • func NewInputSourcer(sources ...inputsrc.InputSrc) InputSourcer
• type InputSrcFactory

Types

type CLIParamSatisfier

type CLIParamSatisfier interface {
	InputSrcFactory

	Satisfy(
		inputSourcer InputSourcer,
		inputs map[string]*model.Param,
	) map[string]*model.Value
}

CLIParamSatisfier attempts to satisfy the provided inputs via the provided inputSourcer

if all fails an error is logged and we exit with a nonzero code.

func New

func New(
	cliExiter cliexiter.CliExiter,
	cliOutput clioutput.CliOutput,
) CLIParamSatisfier

type InputSourcer

type InputSourcer interface {
	// contains filtered or unexported methods
}

func NewInputSourcer

func NewInputSourcer(
	sources ...inputsrc.InputSrc,
) InputSourcer

type InputSrcFactory

type InputSrcFactory interface {
	NewCliPromptInputSrc(
		inputs map[string]*model.Param,
	) inputsrc.InputSrc

	NewEnvVarInputSrc() inputsrc.InputSrc

	NewParamDefaultInputSrc(
		inputs map[string]*model.Param,
	) inputsrc.InputSrc

	NewSliceInputSrc(
		args []string,
		sep string,
	) inputsrc.InputSrc

	NewYMLFileInputSrc(
		filePath string,
	) (inputsrc.InputSrc, error)
}