tcnksm/go-input

Go package for ideal tty prompt

go-input

go-input is a Go package for reading user input in console.

Here is the some good points compared with other/similar packages. It can handle SIGINT (Ctrl+C) while reading input and returns error. It allows to change IO interface as io.Writer and io.Reader so it's easy to test of your go program with this package (This package is also well-tested!). It also supports raw mode input (reading input without prompting) for multiple platform (Darwin, Linux and Windows). Not only this it allows to prompt complex input via Option struct.

The documentation is on GoDoc.

Install

Use go get to install this package:

$ go get github.com/tcnksm/go-input

Usage

The following is the simple example,

ui := &input.UI{
    Writer: os.Stdout,
    Reader: os.Stdin,
}

query := "What is your name?"
name, err := ui.Ask(query, &input.Options{
    Default: "tcnksm",
    Required: true,
    Loop:     true,
})

You can check other examples in here.

Contribution

1. Fork (https://github.com/tcnksm/go-input/fork)
2. Create a feature branch
3. Commit your changes
4. Rebase your local changes against the master branch
5. Run test suite with the go test ./... command and confirm that it passes
6. Run gofmt -s
7. Create new Pull Request

Author

Taichi Nakashima

go-input's Issues

Custom template for default value

It would be nice to be able to customize the appearance of the default values.

eg

Enter a value [myDefault]:

LineSep trim is not working for windows

go-input/read.go

Line 49 in bbe13e9

resultStr = strings.TrimSuffix(line, LineSep)

When entering an input on Windows, my inputs are always returned with a \r at the end. I will investigate more to see if I can identify why. It doesn't seem to really break functionality, I am just forced to do my own sanitization after getting the input text back.

Option for the text "Enter a value"

It would be handy to be able to provide different text for the Ask function.

It is possible to control if the default value is shown but being able to control the prompt would be very handy

release/version needed for vendor management

using semver would be ideal

deleting input when masked creates more asterisks

as in if i type in 1 character, *, then press my delete button, then the output would be **

nil in place of empty Options struct?

Should we support passing nil instead of an empty Options struct?

for example, we have something like:

ui := input.DefaultUI()
// key, err := ui.Select("Which key?", []string{"1", "2", "3"}, &input.Options{})
key, err := ui.Select("Which key?", []string{"1", "2", "3"}, nil)

passing nil doesn't seem to work right now. Is it something we want to support?