phpstan friendly formatter

? Phpstan Friendly Formatter

Улучшите свой опыт 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

Необязательно: упростите свой рабочий процесс

Если вы хотите сделать это проще, установите scripts на composer.json следующим образом:

{
    "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 с заполнителями, такими как [конфигурация таблицы] (URL -адрес для редактора, такого как форматт таблицы)

? ️ Пример

Когда вы на самом деле представляете его в действиях GitHub, он будет отображаться следующим образом.

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

Лицензия

Распределено по лицензии MIT.