Add support for CLICOLOR "standard"

mislav · mislav · commit ca2f2b18ca50 · 2020-09-04T21:32:58.000+02:00
The CLICOLOR_FORCE environment variable can now be used to force color output even when stdout is redirected. https://bixense.com/clicolors/
diff --git a/pkg/cmd/root/root.go b/pkg/cmd/root/root.go
@@ -61,7 +61,12 @@ func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) *cobra.Command {
 				GLAMOUR_STYLE: the style to use for rendering Markdown. See
 				https://github.com/charmbracelet/glamour#styles
 	
-				NO_COLOR: avoid printing ANSI escape sequences for color output.
+				NO_COLOR: set to any value to avoid printing ANSI escape sequences for color output.
+
+				CLICOLOR: set to "0" to disable printing ANSI colors in output.
+
+				CLICOLOR_FORCE: set to a value other than "0" to keep ANSI colors in output
+				even when the output is piped.
 			`),
 		},
 	}
diff --git a/pkg/iostreams/iostreams.go b/pkg/iostreams/iostreams.go
@@ -106,11 +106,14 @@ func System() *IOStreams {
 	stdoutIsTTY := isTerminal(os.Stdout)
 	stderrIsTTY := isTerminal(os.Stderr)
 
+	envNoColor := os.Getenv("NO_COLOR") != "" || os.Getenv("CLICOLOR") == "0"
+	envForceColor := os.Getenv("CLICOLOR_FORCE") != "" && os.Getenv("CLICOLOR_FORCE") != "0"
+
 	io := &IOStreams{
 		In:           os.Stdin,
 		Out:          colorable.NewColorable(os.Stdout),
 		ErrOut:       colorable.NewColorable(os.Stderr),
-		colorEnabled: os.Getenv("NO_COLOR") == "" && stdoutIsTTY,
+		colorEnabled: envForceColor || (!envNoColor && stdoutIsTTY),
 	}
 
 	// prevent duplicate isTerminal queries now that we know the answer
diff --git a/utils/color.go b/utils/color.go
@@ -39,7 +39,11 @@ func makeColorFunc(color string) func(string) string {
 }
 
 func isColorEnabled() bool {
-	if os.Getenv("NO_COLOR") != "" {
+	if os.Getenv("CLICOLOR_FORCE") != "" && os.Getenv("CLICOLOR_FORCE") != "0" {
+		return true
+	}
+
+	if os.Getenv("NO_COLOR") != "" || os.Getenv("CLICOLOR") == "0" {
 		return false
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,11 @@ func makeColorFunc(color string) func(string) string {`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`func isColorEnabled() bool {`
`42`		`- if os.Getenv("NO_COLOR") != "" {`
	`42`	`+ if os.Getenv("CLICOLOR_FORCE") != "" && os.Getenv("CLICOLOR_FORCE") != "0" {`
	`43`	`+ return true`
	`44`	`+ }`
	`45`	`+`
	`46`	`+ if os.Getenv("NO_COLOR") != "" \|\| os.Getenv("CLICOLOR") == "0" {`
`43`	`47`	`return false`
`44`	`48`	`}`
`45`	`49`