2020-10-03 04:54:09 +02:00
|
|
|
package survey
|
|
|
|
|
2020-11-09 16:25:54 +01:00
|
|
|
import (
|
2021-08-30 17:18:50 +02:00
|
|
|
"errors"
|
|
|
|
|
2020-11-09 16:25:54 +01:00
|
|
|
"github.com/AlecAivazis/survey/v2/core"
|
|
|
|
"github.com/AlecAivazis/survey/v2/terminal"
|
|
|
|
)
|
|
|
|
|
2020-10-03 04:54:09 +02:00
|
|
|
/*
|
|
|
|
Input is a regular text input that prints each character the user types on the screen
|
|
|
|
and accepts the input with the enter key. Response type is a string.
|
|
|
|
|
|
|
|
name := ""
|
|
|
|
prompt := &survey.Input{ Message: "What is your name?" }
|
|
|
|
survey.AskOne(prompt, &name)
|
|
|
|
*/
|
|
|
|
type Input struct {
|
|
|
|
Renderer
|
2020-11-09 16:25:54 +01:00
|
|
|
Message string
|
|
|
|
Default string
|
|
|
|
Help string
|
|
|
|
Suggest func(toComplete string) []string
|
|
|
|
answer string
|
2021-08-30 17:18:50 +02:00
|
|
|
typedAnswer string
|
2020-11-09 16:25:54 +01:00
|
|
|
options []core.OptionAnswer
|
|
|
|
selectedIndex int
|
|
|
|
showingHelp bool
|
2020-10-03 04:54:09 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
// data available to the templates when processing
|
|
|
|
type InputTemplateData struct {
|
|
|
|
Input
|
2020-11-09 16:25:54 +01:00
|
|
|
ShowAnswer bool
|
|
|
|
ShowHelp bool
|
|
|
|
Answer string
|
|
|
|
PageEntries []core.OptionAnswer
|
|
|
|
SelectedIndex int
|
|
|
|
Config *PromptConfig
|
2020-10-03 04:54:09 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
// Templates with Color formatting. See Documentation: https://github.com/mgutz/ansi#style-format
|
|
|
|
var InputQuestionTemplate = `
|
|
|
|
{{- if .ShowHelp }}{{- color .Config.Icons.Help.Format }}{{ .Config.Icons.Help.Text }} {{ .Help }}{{color "reset"}}{{"\n"}}{{end}}
|
|
|
|
{{- color .Config.Icons.Question.Format }}{{ .Config.Icons.Question.Text }} {{color "reset"}}
|
|
|
|
{{- color "default+hb"}}{{ .Message }} {{color "reset"}}
|
|
|
|
{{- if .ShowAnswer}}
|
|
|
|
{{- color "cyan"}}{{.Answer}}{{color "reset"}}{{"\n"}}
|
2020-11-09 16:25:54 +01:00
|
|
|
{{- else if .PageEntries -}}
|
|
|
|
{{- .Answer}} [Use arrows to move, enter to select, type to continue]
|
|
|
|
{{- "\n"}}
|
|
|
|
{{- range $ix, $choice := .PageEntries}}
|
|
|
|
{{- if eq $ix $.SelectedIndex }}{{color $.Config.Icons.SelectFocus.Format }}{{ $.Config.Icons.SelectFocus.Text }} {{else}}{{color "default"}} {{end}}
|
|
|
|
{{- $choice.Value}}
|
|
|
|
{{- color "reset"}}{{"\n"}}
|
|
|
|
{{- end}}
|
2020-10-03 04:54:09 +02:00
|
|
|
{{- else }}
|
2020-11-09 16:25:54 +01:00
|
|
|
{{- if or (and .Help (not .ShowHelp)) .Suggest }}{{color "cyan"}}[
|
|
|
|
{{- if and .Help (not .ShowHelp)}}{{ print .Config.HelpInput }} for help {{- if and .Suggest}}, {{end}}{{end -}}
|
|
|
|
{{- if and .Suggest }}{{color "cyan"}}{{ print .Config.SuggestInput }} for suggestions{{end -}}
|
|
|
|
]{{color "reset"}} {{end}}
|
2020-10-03 04:54:09 +02:00
|
|
|
{{- if .Default}}{{color "white"}}({{.Default}}) {{color "reset"}}{{end}}
|
|
|
|
{{- end}}`
|
|
|
|
|
2021-08-30 17:18:50 +02:00
|
|
|
func (i *Input) onRune(config *PromptConfig) terminal.OnRuneFn {
|
|
|
|
return terminal.OnRuneFn(func(key rune, line []rune) ([]rune, bool, error) {
|
|
|
|
if i.options != nil && (key == terminal.KeyEnter || key == '\n') {
|
|
|
|
return []rune(i.answer), true, nil
|
|
|
|
} else if i.options != nil && key == terminal.KeyEscape {
|
2020-11-09 16:25:54 +01:00
|
|
|
i.answer = i.typedAnswer
|
2021-08-30 17:18:50 +02:00
|
|
|
i.options = nil
|
|
|
|
} else if key == terminal.KeyArrowUp && len(i.options) > 0 {
|
|
|
|
if i.selectedIndex == 0 {
|
|
|
|
i.selectedIndex = len(i.options) - 1
|
|
|
|
} else {
|
|
|
|
i.selectedIndex--
|
|
|
|
}
|
|
|
|
i.answer = i.options[i.selectedIndex].Value
|
|
|
|
} else if (key == terminal.KeyArrowDown || key == terminal.KeyTab) && len(i.options) > 0 {
|
|
|
|
if i.selectedIndex == len(i.options)-1 {
|
|
|
|
i.selectedIndex = 0
|
|
|
|
} else {
|
|
|
|
i.selectedIndex++
|
|
|
|
}
|
|
|
|
i.answer = i.options[i.selectedIndex].Value
|
|
|
|
} else if key == terminal.KeyTab && i.Suggest != nil {
|
|
|
|
i.answer = string(line)
|
|
|
|
i.typedAnswer = i.answer
|
|
|
|
options := i.Suggest(i.answer)
|
2020-11-09 16:25:54 +01:00
|
|
|
i.selectedIndex = 0
|
2021-08-30 17:18:50 +02:00
|
|
|
if len(options) == 0 {
|
|
|
|
return line, false, nil
|
|
|
|
}
|
|
|
|
|
2020-11-09 16:25:54 +01:00
|
|
|
i.answer = options[0]
|
|
|
|
if len(options) == 1 {
|
2021-08-30 17:18:50 +02:00
|
|
|
i.typedAnswer = i.answer
|
2020-11-09 16:25:54 +01:00
|
|
|
i.options = nil
|
|
|
|
} else {
|
|
|
|
i.options = core.OptionAnswerList(options)
|
|
|
|
}
|
2021-08-30 17:18:50 +02:00
|
|
|
} else {
|
|
|
|
if i.options == nil {
|
|
|
|
return line, false, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
if key >= terminal.KeySpace {
|
|
|
|
i.answer += string(key)
|
|
|
|
}
|
|
|
|
i.typedAnswer = i.answer
|
|
|
|
|
|
|
|
i.options = nil
|
2020-11-09 16:25:54 +01:00
|
|
|
}
|
|
|
|
|
2021-08-30 17:18:50 +02:00
|
|
|
pageSize := config.PageSize
|
|
|
|
opts, idx := paginate(pageSize, i.options, i.selectedIndex)
|
|
|
|
err := i.Render(
|
|
|
|
InputQuestionTemplate,
|
|
|
|
InputTemplateData{
|
|
|
|
Input: *i,
|
|
|
|
Answer: i.answer,
|
|
|
|
ShowHelp: i.showingHelp,
|
|
|
|
SelectedIndex: idx,
|
|
|
|
PageEntries: opts,
|
|
|
|
Config: config,
|
|
|
|
},
|
|
|
|
)
|
|
|
|
|
|
|
|
if err == nil {
|
|
|
|
err = readLineAgain
|
|
|
|
}
|
2020-11-09 16:25:54 +01:00
|
|
|
|
2021-08-30 17:18:50 +02:00
|
|
|
return []rune(i.typedAnswer), true, err
|
|
|
|
})
|
2020-11-09 16:25:54 +01:00
|
|
|
}
|
|
|
|
|
2021-08-30 17:18:50 +02:00
|
|
|
var readLineAgain = errors.New("read line again")
|
|
|
|
|
2020-10-03 04:54:09 +02:00
|
|
|
func (i *Input) Prompt(config *PromptConfig) (interface{}, error) {
|
|
|
|
// render the template
|
|
|
|
err := i.Render(
|
|
|
|
InputQuestionTemplate,
|
|
|
|
InputTemplateData{
|
2021-08-30 17:18:50 +02:00
|
|
|
Input: *i,
|
|
|
|
Config: config,
|
|
|
|
ShowHelp: i.showingHelp,
|
2020-10-03 04:54:09 +02:00
|
|
|
},
|
|
|
|
)
|
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
|
|
|
|
// start reading runes from the standard in
|
|
|
|
rr := i.NewRuneReader()
|
|
|
|
rr.SetTermMode()
|
|
|
|
defer rr.RestoreTermMode()
|
|
|
|
|
|
|
|
cursor := i.NewCursor()
|
2021-08-30 17:18:50 +02:00
|
|
|
if !config.ShowCursor {
|
|
|
|
cursor.Hide() // hide the cursor
|
|
|
|
defer cursor.Show() // show the cursor when we're done
|
|
|
|
}
|
|
|
|
|
|
|
|
var line []rune
|
2020-10-03 04:54:09 +02:00
|
|
|
|
|
|
|
for {
|
2021-08-30 17:18:50 +02:00
|
|
|
if i.options != nil {
|
|
|
|
line = []rune{}
|
2020-11-09 16:25:54 +01:00
|
|
|
}
|
2021-08-30 17:18:50 +02:00
|
|
|
|
|
|
|
line, err = rr.ReadLineWithDefault(0, line, i.onRune(config))
|
|
|
|
if err == readLineAgain {
|
|
|
|
continue
|
2020-11-09 16:25:54 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
|
2021-08-30 17:18:50 +02:00
|
|
|
break
|
|
|
|
}
|
|
|
|
|
|
|
|
i.answer = string(line)
|
|
|
|
// readline print an empty line, go up before we render the follow up
|
|
|
|
cursor.Up(1)
|
|
|
|
|
|
|
|
// if we ran into the help string
|
|
|
|
if i.answer == config.HelpInput && i.Help != "" {
|
|
|
|
// show the help and prompt again
|
|
|
|
i.showingHelp = true
|
|
|
|
return i.Prompt(config)
|
2020-10-03 04:54:09 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
// if the line is empty
|
2020-11-09 16:25:54 +01:00
|
|
|
if len(i.answer) == 0 {
|
2020-10-03 04:54:09 +02:00
|
|
|
// use the default value
|
|
|
|
return i.Default, err
|
|
|
|
}
|
|
|
|
|
2020-11-09 16:25:54 +01:00
|
|
|
lineStr := i.answer
|
2020-10-03 04:54:09 +02:00
|
|
|
|
|
|
|
i.AppendRenderedText(lineStr)
|
|
|
|
|
|
|
|
// we're done
|
|
|
|
return lineStr, err
|
|
|
|
}
|
|
|
|
|
|
|
|
func (i *Input) Cleanup(config *PromptConfig, val interface{}) error {
|
2020-12-21 18:11:08 +01:00
|
|
|
// use the default answer when cleaning up the prompt if necessary
|
|
|
|
ans := i.answer
|
|
|
|
if ans == "" && i.Default != "" {
|
|
|
|
ans = i.Default
|
|
|
|
}
|
|
|
|
|
|
|
|
// render the cleanup
|
2020-10-03 04:54:09 +02:00
|
|
|
return i.Render(
|
|
|
|
InputQuestionTemplate,
|
|
|
|
InputTemplateData{
|
|
|
|
Input: *i,
|
|
|
|
ShowAnswer: true,
|
|
|
|
Config: config,
|
2020-12-21 18:11:08 +01:00
|
|
|
Answer: ans,
|
2020-10-03 04:54:09 +02:00
|
|
|
},
|
|
|
|
)
|
|
|
|
}
|