phpstan friendly formatter

? Phpstan Friendly Formatter

Aprimore sua experiência no Phpstan com um formatador que dá vida ao seu código!

? Características

• Exibir o quadro do código : consulte o código problemático exatamente onde o erro ocorre
• Resumo do identificador de erro : Obtenha uma visão geral rápida dos tipos de erro e suas frequências
• Bela saída : Desfrute de um relatório de erro visualmente atraente e fácil de ler

Motivação

Já se sentiu perdido em um mar de caminhos de arquivo e números de linha? Nós estivemos lá! É por isso que criamos este formatador para:

• Identificar instantaneamente o que há de errado em seu código
• Reduza a sobrecarga mental ao interpretar mensagens de erro
• Acelere seu processo de depuração

Começando

1. Você pode usar o Composer para instalar este pacote como uma dependência de desenvolvimento.

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

2. Registre o Erro Formatter no seu phpstan.neon ou phpstan.neon.dist :

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

3. Finalmente, defina o parâmetro errorFormat :

 parameters :
    errorFormat : friendly

Opcional: simplifique seu fluxo de trabalho

Se você quiser simplificar, definir scripts no composer.json da seguinte forma:

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

Você pode executar um pequeno comando como este:

composer analyze

Opções de configuração

Você pode personalizar em seu phpstan.neon :

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

• lineBefore ... número de linhas a serem exibidas antes da linha de erro
• lineAfter ... número de linhas a serem exibidas após a linha de erro
• editorUrl ... URL com espaço reservado como [Config da tabela] (URL para editor como a tabela Formatter)

Exemplo?

Quando você realmente o apresenta em ações do GitHub, ele será exibido da seguinte forma.

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

Licença

Distribuído sob a licença do MIT.