2017 © Pedro Peláez
 

library debug-statements-fixers

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

image

drew/debug-statements-fixers

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

  • Thursday, April 19, 2018
  • by akovalyov
  • Repository
  • 2 Watchers
  • 7 Stars
  • 3,904 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 1 Forks
  • 0 Open issues
  • 7 Versions
  • 9 % Grown

The README.md

Debug Statements Fixers

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

PHP 7.0 Build Status Latest Stable Version Total Downloads License, (*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

The Versions

19/04 2018

dev-master

9999999-dev

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

  Sources   Download

MIT

The Requires

 

The Development Requires

by Andrew Kovalyov

19/04 2018

0.5

0.5.0.0

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

  Sources   Download

MIT

The Requires

 

The Development Requires

by Andrew Kovalyov

19/04 2018

dev-feature/remove-dd

dev-feature/remove-dd

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

  Sources   Download

MIT

The Requires

 

The Development Requires

by Andrew Kovalyov

19/04 2017

0.4

0.4.0.0

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

  Sources   Download

MIT

The Requires

 

The Development Requires

by Andrew Kovalyov

05/03 2017

0.3

0.3.0.0

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

  Sources   Download

MIT

The Requires

 

The Development Requires

by Andrew Kovalyov

01/03 2017

0.2

0.2.0.0

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

  Sources   Download

MIT

The Requires

 

The Development Requires

by Andrew Kovalyov

28/01 2017

0.1

0.1.0.0

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

  Sources   Download

MIT

The Requires

 

The Development Requires

by Andrew Kovalyov