Merge pull request #2998 from augustoproiete-forks/opt-out-of-ansi-coloring-with-no_color-env-variable

patriksvensson · web-flow · commit 3dd4a543df94 · 2020-12-22T10:42:09.000+01:00
GH-2975: Prevents the addition of ANSI color if NO_COLOR env. variable is present
diff --git a/src/Cake.Core/Diagnostics/Console/AnsiDetector.cs b/src/Cake.Core/Diagnostics/Console/AnsiDetector.cs
@@ -42,6 +42,13 @@ static AnsiDetector()
 
         public static bool SupportsAnsi(ICakeEnvironment environment)
         {
+            // Prevents the addition of ANSI color if NO_COLOR env. variable is present
+            // https://no-color.org
+            if (!string.IsNullOrWhiteSpace(environment.GetEnvironmentVariable("NO_COLOR")))
+            {
+                return false;
+            }
+
             // Github action doesn't setup a correct PTY but supports ANSI.
             if (!string.IsNullOrWhiteSpace(environment.GetEnvironmentVariable("GITHUB_ACTION")))
             {

Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,13 @@ static AnsiDetector()`
`42`	`42`
`43`	`43`	`public static bool SupportsAnsi(ICakeEnvironment environment)`
`44`	`44`	`{`
	`45`	`+ // Prevents the addition of ANSI color if NO_COLOR env. variable is present`
	`46`	`+ // https://no-color.org`
	`47`	`+ if (!string.IsNullOrWhiteSpace(environment.GetEnvironmentVariable("NO_COLOR")))`
	`48`	`+ {`
	`49`	`+ return false;`
	`50`	`+ }`
	`51`	`+`
`45`	`52`	`// Github action doesn't setup a correct PTY but supports ANSI.`
`46`	`53`	`if (!string.IsNullOrWhiteSpace(environment.GetEnvironmentVariable("GITHUB_ACTION")))`
`47`	`54`	`{`