drew/debug-statements-fixers

Removes debug statements, which shouldn't be in production ever

Debug Statements Fixers

Fixers set for PHP-CS-Fixer. Removes debug statements, which shouldn't be in production ever., _(*1)

, _(*2)

If you have ever had 500 Error on production because dump() function is missing, or you forget to remove debug statements time to time - this small package is for you., _(*3)

Debug statements are good for debugging, but it should never get to master branch., _(*4)

Initially proposed as RFC in PHP-CS-Fixer repository, it was considered too risky to have it in core (see discussion at https://github.com/FriendsOfPHP/PHP-CS-Fixer/pull/2218), _(*5)

N.B. These fixers are risky and potentially can break your application. You should understand consequences of having it in your project (especially a legacy one). You are warned., _(*6)

Functions being removed:

• dump()
• var_dump()
• dd()

Usage

1. Install it:, _(*7)

   $ composer require drew/debug-statements-fixers:^0.4 --dev
   

2. Adjust your PHP-CS-Fixer config:, _(*8)

   # .php_cs.dist
   <?php
   
   $finder = PhpCsFixer\Finder::create()
       ->in([__DIR__.'/src', __DIR__.'/tests']);
   
   return PhpCsFixer\Config::create()
       ->setRules([
           //any fixers you would like to have
           'RemoveDebugStatements/dump' => true,
       ])
       ->registerCustomFixers([new Drew\DebugStatementsFixers\Dump()])
       ->setRiskyAllowed(true)
       ->setFinder($finder);    
   

3. Enjoy.

Protip!

Works best when integrated with your CI server, just add this step to your CI config:, _(*9)

$ php vendor/bin/php-cs-fixer fix --diff --dry-run -v