grumphp rector task

Задача ректора Grumphp

Этот пакет расширяет Grumphp с задачей, которая запускает RectorPhp для ваших проектов Laravel или любого приложения PHP.

Обратите внимание, что мы добавили --dry-run Option, поэтому исходный код никогда не изменялся.

Установка

Самый простой способ установить этот пакет - через композитор:

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

Конфигурация

Добавьте разгибательный погрузчик в свой grumphp.yml или grumphp.yml.dist . Задача живет в пространстве имен rector и имеет следующие настраиваемые параметры:

 # 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

По умолчанию это не обновляет ваш код, вам нужно сделать его вручную.

Whitelist_patterns

Default: []

Если вы хотите запустить только в определенных каталогах, укажите его с этой опцией.

конфигурация

Default: 'rector.php'

Если вы хотите использовать другой файл конфигурации, чем по умолчанию rector.php , вы можете указать местоположение файла конфигурации с этой опцией.

запускаемое_би

Default: [php]

В этой опции указывается, какие расширения файлов запустили эту задачу.

Чистое кеш

Default: false

Очистить кэш для уже проверенных файлов.

Без прогресса

Default: false

Скрыть планку прогресса. Полезно, например, для более хорошего вывода CI.

files_on_pre_commit

Default: false

Эта опция позволяет использовать измененные файлы в качестве путей во время предварительных обязательств. Он будет использовать опцию Paths, чтобы убедиться, что подтверждены только совершенные файлы, соответствующие пути.

no_diff

Default: false

Образец конфигурации RectorPhp

Создайте rector.php в вашем проекте root и настройте следующее. Этот пример файла IAM использует для моего проекта Laravel, но вы можете использовать библиотеку с любым проектом PHP. Также вам не нужно устанавливать все эти настройки, добавьте или удалите в соответствии с вашими требованиями.

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

Пожалуйста, посетите RectorPhp для получения дополнительных примеров конфигурации.

Удалить

Если вы хотите удалить это расширение, сначала удалите файлы конфигурации: rector.php из вашего приложения.

Затем удалите пакет:

 composer remove palpalani/grumphp-rector-task

Изменение

Пожалуйста, смотрите ChangeLog для получения дополнительной информации о том, что изменилось в последнее время.

Внося

Пожалуйста, смотрите для получения подробной информации.

Уязвимости безопасности

Пожалуйста, просмотрите нашу политику безопасности о том, как сообщать о уязвимости безопасности.

Версии

Мы используем SEMVER для управления версиями. Для доступных версий см. Теги в этом репозитории.

Кредиты

• Палпалани

Лицензия

Лицензия MIT (MIT). Пожалуйста, смотрите файл лицензии для получения дополнительной информации.

Тодо

• Добавьте ограничение памяти
• Добавьте больше тестов
• xdebug