README

有时你在调试代码时，不小心将 dump 或 var_dump （如果你是 Laravel 开发者，那便是臭名昭著的 dd）部署到线上，这可能会让人感到烦恼，所以 Dump Linter 是一个用于补充 PHP-CS-Fixer 的包，它提供了一个规则来从源代码中删除 dump 语句。

❗ 重要提示：由于技术上 dump/var_dump 并不是错误或不良书写，所以 PHP-CS-Fixer 的指标将此规则视为风险，因此请务必小心，只有在您完全确信您不希望在代码库中使用这些语句时才使用此规则。

要求

PHP 8.1+

PHP-CS-Fixer 3

如何安装

要安装此包，只需使用 composer

composer require tombenevides/dump-linter

如何使用

配置 PHP-CS-Fixer

安装后，您需要编辑 .php-cs-fixer.dist.php 文件（或您选择的文件），使用 registerCustomFixers() 函数添加自定义规则，然后设置规则，如下所示

$config = new PhpCsFixer\Config();

return $config
    ->registerCustomFixers([
        new \Tombenevides\DumpLinter\DumpRemovalFixer()
    ])
    ->setRules([
        '@PSR12' => true,
        'Tombenevides/dump_removal' => true,
        ...
    ])

将要删除的 dump 语句列表：dump()、var_dump()、dd()、ray() 和 dumps()。

有关 PHP-CS-Fixer 配置文件的更多信息或问题，请查看此链接。

使用自定义规则运行 linter

由于这是一个风险规则，默认命令 php-cs-fixer fix -v 将不会工作。因此，要允许此规则进行预期的更改，您需要允许 linter 执行风险操作。您可以通过添加 --allow-risky=yes 标志来完成此操作。

许可证

Dump Linter 是一个受 MIT 许可证控制的软件

更新

👋 关注作者 @devatreides 在 Twitter 上以了解最新的更新和其他项目。你好！

tombenevides / dump-linter

维护者

详细信息

README

要求

如何安装

如何使用

配置 PHP-CS-Fixer

使用自定义规则运行 linter

许可证

更新