go-getkeypushed

README

Go-GetKeyPushed

This package implements OnKeyPress() like functionality to the CLI app.

It simply returns the key pushed from the console/terminal (TTY) without the enter key. If the 1st arg is positive, then it will wait until its time exceeds and returns the 2nd arg as default. It is very much powered by the awesome go-tty.

$ # Run sample
$ go run ./example <enter>
Ready. Press any key ... (q = quit)
Key pressed => "a"
Key pressed => "b"
Key pressed => "A"
Key pressed => "B"
Key pressed => "あ"
Key pressed => "い"
Key pressed => "愛"
Key pressed => "\x1b"      // ESC key
Key pressed => "\x1b[A"    // Up arrow key
Key pressed => "\x1b[B"    // Down arrow key
Key pressed => "\x1b[C"    // Right arrow key
Key pressed => "\x1b[D"    // Left arrow key
Key pressed => "\x1b[19~"  // F8 key (if not assigned in the terminal)
Key pressed => "\x1b[20~"  // F9 key (if not assigned in the terminal)
Key pressed => "\x1b[21~"  // F10 key (if not assigned in the terminal)
Key pressed => "q"
Quit (q) detected. Exiting ...

$ # Interrupt with Ctrl+c
$ go run ./example <enter>
Ready. Press any key ... (q = quit)
Key pressed => "a"
Key pressed => "b"
Failed to get pressed key. Msg: user cancelled (ctrl+c, SIGINT detectd)
exit status 1

Usage

go get github.com/KEINOS/go-getkeypushed

// import "github.com/KEINOS/go-getkeypushed/key"

key := key.New() // instantiate
timeWait := 5 // Timeout user input in 5 secs
keyDefault := "my default" // Default value

fmt.Println("Press any key:")

inputUser, err := key.Get(timeWait, keyDefault)
if err != nil {
	fmt.Fprintf(os.Stderr, "Failed to get pressed key. Msg: %v\n", err)
	os.Exit(1)
}

fmt.Println("Input: "+ inputUser)

package main

import (
	"fmt"
	"os"
	"strings"

	"github.com/KEINOS/go-getkeypushed/key"
)

func main() {
	var (
		char       string
		err        error
		keyQuit    = "q"
		keyDefault = "?" // A char to use when wait time exceeds
		timeWait   = 5   // Seconds to wait user input
	)

	keyInput := key.New()

	fmt.Println("Ready. Press any key ... (q = quit)")

	for {
		char, err = keyInput.Get(keyDefault, timeWait)
		if err != nil {
			fmt.Fprintf(os.Stderr, "Failed to get pressed key. Msg: %v\n", err)
			os.Exit(1)
		}

		fmt.Printf("Key pressed => %#+v\n", char)

		if char == keyQuit {
			fmt.Printf("Quit (%s) detected. Exiting ...\n", keyQuit)

			break
		}

		if strings.TrimSpace(char) == "" {
			fmt.Println("Empty char(white space) detected.")

			break
		}
	}
}

Notes

• Suitable for just getting keypress such as y, n.
• It is a wrapper of amazing package "github.com/mattn/go-tty" to simplify its usage for my other projects.
  • github.com/mattn/go-tty @ GitHub

License & Copyright

• MIT
  • KEINOS and the contributors
  • go-tty & go-isatty: Yasuhiro Matsumoto (a.k.a mattn) @ GitHub
  • testify: Stretchr @ GitHub
  • See the packages in go.mod as well

TODO

• Find out how to test the tty input
• Implement basic testing
  • Cover test as much as possible
• Wating time implementaion
  • Wait Nth seconds and return default key if wait time exceed with no user interaction)