grumphp rector task

Grumpphp -Rektoraufgabe

Dieses Paket erweitert Grumpphp mit einer Aufgabe, die RectorPHP für Ihre Laravel -Projekte oder eine PHP -Anwendung ausführt.

Beachten Sie, dass wir hinzugefügt haben --dry-run Option, sodass sich der Quellcode nie geändert hat.

Installation

Der einfachste Weg, dieses Paket zu installieren, ist über Komponist:

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

Konfiguration

Fügen Sie den Verlängerungslader zu Ihrem grumphp.yml oder grumphp.yml.dist hinzu. Die Aufgabe lebt im rector -Namespace und hat folgende konfigurierbare Parameter:

 # 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

Standardmäßig aktualisiert dies Ihren Code nicht, Sie müssen ihn manuell tun.

whitelist_patterns

Default: []

Wenn Sie nur in bestimmten Verzeichnissen ausführen möchten, geben Sie diese mit dieser Option an.

Konfiguration

Default: 'rector.php'

Wenn Sie eine andere Konfigurationsdatei als den Standard rector.php verwenden möchten, können Sie mit dieser Option Ihren Speicherort für benutzerdefinierte Konfigurationsdatei angeben.

ausgelöst

Default: [php]

In dieser Option wird angegeben, welche Dateierweiterungen diese Aufgabe auslösen.

Clear-Cache

Default: false

Cache für bereits überprüfte Dateien löschen.

No-Progress-Bar

Default: false

Fortschrittsbalken verbergen. Nützlicher EG für die schönere CI -Ausgabe.

file_on_pre_commit

Default: false

Diese Option ermöglicht es, die geänderten Dateien als Pfade während der Vorverbände zu verwenden. Es wird die Option Pfade verwendet, um sicherzustellen, dass nur festgelegte Dateien, die mit dem Pfad übereinstimmen, validiert werden.

no_diff

Default: false

Probe RectorPHP -Konfiguration

Erstellen Sie rector.php in Ihrem Projektroot und konfigurieren Sie wie folgt. Diese Beispieldatei, die für mein Laravel -Projekt verwendet wird, können Sie jedoch Bibliothek mit jedem PHP -Projekt verwenden. Außerdem müssen Sie alle diese Einstellungen nicht festlegen. Bitte addieren oder entfernen Sie Ihre Anforderungen.

 <?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 ,
    ]);
};

Bitte besuchen Sie RectorPHP für weitere Konfigurationsbeispiele.

Deinstallieren

Wenn Sie diese Erweiterung deinstallieren möchten, entfernen Sie zuerst Konfigurationsdateien: rector.php von Ihrer Anwendung.

Dann entfernen Sie die Packung:

 composer remove palpalani/grumphp-rector-task

Changelog

Weitere Informationen zu dem, was sich in letzter Zeit geändert hat, finden Sie in ChangeLog.

Beitragen

Weitere Informationen finden Sie unter Beitrag.

Sicherheitslücken

Bitte überprüfen Sie unsere Sicherheitsrichtlinien, wie Sie Sicherheitslücken melden können.

Versioning

Wir verwenden Semver für die Versionierung. Die verfügbaren Versionen finden Sie in den Tags in diesem Repository.

Credits

• Palpalani

Lizenz

Die MIT -Lizenz (MIT). Weitere Informationen finden Sie unter Lizenzdatei.

Todo

• Speicherbeschränkung hinzufügen
• Fügen Sie weitere Tests hinzu
• xdebug