feat: add '--no-color' flag

DanielleMaywood · DanielleMaywood · commit 098d35d7d44b · 2024-09-13T12:01:10.000Z
diff --git a/cli/cliui/cliui.go b/cli/cliui/cliui.go
@@ -2,7 +2,9 @@ package cliui
 
 import (
 	"flag"
+	"fmt"
 	"os"
+	"slices"
 	"sync"
 	"time"
 
@@ -12,6 +14,10 @@ import (
 	"github.com/coder/pretty"
 )
 
+const NoColorFlag = "no-color"
+
+var NoColor = false
+
 var Canceled = xerrors.New("canceled")
 
 // DefaultStyles compose visual elements of the UI.
@@ -37,21 +43,30 @@ var (
 )
 
 var (
-	Green  = Color("2")
-	Red    = Color("1")
-	Yellow = Color("3")
-	Blue   = Color("6")
+	Green  = Color("10")
+	Red    = Color("9")
+	Yellow = Color("11")
+	Blue   = Color("12")
 )
 
 // Color returns a color for the given string.
 func Color(s string) termenv.Color {
 	colorOnce.Do(func() {
 		color = termenv.NewOutput(os.Stdout).ColorProfile()
+
 		if flag.Lookup("test.v") != nil {
 			// Use a consistent colorless profile in tests so that results
 			// are deterministic.
 			color = termenv.Ascii
 		}
+
+		// Currently it appears there is no way to use the flag from
+		// serpent as it isn't possible to create a root middleware that
+		// runs for every command. For now we just check if `os.Args`
+		// has the flag.
+		if slices.Contains(os.Args, fmt.Sprintf("--%s", NoColorFlag)) {
+			color = termenv.Ascii
+		}
 	})
 	return color.Color(s)
 }
diff --git a/cli/root.go b/cli/root.go
@@ -461,6 +461,12 @@ func (r *RootCmd) Command(subcommands []*serpent.Command) (*serpent.Command, err
 			Value:       serpent.StringOf(&r.globalConfig),
 			Group:       globalGroup,
 		},
+		{
+			Flag:        cliui.NoColorFlag,
+			Description: "Disable use of color in CLI output.",
+			Value:       serpent.BoolOf(&cliui.NoColor),
+			Group:       globalGroup,
+		},
 		{
 			Flag: "version",
 			// This was requested by a customer to assist with their migration.
diff --git a/cmd/cliui/main.go b/cmd/cliui/main.go
@@ -38,6 +38,14 @@ func main() {
 		},
 	}
 
+	root.Options = []serpent.Option{
+		{
+			Default: "false",
+			Flag:    cliui.NoColorFlag,
+			Value:   serpent.BoolOf(&cliui.NoColor),
+		},
+	}
+
 	root.Children = append(root.Children, &serpent.Command{
 		Use: "colors",
 		Handler: func(inv *serpent.Invocation) error {
