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許可分發。