phpstan friendly formatter

？ phpstan友好的格式

通过将您的代码栩栩如生的格式化器增强您的phpstan体验！

？特征

• 显示代码框架：请参阅错误发生错误的问题代码
• 错误标识符摘要：快速概述错误类型及其频率
• 美丽的输出：享受视觉上吸引人且易于阅读的错误报告

动机

是否曾经在文件路径和线路数量中感到迷失？我们去过那里！这就是为什么我们创建此格式化的原因：

• 立即查明您的代码中有什么问题
• 解释错误消息时减少心理开销
• 加速您的调试过程

入门

1. 您可以使用作曲家将此软件包作为开发依赖性安装。

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

2. 在您的phpstan.neon或phpstan.neon.dist中注册错误格式化。

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

3. 最后，设置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]

？例子

当您实际将其引入GitHub Action时，将显示如下。

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

执照

根据MIT许可分发。