Add print commands

Bold, Success, Error

Author: jojomi

Gopkg.lock

@@ -17,6 +17,9 @@ type Context struct {
 	stdout     io.Writer
 	stderr     io.Writer
 	stdin      io.Reader
+
+	successChar string
+	errorChar   string
 }
 
 // NewContext returns a pointer to a new Context.
@@ -29,6 +32,9 @@ func NewContext() (context *Context) {
 	context.stderr = os.Stderr
 	context.stdin = os.Stdin
 
+	context.successChar = "✓"
+	context.errorChar = "✗"
+
 	cwd, err := os.Getwd()
 	if err == nil {
 		context.SetWorkingDir(cwd)

context.go

@@ -0,0 +1,33 @@
+package main
+
+import (
+	"fmt"
+
+	script "github.com/jojomi/go-script"
+)
+
+func main() {
+	// make sure panics are printed in a human friendly way
+	/// defer script.RecoverFunc()
+
+	sc := script.NewContext()
+
+	fmt.Println()
+	sc.PrintlnBold("trying", "A")
+
+	fmt.Print("Yes,", "indeed ")
+	sc.PrintSuccessCheck("\n")
+	sc.PrintSuccessCheck(" oh yes!\n")
+	sc.PrintlnSuccess("It worked")
+
+	fmt.Println()
+	sc.PrintlnBold("B too?")
+
+	fmt.Print("No,", "no ")
+	sc.PrintErrorCross("\n")
+	sc.PrintErrorCross(" oh no!\n")
+	sc.PrintlnError("It did not work")
+
+	fmt.Println()
+	fmt.Println("I'm done.", "Really.")
+}

examples/printing.go

@@ -0,0 +1,11 @@
+package script
+
+import "bytes"
+
+func setOutputBuffers(sc *Context) (out, err *bytes.Buffer) {
+	stdoutBuffer := bytes.NewBuffer(make([]byte, 0, 100))
+	sc.stdout = stdoutBuffer
+	stderrBuffer := bytes.NewBuffer(make([]byte, 0, 100))
+	sc.stderr = stderrBuffer
+	return stdoutBuffer, stderrBuffer
+}

helpers_test.go

@@ -0,0 +1,99 @@
+package script
+
+import (
+	"fmt"
+	"io"
+	"os"
+
+	"github.com/fatih/color"
+	"golang.org/x/crypto/ssh/terminal"
+)
+
+var colorBold = color.New(color.Bold)
+var printBold = colorBold.FprintFunc()
+var printlnBold = colorBold.FprintlnFunc()
+
+var colorSuccess = color.New(color.Bold, color.FgGreen)
+var printSuccess = colorSuccess.FprintFunc()
+var printlnSuccess = colorSuccess.FprintlnFunc()
+
+var colorError = color.New(color.Bold, color.FgRed)
+var printError = colorError.FprintFunc()
+var printlnError = colorError.FprintlnFunc()
+
+// PrintBold func
+func (c Context) PrintBold(input ...interface{}) {
+	c.terminalize(c.stdout, printBold, fmt.Fprint, input...)
+}
+
+// PrintlnBold func
+func (c Context) PrintlnBold(input ...interface{}) {
+	c.terminalize(c.stdout, printlnBold, fmt.Fprintln, input...)
+}
+
+// PrintBoldCheck func
+func (c Context) PrintBoldCheck(inputSuffix ...interface{}) {
+	input := make([]interface{}, len(inputSuffix)+1)
+	input[0] = c.successChar
+	for index, i := range inputSuffix {
+		input[index+1] = i
+	}
+	c.terminalize(c.stdout, printBold, fmt.Fprint, input...)
+}
+
+// PrintSuccess func
+func (c Context) PrintSuccess(input ...interface{}) {
+	c.terminalize(c.stdout, printSuccess, fmt.Fprint, input...)
+}
+
+// PrintlnSuccess func
+func (c Context) PrintlnSuccess(input ...interface{}) {
+	c.terminalize(c.stdout, printlnSuccess, fmt.Fprintln, input...)
+}
+
+// PrintSuccessCheck func
+func (c Context) PrintSuccessCheck(inputSuffix ...interface{}) {
+	input := make([]interface{}, len(inputSuffix)+1)
+	input[0] = c.successChar
+	for index, i := range inputSuffix {
+		input[index+1] = i
+	}
+	c.terminalize(c.stdout, printSuccess, fmt.Fprint, input...)
+}
+
+// PrintError func
+func (c Context) PrintError(input ...interface{}) {
+	c.terminalize(c.stdout, printError, fmt.Fprint, input...)
+}
+
+// PrintlnError func
+func (c Context) PrintlnError(input ...interface{}) {
+	c.terminalize(c.stdout, printlnError, fmt.Fprintln, input...)
+}
+
+// PrintErrorCross func
+func (c Context) PrintErrorCross(inputSuffix ...interface{}) {
+	input := make([]interface{}, len(inputSuffix)+1)
+	input[0] = c.errorChar
+	for index, i := range inputSuffix {
+		input[index+1] = i
+	}
+	c.terminalize(c.stdout, printError, fmt.Fprint, input...)
+}
+
+// IsTerminal returns if this program is run inside an interactive terminal
+func (c Context) IsTerminal() bool {
+	return terminal.IsTerminal(int(os.Stdout.Fd()))
+}
+
+func (c Context) terminalize(w io.Writer, candy func(w io.Writer, input ...interface{}), basic func(w io.Writer, input ...interface{}) (int, error), input ...interface{}) {
+	c.output(w, c.IsTerminal(), candy, basic, input...)
+}
+
+func (c Context) output(w io.Writer, isTerminal bool, candy func(w io.Writer, input ...interface{}), basic func(w io.Writer, input ...interface{}) (int, error), input ...interface{}) {
+	if !isTerminal {
+		basic(w, input...)
+		return
+	}
+	candy(w, input...)
+}

print.go

@@ -0,0 +1,16 @@
+package script
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestPrintBold(t *testing.T) {
+	sc := NewContext()
+	stdout, stderr := setOutputBuffers(sc)
+
+	sc.PrintlnBold("in", "put")
+	assert.Equal(t, "in put\n", stdout.String())
+	assert.Equal(t, "", stderr.String())
+}

print_test.go

@@ -1,7 +1,6 @@
 package script
 
 import (
-	"bytes"
 	"strings"
 	"testing"
 
@@ -222,11 +221,3 @@ func processContext() *Context {
 	sc.SetWorkingDir("./test/bin")
 	return sc
 }
-
-func setOutputBuffers(sc *Context) (out, err *bytes.Buffer) {
-	stdoutBuffer := bytes.NewBuffer(make([]byte, 0, 100))
-	sc.stdout = stdoutBuffer
-	stderrBuffer := bytes.NewBuffer(make([]byte, 0, 100))
-	sc.stderr = stderrBuffer
-	return stdoutBuffer, stderrBuffer
-}