README

使用格式化器让你的PHPStan体验更上一层楼！🚀

🌟 功能

显示代码框架：直接在错误发生处查看有问题的代码
错误标识总结：快速了解错误类型及其频率
美观输出：享受视觉上令人愉悦且易于阅读的错误报告

🎯 动机

是否曾感到在文件路径和行号的大海中迷失？我们也有过这样的经历！这就是我们创建这个格式化工具的原因：

立即定位代码中的问题
减少解析错误信息时的心理负担
加速调试过程

🚀 开始使用

您可以使用 Composer 将此软件包作为开发依赖项安装。

composer require --dev yamadashy/phpstan-friendly-formatter

将错误格式化器注册到您的 phpstan.neon 或 phpstan.neon.dist

includes:
    - ./vendor/yamadashy/phpstan-friendly-formatter/extension.neon

最后，设置 errorFormat 参数

parameters:
    errorFormat: friendly

可选：简化您的流程

如果您想简化操作，可以在 composer.json 中设置 scripts 如下：

{
    "scripts": {
        "analyze": "phpstan analyze --error-format friendly"
    }
}

您可以运行以下简短命令：

composer analyze

⚙️ 配置选项

您可以在 phpstan.neon 中自定义这些选项

parameters:
    friendly:
        # default is 3
        lineBefore: 3
        lineAfter: 3
        # default is null
        editorUrl: 'phpstorm://open?file=%%file%%&line=%%line%%'

lineBefore ... 显示错误行之前要显示的行数
lineAfter ... 显示错误行之后要显示的行数
editorUrl ... 包含占位符的URL，如[table formatter config](URL for editor like table formatter)

🖼️ 示例

当您在GitHub Actions中实际引入它时，它将显示如下。

https://github.com/yamadashy/laravel-blade-minify-directive/actions/runs/4714024802/jobs/8360104870

📜 许可证

在MIT许可证下分发。

yamadashy / phpstan-friendly-formatter

维护者

详细信息