Output warnings for deprecated rules and options

PHP-CS-Fixer · Apr 12, 2020 · 1a9e0c7 · 1a9e0c7
1 parent 99fc6f1
commit 1a9e0c7
Show file tree

Hide file tree

Showing 11 changed files with 70 additions and 13 deletions.
diff --git a/php-cs-fixer b/php-cs-fixer
@@ -95,6 +95,7 @@ $xdebug->check();
 unset($xdebug);
 
 $application = new Application();
+$application->enableDeprecationWarnings();
 $application->run();
 
 __HALT_COMPILER();
diff --git a/src/AbstractFixer.php b/src/AbstractFixer.php
@@ -124,7 +124,7 @@ public function configure(array $configuration = null)
                 throw new \InvalidArgumentException("{$message} This check was performed as `PHP_CS_FIXER_FUTURE_MODE` env var is set.");
             }
 
-            @trigger_error($message, E_USER_DEPRECATED);
+            Application::triggerDeprecation($message);
 
             $configuration = [];
         }
@@ -148,7 +148,7 @@ public function configure(array $configuration = null)
                     throw new \InvalidArgumentException("{$message} This check was performed as `PHP_CS_FIXER_FUTURE_MODE` env var is set.");
                 }
 
-                @trigger_error($message, E_USER_DEPRECATED);
+                Application::triggerDeprecation($message);
             }
         }
 

diff --git a/src/Config.php b/src/Config.php
@@ -12,6 +12,7 @@
 
 namespace PhpCsFixer;
 
+use PhpCsFixer\Console\Application;
 use PhpCsFixer\Fixer\FixerInterface;
 
 /**
@@ -46,7 +47,7 @@ public function __construct($name = 'default')
      */
     public static function create()
     {
-        @trigger_error(__METHOD__.' is deprecated since 2.17 and will be removed in 3.0.', E_USER_DEPRECATED);
+        Application::triggerDeprecation(__METHOD__.' is deprecated since 2.17 and will be removed in 3.0.');
 
         return new static();
     }

diff --git a/src/Console/Application.php b/src/Console/Application.php
@@ -43,6 +43,12 @@ final class Application extends BaseApplication
      */
     private $toolInfo;
 
+    private $deprecationWarningsEnabled = false;
+
+    private $customErrorHandlerRegistered = false;
+
+    private static $printCurrentDeprecationNotice = false;
+
     public function __construct()
     {
         if (!getenv('PHP_CS_FIXER_FUTURE_MODE')) {
@@ -63,6 +69,21 @@ public function __construct()
         ));
     }
 
+    public function enableDeprecationWarnings()
+    {
+        $this->deprecationWarningsEnabled = true;
+    }
+
+    /**
+     * @param string $message
+     */
+    public static function triggerDeprecation($message)
+    {
+        self::$printCurrentDeprecationNotice = true;
+        @trigger_error($message, E_USER_DEPRECATED);
+        self::$printCurrentDeprecationNotice = false;
+    }
+
     /**
      * @return int
      */
@@ -80,7 +101,24 @@ public function doRun(InputInterface $input, OutputInterface $output)
             ? $output->getErrorOutput()
             : ($input->hasParameterOption('--format', true) && 'txt' !== $input->getParameterOption('--format', null, true) ? null : $output)
         ;
+
+        $previousErrorHandler = null;
+
         if (null !== $stdErr) {
+            if ($this->deprecationWarningsEnabled && !$this->customErrorHandlerRegistered) {
+                $previousErrorHandler = set_error_handler(function ($severity, $message, $file, $line) use (&$previousErrorHandler, $stdErr) {
+                    if (self::$printCurrentDeprecationNotice && $severity & E_USER_DEPRECATED) {
+                        $stdErr->writeln("<bg=yellow;fg=black;>{$message}</>");
+                    }
+
+                    if (\is_callable($previousErrorHandler)) {
+                        $previousErrorHandler($severity, $message, $file, $line);
+                    }
+                });
+
+                $this->customErrorHandlerRegistered = true;
+            }
+
             $warningsDetector = new WarningsDetector($this->toolInfo);
             $warningsDetector->detectOldVendor();
             $warningsDetector->detectOldMajor();
@@ -89,7 +127,17 @@ public function doRun(InputInterface $input, OutputInterface $output)
             }
         }
 
