core

package

v2.0.8-0...-fc4e006 Latest Latest Go to latest Published: Mar 31, 2020 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ansuricat/survey

Documentation ¶

Index ¶

Variables
func IsFieldNotMatch(err error) (string, bool)
func RunTemplate(tmpl string, data interface{}) (string, error)
func WriteAnswer(t interface{}, name string, v interface{}) (err error)
type OptionAnswer
- func OptionAnswerList(incoming []string) []OptionAnswer
type Settable
Bugs

Constants ¶

This section is empty.

Variables ¶

View Source

var DisableColor = false

DisableColor can be used to make testing reliable

View Source

var TemplateFuncs = map[string]interface{}{

	"color": func(color string) string {
		if DisableColor {
			return ""
		}
		return ansi.ColorCode(color)
	},
}

Functions ¶

func IsFieldNotMatch ¶

func IsFieldNotMatch(err error) (string, bool)

IsFieldNotMatch reports whether an "err" is caused by a non matching field. It returns the Question.Name that couldn't be matched with a destination field.

Usage: err := survey.Ask(qs, &v);

if err != nil {
	if name, ok := core.IsFieldNotMatch(err); ok {
		[...name is the not matched question name]
	}
}

func RunTemplate ¶

func RunTemplate(tmpl string, data interface{}) (string, error)

func WriteAnswer ¶

func WriteAnswer(t interface{}, name string, v interface{}) (err error)

Types ¶

type OptionAnswer ¶

type OptionAnswer struct {
	Value string
	Index int
}

OptionAnswer is the return type of Selects/MultiSelects that lets the appropriate information get copied to the user's struct

func OptionAnswerList ¶

func OptionAnswerList(incoming []string) []OptionAnswer

type Settable ¶

type Settable interface {
	WriteAnswer(field string, value interface{}) error
}

Settable allow for configuration when assigning answers

Notes ¶

Bugs ¶

the current implementation might cause weird conflicts if there are two fields with same name that only differ by casing.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL