grumphp rector task

Tarea de rector grumphp

Este paquete extiende GRUMPHP con una tarea que ejecuta RectorPhp para sus proyectos de Laravel o cualquier aplicación PHP.

Tenga en cuenta que hemos agregado-opción --dry-run , por lo que el código fuente nunca cambió.

Instalación

La forma más fácil de instalar este paquete es a través del compositor:

composer require --dev palpalani/grumphp-rector-task

Configuración

Agregue el cargador de extensión a su grumphp.yml o grumphp.yml.dist . La tarea vive bajo el espacio de nombres rector y tiene los siguientes parámetros configurables:

 # grumphp.yml
grumphp :
    tasks :
        rector :
            whitelist_patterns : []
            config : ' rector.php '
            triggered_by : ['php']
            clear-cache : false            
            ignore_patterns : []
            no-progress-bar : false
            files_on_pre_commit : false
            paths : []
            no_diffs : false
    extensions :
        - palPalaniGrumPhpRectorTaskExtensionLoader

Por defecto, esto no actualizará su código, debe hacerlo manualmente.

Whitelist_Patterns

Default: []

Si desea ejecutar solo directorios particulares, especifique con esta opción.

configuración

Default: 'rector.php'

Si desea usar un archivo de configuración diferente al predeterminado rector.php , puede especificar la ubicación de su archivo de configuración personalizada con esta opción.

Triggered_by

Default: [php]

Esta opción especificará qué extensiones de archivo activará esta tarea.

color claro

Default: false

Borrar caché para archivos ya verificados.

barra sin progreso

Default: false

Ocultar barra de progreso. EG útil para la salida de CI más agradable.

files_on_pre_commit

Default: false

Esta opción permite usar los archivos cambiados como rutas durante los pre-comité. Utilizará la opción Ruta para asegurarse de que solo se validen los archivos comprometidos que coincidan con la ruta.

No_diff

Default: false

Muestra de configuración de Rectorphp

Cree rector.php en su proyecto Root y configure de la siguiente manera. Este archivo de ejemplo que IAM usando para mi proyecto Laravel, pero puede usar la biblioteca con cualquier proyecto PHP. Además, no es necesario establecer todas estas configuraciones, agregue o elimine según sus requisitos.

 <?php

declare (strict_types= 1 );

use Rector  Core  Configuration  Option ;
use Rector  Set  ValueObject  SetList ;
use Rector  CodeQuality  Rector  If_  SimplifyIfReturnBoolRector ;
use Rector  Config  RectorConfig ;
use Rector  Php74  Rector  Property  TypedPropertyRector ;
use Rector  CodeQuality  Rector  Isset_  IssetOnPropertyObjectToPropertyExistsRector ;

return static function ( RectorConfig $ rectorConfig ): void {
    $ rectorConfig -> parallel ();

    $ rectorConfig -> paths ([
        __DIR__ . ' /app ' ,
        __DIR__ . ' /config ' ,
        __DIR__ . ' /database ' ,
        __DIR__ . ' /tests '
        __DIR__ . ' /routes ' ,
    ]);

    $ rectorConfig -> skip ([
        IssetOnPropertyObjectToPropertyExistsRector::class,

        __DIR__ . ' /app/Http/Middleware/* ' ,
    ]);

    $ rectorConfig -> rules ([
        ReturnTypeFromStrictBoolReturnExprRector::class,
        //ReturnTypeFromStrictNativeFuncCallRector::class,
        ReturnTypeFromStrictNewArrayRector::class,
        ReturnTypeFromStrictScalarReturnExprRector::class,
        ReturnTypeFromReturnNewRector::class,
    ]);

    $ rectorConfig -> sets ([
        SetList:: CODE_QUALITY ,
        SetList:: CODING_STYLE ,
        SetList:: DEAD_CODE ,
        SetList:: TYPE_DECLARATION ,
        SetList:: EARLY_RETURN ,
        SetList:: PHP_81 ,
        LevelSetList:: UP_TO_PHP_80 ,
    ]);

    $ rectorConfig -> sets ([
        LaravelSetList:: LARAVEL_CODE_QUALITY ,
        LaravelSetList:: LARAVEL_90 ,
        LaravelLevelSetList:: UP_TO_LARAVEL_80 ,
    ]);
};

Visite Rectorphp para obtener más ejemplos de configuración.

Desinstalar

Si desea desinstalar esta extensión, elimine los archivos de configuración primero: rector.php de su aplicación.

Luego elimine el paquete:

 composer remove palpalani/grumphp-rector-task

Colegio de cambios

Consulte ChangeLog para obtener más información sobre lo que ha cambiado recientemente.

Que contribuye

Consulte contribuyendo para obtener más detalles.

Vulnerabilidades de seguridad

Revise nuestra política de seguridad sobre cómo informar vulnerabilidades de seguridad.

Versiones

Usamos Semver para versiones. Para las versiones disponibles, consulte las etiquetas en este repositorio.

Créditos

• palpalano

Licencia

La licencia MIT (MIT). Consulte el archivo de licencia para obtener más información.

Hacer

• Agregar restricción de memoria
• Agregar más pruebas
• xdebug