tombenevides / dump-linter
A custom rules to remove dump functions from PHP code
Requires
- friendsofphp/php-cs-fixer: ^3.13
Requires (Dev)
- pestphp/pest: ^1.22
README
Sometimes you are debugging and end up deploying with your code a dump
or a var_dump
(if you're a Laravel dev, the infamous dd
) and that could be annoying, so Dump Linter is a package that complements PHP-CS-Fixer, providing a rule to remove dump statements from the source code.
❗ IMPORTANT: the rule is considered risky by PHP-CS-Fixer metrics because technically
dump
/var_dump
are not errors or bad writing, so be careful and use this rule if you're completely sure that you don't want them in the codebase.
REQUIREMENTS
HOW TO INSTALL
To install the package, just use composer:
composer require tombenevides/dump-linter
HOW TO USE
Configuring PHP-CS-Fixer
After installing, you need to edit the .php-cs-fixer.dist.php
file (or the file that you're chose), adding the custom rule using registerCustomFixers()
function and then set the rule, as you can see below:
$config = new PhpCsFixer\Config(); return $config ->registerCustomFixers([ new \Tombenevides\DumpLinter\DumpRemovalFixer() ]) ->setRules([ '@PSR12' => true, 'Tombenevides/dump_removal' => true, ... ])
List of dump statements that will be removed:
dump()
,var_dump()
,dd()
,ray()
anddumps()
.
More info or questions about PHP-CS-Fixer configuration file, just check this link.
Running the linter with custom rule
Since this is a risky rule, the default command php-cs-fixer fix -v
will not work. Therefore, to allow the rule to make the expected changes, you need to give the linter permission to perform risky actions. You do this by adding the --allow-risky=yes
flag.
LICENSE
Dump Linter is a software under the MIT License
UPDATES
👋 Follow the author @devatreides on Twitter to know more about the last updates and other projects. Say Hi!