grumphp rector task

Tugas Rektor Grumphp

Paket ini memperluas grumphp dengan tugas yang menjalankan RectorPHP untuk proyek Laravel Anda atau aplikasi PHP apa pun.

Perhatikan bahwa kami telah menambahkan --dry-run , sehingga kode sumber tidak pernah berubah.

Instalasi

Cara termudah untuk menginstal paket ini adalah melalui komposer:

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

Konfigurasi

Tambahkan loader ekstensi ke grumphp.yml atau grumphp.yml.dist . Tugas hidup di bawah rector Namespace dan memiliki parameter yang dapat dikonfigurasi:

 # 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

Secara default, ini tidak akan memperbarui kode Anda, Anda perlu melakukannya secara manual.

whitelist_patterns

Default: []

Jika Anda ingin menjalankan direktori tertentu saja, tentukan dengan opsi ini.

konfigurasi

Default: 'rector.php'

Jika Anda ingin menggunakan file konfigurasi yang berbeda dari rector.php default, Anda dapat menentukan lokasi file konfigurasi khusus Anda dengan opsi ini.

dipicu_by

Default: [php]

Opsi ini akan menentukan ekstensi file mana yang akan memicu tugas ini.

Clear-Cache

Default: false

Hapus cache untuk file yang sudah diperiksa.

no-progress-bar

Default: false

Sembunyikan Progress Bar. EG yang berguna untuk output CI yang lebih bagus.

file_on_pre_commit

Default: false

Opsi ini memungkinkan untuk menggunakan file yang diubah sebagai jalur selama pra-komit. Ini akan menggunakan opsi PATHS untuk memastikan hanya file berkomitmen yang cocok dengan jalur yang divalidasi.

no_diff

Default: false

Contoh Konfigurasi RektorPHP

Buat rector.php di root proyek Anda dan konfigurasikan sebagai berikut. File contoh ini digunakan untuk proyek Laravel saya, tetapi Anda dapat menggunakan perpustakaan dengan proyek PHP apa pun. Anda juga tidak perlu mengatur semua pengaturan ini, silakan tambahkan atau hapus sesuai kebutuhan Anda.

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

Silakan kunjungi RectorPHP untuk lebih banyak contoh konfigurasi.

Uninstall

Jika Anda ingin menghapus instalan ekstensi ini, hapus file konfigurasi terlebih dahulu: rector.php dari aplikasi Anda.

Kemudian hapus paket:

 composer remove palpalani/grumphp-rector-task

Changelog

Silakan lihat Changelog untuk informasi lebih lanjut tentang apa yang telah berubah baru -baru ini.

Berkontribusi

Silakan lihat berkontribusi untuk detailnya.

Kerentanan keamanan

Harap tinjau kebijakan keamanan kami tentang cara melaporkan kerentanan keamanan.

Versi

Kami menggunakan SEMVER untuk versi. Untuk versi yang tersedia, lihat tag di repositori ini.

Kredit

• Palpalani

Lisensi

Lisensi MIT (MIT). Silakan lihat file lisensi untuk informasi lebih lanjut.

Todo

• Tambahkan pembatasan memori
• Tambahkan lebih banyak tes
• xdebug