-        return parent::doRun($input, $output);
+        $exitCode = parent::doRun($input, $output);
+
+        if (null !== $previousErrorHandler) {
+            set_error_handler($previousErrorHandler);
+        } else {
+            restore_error_handler();
+        }
+
+        $this->customErrorHandlerRegistered = false;
+
+        return $exitCode;
     }
 
     /**

diff --git a/src/Console/ConfigurationResolver.php b/src/Console/ConfigurationResolver.php
@@ -434,7 +434,7 @@ public function getProgress()
                         throw new \InvalidArgumentException("{$message} This check was performed as `PHP_CS_FIXER_FUTURE_MODE` env var is set.");
                     }
 
-                    @trigger_error($message, E_USER_DEPRECATED);
+                    Application::triggerDeprecation($message);
                 }
 
                 $this->progress = $progressType;
@@ -771,7 +771,7 @@ private function validateRules(array $rules)
                     throw new \RuntimeException("{$message} This check was performed as `PHP_CS_FIXER_FUTURE_MODE` env var is set.");
                 }
 
-                @trigger_error($message, E_USER_DEPRECATED);
+                Application::triggerDeprecation($message);
             }
         }
     }
@@ -923,7 +923,7 @@ private function resolveOptionBooleanValue($optionName)
             throw new InvalidConfigurationException("{$message} This check was performed as `PHP_CS_FIXER_FUTURE_MODE` env var is set.");
         }
 
-        @trigger_error($message, E_USER_DEPRECATED);
+        Application::triggerDeprecation($message);
 
         return false;
     }

diff --git a/src/Fixer/ClassNotation/ClassAttributesSeparationFixer.php b/src/Fixer/ClassNotation/ClassAttributesSeparationFixer.php
@@ -13,6 +13,7 @@
 namespace PhpCsFixer\Fixer\ClassNotation;
 
 use PhpCsFixer\AbstractFixer;
+use PhpCsFixer\Console\Application;
 use PhpCsFixer\Fixer\ConfigurationDefinitionFixerInterface;
 use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
@@ -195,7 +196,7 @@ protected function createConfigurationDefinition()
                     $deprecated = array_intersect($values, self::SUPPORTED_TYPES);
                     if (\count($deprecated) > 0) {
                         $message = 'A list of elements is deprecated, use a dictionary of `const|method|property` => `none|one` instead.';
-                        @trigger_error($message, E_USER_DEPRECATED);
+                        Application::triggerDeprecation($message);
 
                         return array_fill_keys($deprecated, self::SPACING_ONE);
                     }

diff --git a/src/Fixer/Operator/BinaryOperatorSpacesFixer.php b/src/Fixer/Operator/BinaryOperatorSpacesFixer.php
@@ -14,6 +14,7 @@
 
 use PhpCsFixer\AbstractFixer;
 use PhpCsFixer\ConfigurationException\InvalidFixerConfigurationException;
+use PhpCsFixer\Console\Application;
 use PhpCsFixer\Console\Command\HelpCommand;
 use PhpCsFixer\Fixer\ConfigurationDefinitionFixerInterface;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
@@ -525,7 +526,7 @@ private function resolveOldConfig(array $configuration)
             throw new InvalidFixerConfigurationException($this->getName(), "{$message} This check was performed as `PHP_CS_FIXER_FUTURE_MODE` env var is set.");
         }
 
-        @trigger_error($message, E_USER_DEPRECATED);
+        Application::triggerDeprecation($message);
 
         return $newConfig;
     }

diff --git a/src/Fixer/Whitespace/BlankLineBeforeStatementFixer.php b/src/Fixer/Whitespace/BlankLineBeforeStatementFixer.php
@@ -13,6 +13,7 @@
 namespace PhpCsFixer\Fixer\Whitespace;
 
 use PhpCsFixer\AbstractFixer;
+use PhpCsFixer\Console\Application;
 use PhpCsFixer\Fixer\ConfigurationDefinitionFixerInterface;
 use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface;
 use PhpCsFixer\FixerConfiguration\AllowedValueSubset;
@@ -88,7 +89,7 @@ public function configure(array $configuration = null)
 
         foreach ($this->configuration['statements'] as $key) {
             if ('die' === $key) {
-                @trigger_error('Option "die" is deprecated, use "exit" instead.', E_USER_DEPRECATED);
+                Application::triggerDeprecation('Option "die" is deprecated, use "exit" instead.');
             }
 
             $this->fixTokenMap[$key] = self::$tokenMap[$key];

diff --git a/src/Fixer/Whitespace/NoExtraBlankLinesFixer.php b/src/Fixer/Whitespace/NoExtraBlankLinesFixer.php
@@ -14,6 +14,7 @@
 
 use PhpCsFixer\AbstractFixer;
 use PhpCsFixer\ConfigurationException\InvalidConfigurationException;
+use PhpCsFixer\Console\Application;
 use PhpCsFixer\Fixer\ConfigurationDefinitionFixerInterface;
 use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface;
 use PhpCsFixer\FixerConfiguration\AllowedValueSubset;
@@ -325,7 +326,7 @@ protected function createConfigurationDefinition()
                                 throw new InvalidConfigurationException("{$message} This check was performed as `PHP_CS_FIXER_FUTURE_MODE` env var is set.");
                             }
 
-                            @trigger_error($message, E_USER_DEPRECATED);
+                            Application::triggerDeprecation($message);
                             $token = 'use_trait';
 
                             break;

diff --git a/src/FixerConfiguration/FixerConfigurationResolver.php b/src/FixerConfiguration/FixerConfigurationResolver.php
@@ -12,6 +12,7 @@
 
 namespace PhpCsFixer\FixerConfiguration;
 
+use PhpCsFixer\Console\Application;
 use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
@@ -67,7 +68,7 @@ public function resolve(array $options)
                         throw new InvalidOptionsException(sprintf('Aliased option %s/%s is passed multiple times.', $name, $alias));
                     }
 
-                    @trigger_error(sprintf('Option "%s" is deprecated, use "%s" instead.', $alias, $name), E_USER_DEPRECATED);
+                    Application::triggerDeprecation(sprintf('Option "%s" is deprecated, use "%s" instead.', $alias, $name));
 
                     $options[$name] = $options[$alias];
                     unset($options[$alias]);

diff --git a/src/FixerConfiguration/FixerConfigurationResolverRootless.php b/src/FixerConfiguration/FixerConfigurationResolverRootless.php
@@ -12,6 +12,8 @@
 
 namespace PhpCsFixer\FixerConfiguration;
 
+use PhpCsFixer\Console\Application;
+
 /**
  * @internal
  *
@@ -88,7 +90,7 @@ static function (FixerOptionInterface $option) {
                     throw new \RuntimeException("{$message}. This check was performed as `PHP_CS_FIXER_FUTURE_MODE` env var is set.");
                 }
 
-                @trigger_error($message, E_USER_DEPRECATED);
+                Application::triggerDeprecation($message);
 
                 $options = [$this->root => $options];
             }