drew/debug-statements-fixers

移除不应该在生产环境中出现的调试语句

0.5 2018-04-19 09:13 UTC

README

为PHP-CS-Fixer设置的修复器。移除不应该在生产环境中出现的调试语句。

PHP 7.0 Build Status Latest Stable Version Total Downloads License

如果您曾经因为dump()函数缺失而导致生产环境出现500错误,或者您偶尔忘记移除调试语句,这个小包就是为您准备的。

调试语句对调试很有用,但它们绝不应该出现在master分支中。

最初作为PHP-CS-Fixer仓库中的RFC提出,由于风险太大,因此被认为不适合核心(参见PHP-CS-Fixer/PHP-CS-Fixer#2218中的讨论)

注意。这些修复器有风险,并且可能会破坏您的应用程序。您应该了解将它们纳入您的项目(尤其是遗留项目)的后果。已向您发出警告。

将被移除的函数

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

使用方法

  1. 安装它

    $ composer require drew/debug-statements-fixers:^0.4 --dev
  2. 调整您的PHP-CS-Fixer配置

    # .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. 享受吧。

提示!

当与CI服务器集成时效果最佳,只需将此步骤添加到您的CI配置中即可。

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