feature #34252 [Console] Add support for NO_COLOR env var (Seldaek)

nicolas-grekas · nicolas-grekas · commit 97577aea66fb · 2019-11-08T17:06:42.000+01:00
This PR was merged into the 4.4 branch. Discussion ---------- [Console] Add support for NO_COLOR env var | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | License | MIT | Doc PR | Adds support for https://no-color.org/ - ideally this would be considered a bugfix and added to older releases IMO, but submitting as new feature for now. cc @johnstevenson Commits ------- c1b0a8e Add support for NO_COLOR env var
diff --git a/src/Symfony/Bridge/PhpUnit/DeprecationErrorHandler.php b/src/Symfony/Bridge/PhpUnit/DeprecationErrorHandler.php
@@ -357,6 +357,11 @@ private static function hasColorSupport()
             return false;
         }
 
+        // Follow https://no-color.org/
+        if (isset($_SERVER['NO_COLOR']) || false !== getenv('NO_COLOR')) {
+            return false;
+        }
+
         if ('Hyper' === getenv('TERM_PROGRAM')) {
             return true;
         }
diff --git a/src/Symfony/Component/Console/CHANGELOG.md b/src/Symfony/Component/Console/CHANGELOG.md
@@ -13,6 +13,7 @@ CHANGELOG
  * deprecated returning `null` from `Command::execute()`, return `0` instead
  * Deprecated the `Application::renderException()` and `Application::doRenderException()` methods,
    use `renderThrowable()` and `doRenderThrowable()` instead.
+ * added support for the `NO_COLOR` env var (https://no-color.org/)
 
 4.3.0
 -----
diff --git a/src/Symfony/Component/Console/Output/StreamOutput.php b/src/Symfony/Component/Console/Output/StreamOutput.php
@@ -97,6 +97,11 @@ protected function doWrite($message, $newline)
      */
     protected function hasColorSupport()
     {
+        // Follow https://no-color.org/
+        if (isset($_SERVER['NO_COLOR']) || false !== getenv('NO_COLOR')) {
+            return false;
+        }
+
         if ('Hyper' === getenv('TERM_PROGRAM')) {
             return true;
         }
diff --git a/src/Symfony/Component/VarDumper/CHANGELOG.md b/src/Symfony/Component/VarDumper/CHANGELOG.md
@@ -10,6 +10,7 @@ CHANGELOG
  * added the stamps of a message after it is dispatched in `TraceableMessageBus` and `MessengerDataCollector` collected data
  * added `UuidCaster`
  * made all casters final
+ * added support for the `NO_COLOR` env var (https://no-color.org/)
 
 4.3.0
 -----
diff --git a/src/Symfony/Component/VarDumper/Dumper/CliDumper.php b/src/Symfony/Component/VarDumper/Dumper/CliDumper.php
@@ -582,6 +582,11 @@ private function hasColorSupport($stream): bool
             return false;
         }
 
+        // Follow https://no-color.org/
+        if (isset($_SERVER['NO_COLOR']) || false !== getenv('NO_COLOR')) {
+            return false;
+        }
+
         if ('Hyper' === getenv('TERM_PROGRAM')) {
             return true;
         }

Original file line number	Diff line number	Diff line change
`@@ -357,6 +357,11 @@ private static function hasColorSupport()`
`357`	`357`	`return false;`
`358`	`358`	`}`
`359`	`359`
	`360`	`+ // Follow https://no-color.org/`
	`361`	`+ if (isset($_SERVER['NO_COLOR']) \|\| false !== getenv('NO_COLOR')) {`
	`362`	`+ return false;`
	`363`	`+ }`
	`364`	`+`
`360`	`365`	`if ('Hyper' === getenv('TERM_PROGRAM')) {`
`361`	`366`	`return true;`
`362`	`367`	`}`
Original file line number	Diff line number	Diff line change
`@@ -97,6 +97,11 @@ protected function doWrite($message, $newline)`
`97`	`97`	`*/`
`98`	`98`	`protected function hasColorSupport()`
`99`	`99`	`{`
	`100`	`+ // Follow https://no-color.org/`
	`101`	`+ if (isset($_SERVER['NO_COLOR']) \|\| false !== getenv('NO_COLOR')) {`
	`102`	`+ return false;`
	`103`	`+ }`
	`104`	`+`
`100`	`105`	`if ('Hyper' === getenv('TERM_PROGRAM')) {`
`101`	`106`	`return true;`
`102`	`107`	`}`
Original file line number	Diff line number	Diff line change
`@@ -582,6 +582,11 @@ private function hasColorSupport($stream): bool`
`582`	`582`	`return false;`
`583`	`583`	`}`
`584`	`584`
	`585`	`+ // Follow https://no-color.org/`
	`586`	`+ if (isset($_SERVER['NO_COLOR']) \|\| false !== getenv('NO_COLOR')) {`
	`587`	`+ return false;`
	`588`	`+ }`
	`589`	`+`
`585`	`590`	`if ('Hyper' === getenv('TERM_PROGRAM')) {`
`586`	`591`	`return true;`
`587`	`592`	`}`