cliquiz

package

v0.14.1-0...-8b31b97 Latest Latest Go to latest Published: Mar 13, 2021 License: Apache-2.0 Imports: 7 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/alexp404/starport

Documentation ¶

Overview ¶

Package cliquiz is a tool to collect answers from the users on cli.

Index ¶

func Ask(question ...Question) error
func ValuesFromFlagsOrAsk(fset *pflag.FlagSet, title string, flags ...Flag) (values map[string]string, err error)
type Flag
- func NewFlag(name string, isRequired bool) Flag
type Option
type Question
- func NewQuestion(question string, answer interface{}, options ...Option) Question

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Ask ¶

func Ask(question ...Question) error

Ask asks questions and collect answers.

func ValuesFromFlagsOrAsk ¶

func ValuesFromFlagsOrAsk(fset *pflag.FlagSet, title string, flags ...Flag) (values map[string]string, err error)

ValuesFromFlagsOrAsk returns values of flags within map[string]string where map's key is the name of the flag and value is flag's value. when provided, values are collected through command otherwise they're asked to user by prompting. title used as a message while prompting.

Types ¶

type Flag ¶

type Flag struct {
	Name       string
	IsRequired bool
}

Flag represents a cmd flag.

func NewFlag ¶

func NewFlag(name string, isRequired bool) Flag

NewFlag creates a new flag.

type Option ¶

type Option func(*Question)

Option configures Question.

func DefaultAnswer ¶

func DefaultAnswer(answer interface{}) Option

DefaultAnswer sets a default answer to Question.

func HideAnswer ¶

func HideAnswer() Option

HideAnswer hides the answer to prevent secret information being leaked.

func Required ¶

func Required() Option

Required marks the answer as required.

type Question ¶

type Question struct {
	// contains filtered or unexported fields
}

Question holds information on what to ask to user and where the answer stored at.

func NewQuestion ¶

func NewQuestion(question string, answer interface{}, options ...Option) Question

NewQuestion creates a new question.

Source Files ¶

View all Source files

question.go

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