Use colors for some output messages

Taskfile.yml

@@ -1,4 +1,4 @@
-version: '2'
+version: '3'
 
 includes:
   docs: ./docs

cmd/task/task.go

@@ -9,6 +9,7 @@ import (
 
 	"github.com/go-task/task/v2"
 	"github.com/go-task/task/v2/internal/args"
+	"github.com/go-task/task/v2/internal/logger"
 
 	"github.com/spf13/pflag"
 )
@@ -59,6 +60,7 @@ func main() {
 		summary     bool
 		dir         string
 		output      string
+		color       bool
 	)
 
 	pflag.BoolVar(&versionFlag, "version", false, "show Task version")
@@ -73,6 +75,7 @@ func main() {
 	pflag.BoolVar(&summary, "summary", false, "show summary about a task")
 	pflag.StringVarP(&dir, "dir", "d", "", "sets directory of execution")
 	pflag.StringVarP(&output, "output", "o", "", "sets output style: [interleaved|group|prefixed]")
+	pflag.BoolVarP(&color, "color", "c", true, "colored output")
 	pflag.Parse()
 
 	if versionFlag {
@@ -99,6 +102,7 @@ func main() {
 		Dir:     dir,
 		Dry:     dry,
 		Summary: summary,
+		Color:   color,
 
 		Stdin:  os.Stdin,
 		Stdout: os.Stdout,
@@ -117,7 +121,7 @@ func main() {
 
 	arguments := pflag.Args()
 	if len(arguments) == 0 {
-		log.Println("task: No argument given, trying default task")
+		e.Logger.Errf(logger.Yellow, "task: No argument given, trying default task")
 		arguments = []string{"default"}
 	}
 
@@ -139,7 +143,8 @@ func main() {
 	}
 
 	if err := e.Run(ctx, calls...); err != nil {
-		log.Fatal(err)
+		e.Logger.Errf(logger.Red, "%v", err)
+		os.Exit(1)
 	}
 }
 

docs/Taskfile.yml

@@ -1,4 +1,4 @@
-version: '2'
+version: '3'
 
 tasks:
   install:

go.mod

@@ -1,8 +1,10 @@
 module github.com/go-task/task/v2
 
 require (
+	github.com/fatih/color v1.7.0
 	github.com/go-task/slim-sprig v0.0.0-20190623010546-24867827a98b
 	github.com/kr/pretty v0.1.0 // indirect
+	github.com/mattn/go-colorable v0.1.2 // indirect
 	github.com/mattn/go-zglob v0.0.1
 	github.com/mitchellh/go-homedir v1.0.0
 	github.com/radovskyb/watcher v1.0.5
@@ -11,7 +13,6 @@ require (
 	golang.org/x/crypto v0.0.0-20180830192347-182538f80094 // indirect
 	golang.org/x/net v0.0.0-20180826012351-8a410e7b638d // indirect
 	golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f
-	golang.org/x/sys v0.0.0-20180831094639-fa5fdf94c789 // indirect
 	gopkg.in/yaml.v2 v2.2.1
 	mvdan.cc/sh v2.6.4+incompatible
 )

go.sum

@@ -1,13 +1,19 @@
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/fatih/color v1.7.0 h1:DkWD4oS2D8LGGgTQ6IvwJJXSL5Vp2ffcQg58nFV38Ys=
+github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
 github.com/go-task/slim-sprig v0.0.0-20190623010546-24867827a98b h1:z6iCP1USASmEZtKTzynd/rP4vOtBLlsD3v24wItbJIs=
 github.com/go-task/slim-sprig v0.0.0-20190623010546-24867827a98b/go.mod h1:XLIiFDBy2M8pA/fEL5rx9xr2EAzrDEO0S5brm5iekOE=
 github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
+github.com/mattn/go-colorable v0.1.2 h1:/bC9yWikZXAL9uJdulbSfyVNIR3n3trXl+v8+1sx8mU=
+github.com/mattn/go-colorable v0.1.2/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
+github.com/mattn/go-isatty v0.0.8 h1:HLtExJ+uU2HOZ+wI0Tt5DtUDrx8yhUqDcp7fYERX4CE=
+github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
 github.com/mattn/go-zglob v0.0.1 h1:xsEx/XUoVlI6yXjqBK062zYhRTZltCNmYPx6v+8DNaY=
 github.com/mattn/go-zglob v0.0.1/go.mod h1:9fxibJccNxU2cnpIKLRRFA7zX7qhkJIQWBb449FYHOo=
 github.com/mitchellh/go-homedir v1.0.0 h1:vKb8ShqSby24Yrqr/yDYkuFz8d0WUjys40rvnGC8aR0=
@@ -28,8 +34,8 @@ golang.org/x/net v0.0.0-20180826012351-8a410e7b638d h1:g9qWBGx4puODJTMVyoPrpoxPF
 golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f h1:wMNYb4v58l5UBM7MYRLPG6ZhfOqbKu7X5eyFl8ZhKvA=
 golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sys v0.0.0-20180831094639-fa5fdf94c789 h1:T8D7l6WB3tLu+VpKvw06ieD/OhBi1XpJmG1U/FtttZg=
-golang.org/x/sys v0.0.0-20180831094639-fa5fdf94c789/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223 h1:DH4skfRX4EBpamg7iV4ZlCpblAHI6s6TDM39bFZumv8=
+golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v2 v2.2.1 h1:mUhvW9EsL+naU5Q3cakzfE91YhliOondGd6ZrsDBHQE=

help.go

@@ -5,17 +5,18 @@ import (
 	"sort"
 	"text/tabwriter"
 
+	"github.com/go-task/task/v2/internal/logger"
 	"github.com/go-task/task/v2/internal/taskfile"
 )
 
 // PrintTasksHelp prints help os tasks that have a description
 func (e *Executor) PrintTasksHelp() {
 	tasks := e.tasksWithDesc()
 	if len(tasks) == 0 {
-		e.Logger.Outf("task: No tasks with description available")
+		e.Logger.Outf(logger.Yellow, "task: No tasks with description available")
 		return
 	}
-	e.Logger.Outf("task: Available tasks for this project:")
+	e.Logger.Outf(logger.Default, "task: Available tasks for this project:")
 
 	// Format in tab-separated columns with a tab stop of 8.
 	w := tabwriter.NewWriter(e.Stdout, 0, 8, 0, '\t', 0)

internal/compiler/v1/compiler_v1.go

@@ -131,7 +131,7 @@ func (c *CompilerV1) HandleDynamicVar(v taskfile.Var) (string, error) {
 	result := strings.TrimSuffix(stdout.String(), "\n")
 
 	c.dynamicCache[v.Sh] = result
-	c.Logger.VerboseErrf(`task: dynamic variable: '%s' result: '%s'`, v.Sh, result)
+	c.Logger.VerboseErrf(logger.Magenta, `task: dynamic variable: '%s' result: '%s'`, v.Sh, result)
 
 	return result, nil
 }

internal/compiler/v2/compiler_v2.go

@@ -103,7 +103,7 @@ func (c *CompilerV2) HandleDynamicVar(v taskfile.Var) (string, error) {
 	result := strings.TrimSuffix(stdout.String(), "\n")
 
 	c.dynamicCache[v.Sh] = result
-	c.Logger.VerboseErrf(`task: dynamic variable: '%s' result: '%s'`, v.Sh, result)
+	c.Logger.VerboseErrf(logger.Magenta, `task: dynamic variable: '%s' result: '%s'`, v.Sh, result)
 
 	return result, nil
 }

internal/logger/logger.go

@@ -1,38 +1,65 @@
 package logger
 
 import (
-	"fmt"
 	"io"
+
+	"github.com/fatih/color"
+)
+
+type PrintFunc func(io.Writer, string, ...interface{})
+
+var (
+	Default PrintFunc = color.New(color.Reset).FprintfFunc()
+	Bold    PrintFunc = color.New(color.Bold).FprintfFunc()
+	Blue    PrintFunc = color.New(color.FgBlue, color.Bold).FprintfFunc()
+	Green   PrintFunc = color.New(color.FgGreen, color.Bold).FprintfFunc()
+	Cyan    PrintFunc = color.New(color.FgCyan, color.Bold).FprintfFunc()
+	Yellow  PrintFunc = color.New(color.FgYellow, color.Bold).FprintfFunc()
+	Magenta PrintFunc = color.New(color.FgMagenta, color.Bold).FprintfFunc()
+	Red     PrintFunc = color.New(color.FgRed, color.Bold).FprintfFunc()
 )
 
+// Logger is just a wrapper that prints stuff to STDOUT or STDERR,
+// with optional color.
 type Logger struct {
 	Stdout  io.Writer
 	Stderr  io.Writer
 	Verbose bool
+	Color   bool
 }
 
-func (l *Logger) Outf(s string, args ...interface{}) {
+// Outf prints stuff to STDOUT.
+func (l *Logger) Outf(print PrintFunc, s string, args ...interface{}) {
 	if len(args) == 0 {
 		s, args = "%s", []interface{}{s}
 	}
-	fmt.Fprintf(l.Stdout, s+"\n", args...)
+	if !l.Color {
+		print = Default
+	}
+	print(l.Stdout, s+"\n", args...)
 }
 
-func (l *Logger) VerboseOutf(s string, args ...interface{}) {
+// VerboseOutf prints stuff to STDOUT if verbose mode is enabled.
+func (l *Logger) VerboseOutf(print PrintFunc, s string, args ...interface{}) {
 	if l.Verbose {
-		l.Outf(s, args...)
+		l.Outf(print, s, args...)
 	}
 }
 
-func (l *Logger) Errf(s string, args ...interface{}) {
+// Errf prints stuff to STDERR.
+func (l *Logger) Errf(print PrintFunc, s string, args ...interface{}) {
 	if len(args) == 0 {
 		s, args = "%s", []interface{}{s}
 	}
-	fmt.Fprintf(l.Stderr, s+"\n", args...)
+	if !l.Color {
+		print = Default
+	}
+	print(l.Stderr, s+"\n", args...)
 }
 
-func (l *Logger) VerboseErrf(s string, args ...interface{}) {
+// VerboseErrf prints stuff to STDERR if verbose mode is enabled.
+func (l *Logger) VerboseErrf(print PrintFunc, s string, args ...interface{}) {
 	if l.Verbose {
-		l.Errf(s, args...)
+		l.Errf(print, s, args...)
 	}
 }

internal/summary/summary.go

@@ -20,8 +20,8 @@ func printSpaceBetweenSummaries(l *logger.Logger, i int) {
 		return
 	}
 
-	l.Outf("")
-	l.Outf("")
+	l.Outf(logger.Default, "")
+	l.Outf(logger.Default, "")
 }
 
 func PrintTask(l *logger.Logger, t *taskfile.Task) {
@@ -50,38 +50,38 @@ func printTaskSummary(l *logger.Logger, t *taskfile.Task) {
 	for i, line := range lines {
 		notLastLine := i+1 < len(lines)
 		if notLastLine || line != "" {
-			l.Outf(line)
+			l.Outf(logger.Default, line)
 		}
 	}
 }
 
 func printTaskName(l *logger.Logger, t *taskfile.Task) {
-	l.Outf("task: %s", t.Task)
-	l.Outf("")
+	l.Outf(logger.Default, "task: %s", t.Task)
+	l.Outf(logger.Default, "")
 }
 
 func hasDescription(t *taskfile.Task) bool {
 	return t.Desc != ""
 }
 
 func printTaskDescription(l *logger.Logger, t *taskfile.Task) {
-	l.Outf(t.Desc)
+	l.Outf(logger.Default, t.Desc)
 }
 
 func printNoDescriptionOrSummary(l *logger.Logger) {
-	l.Outf("(task does not have description or summary)")
+	l.Outf(logger.Default, "(task does not have description or summary)")
 }
 
 func printTaskDependencies(l *logger.Logger, t *taskfile.Task) {
 	if len(t.Deps) == 0 {
 		return
 	}
 
-	l.Outf("")
-	l.Outf("dependencies:")
+	l.Outf(logger.Default, "")
+	l.Outf(logger.Default, "dependencies:")
 
 	for _, d := range t.Deps {
-		l.Outf(" - %s", d.Task)
+		l.Outf(logger.Default, " - %s", d.Task)
 	}
 }
 
@@ -90,14 +90,14 @@ func printTaskCommands(l *logger.Logger, t *taskfile.Task) {
 		return
 	}
 
-	l.Outf("")
-	l.Outf("commands:")
+	l.Outf(logger.Default, "")
+	l.Outf(logger.Default, "commands:")
 	for _, c := range t.Cmds {
 		isCommand := c.Cmd != ""
 		if isCommand {
-			l.Outf(" - %s", c.Cmd)
+			l.Outf(logger.Default, " - %s", c.Cmd)
 		} else {
-			l.Outf(" - Task: %s", c.Task)
+			l.Outf(logger.Default, " - Task: %s", c.Task)
 		}
 	}
 }

precondition.go

@@ -5,6 +5,7 @@ import (
 	"errors"
 
 	"github.com/go-task/task/v2/internal/execext"
+	"github.com/go-task/task/v2/internal/logger"
 	"github.com/go-task/task/v2/internal/taskfile"
 )
 
@@ -22,7 +23,7 @@ func (e *Executor) areTaskPreconditionsMet(ctx context.Context, t *taskfile.Task
 		})
 
 		if err != nil {
-			e.Logger.Errf("task: %s", p.Msg)
+			e.Logger.Errf(logger.Magenta, "task: %s", p.Msg)
 			return false, ErrPreconditionFailed
 		}
 	}

status.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 
 	"github.com/go-task/task/v2/internal/execext"
+	"github.com/go-task/task/v2/internal/logger"
 	"github.com/go-task/task/v2/internal/status"
 	"github.com/go-task/task/v2/internal/taskfile"
 )
@@ -78,10 +79,10 @@ func (e *Executor) isTaskUpToDateStatus(ctx context.Context, t *taskfile.Task) (
 			Env:     getEnviron(t),
 		})
 		if err != nil {
-			e.Logger.VerboseOutf("task: status command %s exited non-zero: %s", s, err)
+			e.Logger.VerboseOutf(logger.Yellow, "task: status command %s exited non-zero: %s", s, err)
 			return false, nil
 		}
-		e.Logger.VerboseOutf("task: status command %s exited zero", s)
+		e.Logger.VerboseOutf(logger.Yellow, "task: status command %s exited zero", s)
 	}
 	return true, nil
 }