Support $NO_COLOR

johnkerl · Jun 8, 2024 · 9312993 · 9312993
1 parent 66abef6
commit 9312993
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 5 deletions.
diff --git a/docs/src/output-colorization.md.in b/docs/src/output-colorization.md.in
@@ -34,7 +34,7 @@ described below:
 
 * Suppression/unsuppression:
 
-    * `export MLR_NO_COLOR=true` means Miller won't color even when it normally would.
+    * `export MLR_NO_COLOR=true` or `export NO_COLOR=true` means Miller won't color even when it normally would.
     * `export MLR_ALWAYS_COLOR=true` means Miller will color even when it normally would not. For example, you might want to use this when piping `mlr` output to `less -r`.
     * Command-line flags `--no-color` or `-M`, `--always-color` or `-C`.
     * On Windows, replace `export` with `set`

diff --git a/docs/src/reference-main-env-vars.md.in b/docs/src/reference-main-env-vars.md.in
@@ -3,6 +3,6 @@
 The following environment variables affect how Miller works:
 
 * `MLRRC`: see [Customization](customization.md).
-* `MLR_NO_COLOR`, `MLR_ALWAYS_COLOR`, `MLR_KEY_COLOR`, `MLR_VALUE_COLOR`, `MLR_PASS_COLOR`, `MLR_FAIL_COLOR`, `MLR_REPL_PS1_COLOR`, `MLR_REPL_PS2_COLOR`, `MLR_HELP_COLOR`: see [Output Colorization](output-colorization.md).
+* `MLR_NO_COLOR`, `NO_COLOR`, `MLR_ALWAYS_COLOR`, `MLR_KEY_COLOR`, `MLR_VALUE_COLOR`, `MLR_PASS_COLOR`, `MLR_FAIL_COLOR`, `MLR_REPL_PS1_COLOR`, `MLR_REPL_PS2_COLOR`, `MLR_HELP_COLOR`: see [Output Colorization](output-colorization.md).
 * `MLR_REPL_PS1`, `MLR_REPL_PS2`: see [REPL](repl.md).
 
diff --git a/pkg/cli/option_parse.go b/pkg/cli/option_parse.go
@@ -2715,8 +2715,8 @@ Mechanisms for coloring:
 How you can control colorization:
 
 * Suppression/unsuppression:
-    * Environment variable ` + "`export MLR_NO_COLOR=true`" + ` means don't color
-      even if stdout+TTY.
+    * Environment variable ` + "`export MLR_NO_COLOR=true` or `export NO_COLOR=true`" + `
+	  means don't color even if stdout+TTY.
     * Environment variable ` + "`export MLR_ALWAYS_COLOR=true`" + ` means do color
       even if not stdout+TTY.
       For example, you might want to use this when piping mlr output to ` + "`less -r`" + `.

diff --git a/pkg/colorizer/colorizer.go b/pkg/colorizer/colorizer.go
@@ -198,7 +198,8 @@ var stdoutIsATTY = getStdoutIsATTY()
 // Read environment variables at startup time. These can be overridden
 // afterward using command-line flags.
 func init() {
-	if os.Getenv("MLR_NO_COLOR") != "" {
+	if os.Getenv("MLR_NO_COLOR") != "" || os.Getenv("NO_COLOR") != "" {
+		colorization = ColorizeOutputNever
 		colorization = ColorizeOutputNever
 	} else if os.Getenv("MLR_ALWAYS_COLOR") != "" {
 		colorization = ColorizeOutputAlways