grumphp rector task

GrumphP校长任务

该软件包通过为您的Laravel项目或任何PHP应用程序运行RectorPHP的任务扩展了GrumPHP。

请注意，我们添加了--dry-run选项，因此源代码从未更改。

安装

安装此软件包的最简单方法是通过作曲家：

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

config

将扩展装载机添加到您的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: []

如果您只想在特定目录上运行，请使用此选项指定。

config

Default: 'rector.php'

如果要使用与默认rector.php不同的配置文件，则可以使用此选项指定自定义配置文件位置。

triggered_by

Default: [php]

此选项将指定哪些文件扩展名将触发此任务。

清除调查

Default: false

清除已检查文件的缓存。

没有螺旋杆

Default: false

隐藏进度栏。有用的CI输出。

files_on_pre_commit

Default: false

此选项使得在预设期间将更改的文件用作路径是可能的。它将使用“路径”选项来确保仅匹配路径的固定文件经过验证。

no_diff

Default: false

样本RectorPHP配置

在您的项目root中创建rector.php ，并如下配置。此示例文件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

有关最近发生了变化的更多信息，请参见ChangElog。

贡献

请有关详细信息，请参阅贡献。

安全漏洞

请查看我们有关如何报告安全漏洞的安全政策。

版本控制

我们使用SEMVER进行版本控制。有关可用的版本，请参见此存储库上的标签。

学分

• 帕尔帕拉尼

执照

麻省理工学院许可证（麻省理工学院）。请参阅许可证文件以获取更多信息。

托多

• 添加内存限制
• 添加更多测试
• xdebug