inputs

Documentation

Index

• func CollectUserInputs(collector inputsCollector) error
• func ParseCLIArgsInputs(collector inputsCollector, args []string) error
• type InputSpec
• type PromptResponse
• type Prompter
  • func FromSpec(specs []InputSpec) []Prompter
  • func NewPrompt(spec InputSpec) Prompter

Functions

func CollectUserInputs

func CollectUserInputs(collector inputsCollector) error

func ParseCLIArgsInputs

func ParseCLIArgsInputs(collector inputsCollector, args []string) error

Parse CLI args that were passed to the templating system. Argse are parsed and those that have values are stored in the inputsCollector.

Types

type InputSpec

type InputSpec struct {
	ID      string   `yaml:"id"`
	Text    string   `yaml:"text"`
	Type    string   `yaml:"type"`
	Options []string `yaml:"options,omitempty"`
}

type PromptResponse

type PromptResponse struct {
	InputSpec
	// Answer string
	Answer string
	// Has this been answered already?
	Answered bool
}

type Prompter

type Prompter interface {
	GetID() string
	Prompt() (PromptResponse, error)
	SetStringResponse(string) (PromptResponse, error)
}

Prompter is a user-input prompter capabale of storing user inputs as well as prompting for interactive user input

func FromSpec

func FromSpec(specs []InputSpec) []Prompter

func NewPrompt

func NewPrompt(spec InputSpec) Prompter

Create a new prompt based on spec.Type