Add new RichCLIMessage error type

cmoog · cmoog · commit 6ef3b24a818f · 2020-10-21T01:13:46.000-05:00
diff --git a/cmd/coder/main.go b/cmd/coder/main.go
@@ -9,8 +9,10 @@ import (
 	"os"
 	"runtime"
 
+	"cdr.dev/coder-cli/internal/clog"
 	"cdr.dev/coder-cli/internal/cmd"
 	"cdr.dev/coder-cli/internal/x/xterminal"
+	"golang.org/x/xerrors"
 
 	"go.coder.com/flog"
 )
@@ -42,6 +44,11 @@ func main() {
 	app.Version = fmt.Sprintf("%s %s %s/%s", version, runtime.Version(), runtime.GOOS, runtime.GOARCH)
 
 	if err := app.ExecuteContext(ctx); err != nil {
-		flog.Fatal("%v", err)
+		var cliErr clog.RichCLIMessage
+		if xerrors.As(err, &cliErr) {
+			fmt.Println(cliErr.Error())
+		} else {
+			flog.Fatal("%v", err)
+		}
 	}
 }
diff --git a/internal/clog/error.go b/internal/clog/error.go
@@ -0,0 +1,69 @@
+package clog
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/fatih/color"
+)
+
+// RichCLIMessage provides a human-readable message for CLI errors and messages.
+type RichCLIMessage struct {
+	Level  string
+	Color  color.Attribute
+	Header string
+	Lines  []string
+}
+
+// Error formats the CLI message for consumption by a human as an error.
+func (r RichCLIMessage) Error() string {
+	var str strings.Builder
+	str.WriteString(fmt.Sprintf("%s: %s\n",
+		color.New(r.Color).Sprint(r.Level),
+		color.New(color.Bold).Sprint(r.Header)),
+	)
+	for _, line := range r.Lines {
+		str.WriteString(fmt.Sprintf("  %s %s\n", color.New(r.Color).Sprint("|"), line))
+	}
+	return str.String()
+}
+
+// String gives the same formatting as Error.
+func (r RichCLIMessage) String() string {
+	return r.Error()
+}
+
+// Warn creates an error with the level "warning".
+func Warn(header string, lines ...string) error {
+	return RichCLIMessage{
+		Color:  color.FgYellow,
+		Level:  "warning",
+		Header: header,
+		Lines:  lines,
+	}
+}
+
+// Error creates an error with the level "error".
+func Error(header string, lines ...string) error {
+	return RichCLIMessage{
+		Color:  color.FgRed,
+		Level:  "error",
+		Header: header,
+		Lines:  lines,
+	}
+}
+
+// Fatal creates an error with the level "fatal".
+func Fatal(header string, lines ...string) error {
+	return RichCLIMessage{
+		Color:  color.FgRed,
+		Level:  "fatal",
+		Header: header,
+		Lines:  lines,
+	}
+}
+
+// Bold provides a convenience wrapper around color.New for brevity when logging.
+func Bold(a string) string {
+	return color.New(color.Bold).Sprint(a)
+}
diff --git a/internal/cmd/ceapi.go b/internal/cmd/ceapi.go
@@ -5,6 +5,7 @@ import (
 	"fmt"
 
 	"cdr.dev/coder-cli/coder-sdk"
+	"cdr.dev/coder-cli/internal/clog"
 	"golang.org/x/xerrors"
 )
 
@@ -73,10 +74,12 @@ func findEnv(ctx context.Context, client *coder.Client, envName, userEmail strin
 		found = append(found, env.Name)
 	}
 
-	return nil, notFoundButDidFind{
-		needle:   envName,
-		haystack: found,
-	}
+	return nil, clog.Fatal(
+		"failed to execute command in environment",
+		fmt.Sprintf("environment %q not found in %q", envName, found),
+		"",
+		clog.Bold("tip: ")+"view your environments with \"coder envs ls\"",
+	)
 }
 
 type notFoundButDidFind struct {
