phpstan friendly formatter

? Phpstan Amable Formatero

¡Mejore su experiencia Phpstan con un formato que da vida a su código!

? Características

• MARCA DE CÓDIGO DE PANTALLA : consulte el código problemático justo donde ocurre el error
• Resumen del identificador de error : Obtenga una descripción general rápida de los tipos de error y sus frecuencias
• Hermosa salida : disfrute de un informe de error visualmente atractivo y fácil de leer

Motivación

¿Alguna vez se ha sentido perdido en un mar de rutas de archivo y números de línea? ¡Hemos estado allí! Por eso creamos este formateador para:

• Identificar instantáneamente lo que está mal en su código
• Reduzca la sobrecarga mental al interpretar los mensajes de error
• Acelere su proceso de depuración

Empezando

1. Puede usar el compositor para instalar este paquete como una dependencia del desarrollo.

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

2. Registre el formateador de error en su phpstan.neon o phpstan.neon.dist :

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

3. Finalmente, establezca el parámetro errorFormat :

 parameters :
    errorFormat : friendly

Opcional: simplifique su flujo de trabajo

Si desea hacerlo más simple, configurar scripts en composer.json de la siguiente manera:

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

Puedes ejecutar un comando corto como este:

composer analyze

Opciones de configuración

Puede personalizar en su 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 líneas para mostrar antes de la línea de error
• lineAfter ... Número de líneas para mostrar después de la línea de error
• editorUrl ... URL con marcadores de posición como [Configuración de formateador de tabla] (URL para el editor como Formatero de tabla)

? ️ Ejemplo

Cuando realmente lo presenta en acciones de GitHub, se mostrará de la siguiente manera.

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

Licencia

Distribuido bajo la licencia MIT.