confirmer

README

github.com/eculver/go-play/pkg/confirmer

A simple confirmation library for blocking on user confirmation prompts.

Installation

go get -u github.com/eculver/go-play/pkg/confirmer

Usage

The confirmer.Confirm method provides a default configuration to cover the most common use-case:

import (
    "os"
    "github.com/eculver/go-play/pkg/confirmer"
)

if !confirmer.Confirm("Continue?", os.Stdin) {
    // not confirmed
    os.Exit(1)
}
// confirmed

This will prompt the user up to three times until a valid "accept" or "deny" input is given. If after three times no valid inputs have been given, it will exit and return false:

evan.culver@evan ➜  go-play (confirmer) go run cmd/confirmer/main.go
Continue? [Y/n]: not valid

Continue? [Y/n]: really?

Continue? [Y/n]: yes

not confirmed!
exit status 1

evan.culver@evan ➜  go-play (confirmer) go run cmd/confirmer/main.go
Continue? [Y/n]: Y
confirmed!

evan.culver@evan ➜  go-play (confirmer) go run cmd/confirmer/main.go
Continue? [Y/n]: N
Continue? [Y/n]: n
not confirmed!
exit status 1

A complete working example can be found in ./cmd/confirmer/main.go of this repository.

Documentation

Index

• Variables
• func Confirm(msg string, reader io.Reader) bool
• type Confirmer
  • func New(accept []string, deny []string, tries int) Confirmer

Variables

var DefaultAccept = []string{"Y"}

var DefaultConfirmer = New(DefaultAccept, DefaultDeny, 3)

var DefaultDeny = []string{"n"}

Functions

func Confirm

func Confirm(msg string, reader io.Reader) bool

Types

type Confirmer

type Confirmer interface {
	Confirm(msg string, reader io.Reader) bool
}

Confirmer confirms user input

func New

func New(accept []string, deny []string, tries int) Confirmer

New returns a new Confirmer for reading acceptable or deniable input for the given number of tries before giving up.