sleepycat

README

sleepycat

sleepycat is a Go package for reading user input from the terminal.

The package provides typed input functions and a consistent option-based API for prompts, validation, and retry behavior.

Status: Work in progress. The API is not yet stable.

Installation

go get github.com/Rajdeep-Nemo/sleepycat

Example

package main

import (
	"fmt"
	"os"

	"github.com/Rajdeep-Nemo/sleepycat"
)

func main() {
	age, err := sleepycat.Int(
		sleepycat.Prompt("Enter age: "),
		sleepycat.MaxAttempt(3),
	)
	if err != nil {
		fmt.Println(err)
		os.Exit(0)
	}

	fmt.Println(age)
}

Available

Input

• Int()
• Float32()
• Float64()
• Bool()
• String()
• Byte()
• Rune()

Options

• Prompt()
• MaxAttempt()

Project Structure

sleepycat/
├── .github/
│   └── workflows/
│       └── ci.yml              # Continuous integration
│
├── examples/                   # Example programs
│   ├── int/
│   │   └── main.go             
│   └── ...                     # More Examples
│
├── internal/
│   └── input.go                # Terminal input helpers
│
├── config.go                   # Config and functional options
├── parser.go                   # Shared parsing/retry logic
├── int.go                      # Integer input
├── float32.go                  # 32 bit float input
├── float64.go                  # 64 bit float input
├── ...                         # Other inputs
│
├── helpers_test.go             # Shared helper functions
├── int_test.go
├── float32_test.go
├── float64_test.go
├── ...                         # Other test cases
│
├── .gitignore
├── go.mod
├── go.sum
├── LICENSE
└── README.md

Documentation

Index

• func Bool(opts ...option) (bool, error)
• func Byte(opts ...option) (byte, error)
• func Float32(opts ...option) (float32, error)
• func Float64(opts ...option) (float64, error)
• func Int(opts ...option) (int, error)
• func MaxAttempt(count int) option
• func Prompt(inputPrompt string) option
• func Rune(opts ...option) (rune, error)
• func String(opts ...option) (string, error)

Functions

func Bool

func Bool(opts ...option) (bool, error)

Bool reads from the input source and returns a boolean value (true/false)

func Byte

func Byte(opts ...option) (byte, error)

Read from the input source and returns a `byte` value

func Float32

func Float32(opts ...option) (float32, error)

Float32 reads an floating point number from the input source and returns as `float32`

func Float64

func Float64(opts ...option) (float64, error)

Float64 reads an floating point number from the input source and returns as `float64`

func Int

func Int(opts ...option) (int, error)

Int reads an integer from the input source.

func MaxAttempt

func MaxAttempt(count int) option

MaxAttempts limits the number of invalid input attempts. A value of 0 retries indefinitely.

func Prompt

func Prompt(inputPrompt string) option

Prompt sets the text printed before waiting for input.

func Rune

func Rune(opts ...option) (rune, error)

Read from the input source and returns a unicode code point

func String

func String(opts ...option) (string, error)

String reads from the input source and returns a string literal MaxAttempt does not work as there is no invalid string