rector.php

<?php

declare(strict_types=1);

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

use Rector\Caching\ValueObject\Storage\FileCacheStorage;
use Rector\CodeQuality\Rector\BooleanNot\NegatedAndsToPositiveOrsRector;
use Rector\CodeQuality\Rector\ClassMethod\LocallyCalledStaticMethodToNonStaticRector;
use Rector\CodeQuality\Rector\FuncCall\CompactToVariablesRector;
use Rector\CodeQuality\Rector\Isset_\IssetOnPropertyObjectToPropertyExistsRector;
use Rector\CodingStyle\Rector\ClassMethod\FuncGetArgsToVariadicParamRector;
use Rector\CodingStyle\Rector\ClassMethod\MakeInheritedMethodVisibilitySameAsParentRector;
use Rector\CodingStyle\Rector\FuncCall\VersionCompareFuncCallToConstantRector;
use Rector\Config\RectorConfig;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedConstructorParamRector;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector;
use Rector\DeadCode\Rector\MethodCall\RemoveNullArgOnNullDefaultParamRector;
use Rector\DeadCode\Rector\Property\RemoveDefaultValueFromAssignedPropertyRector;
use Rector\Php70\Rector\FuncCall\RandomFunctionRector;
use Rector\Php71\Rector\FuncCall\RemoveExtraParametersRector;
use Rector\Php80\Rector\Class_\ClassPropertyAssignToConstructorPromotionRector;
use Rector\PHPUnit\CodeQuality\Rector\Class_\YieldDataProviderRector;
use Rector\PHPUnit\CodeQuality\Rector\StmtsAwareInterface\DeclareStrictTypesTestsRector;
use Rector\Privatization\Rector\Class_\FinalizeTestCaseClassRector;
use Rector\Privatization\Rector\Property\PrivatizeFinalClassPropertyRector;
use Rector\Renaming\Rector\ConstFetch\RenameConstantRector;
use Rector\TypeDeclaration\Rector\ArrowFunction\AddArrowFunctionReturnTypeRector;
use Rector\TypeDeclaration\Rector\ClassMethod\AddMethodCallBasedStrictParamTypeRector;
use Rector\TypeDeclaration\Rector\ClassMethod\ReturnNeverTypeRector;
use Rector\TypeDeclaration\Rector\Closure\AddClosureVoidReturnTypeWhereNoReturnRector;
use Rector\TypeDeclaration\Rector\Closure\ClosureReturnTypeRector;
use Rector\TypeDeclaration\Rector\Function_\AddFunctionVoidReturnTypeWhereNoReturnRector;
use Rector\TypeDeclaration\Rector\Property\TypedPropertyFromAssignsRector;
use Rector\TypeDeclaration\Rector\StmtsAwareInterface\DeclareStrictTypesRector;
use Rector\TypeDeclaration\Rector\StmtsAwareInterface\SafeDeclareStrictTypesRector;
use Utils\Rector\PassStrictParameterToFunctionParameterRector;
use Utils\Rector\RemoveErrorSuppressInTryCatchStmtsRector;
use Utils\Rector\UnderscoreToCamelCaseVariableNameRector;

return RectorConfig::configure()
    ->withPhpSets(php82: true)
    ->withPreparedSets(deadCode: true, codeQuality: true, instanceOf: true, phpunitCodeQuality: true)
    ->withComposerBased(phpunit: true)
    ->withParallel(120, 8, 10)
    ->withCache(
        // Github action cache or local
        is_dir('/tmp') ? '/tmp/rector' : null,
        FileCacheStorage::class,
    )
    // paths to refactor; solid alternative to CLI arguments
    ->withPaths([
        __DIR__ . '/app',
        __DIR__ . '/system',
        __DIR__ . '/tests',
        __DIR__ . '/utils/src',
    ])
    ->withRootFiles()
    // do you need to include constants, class aliases or custom autoloader? files listed will be executed
    ->withBootstrapFiles([
        __DIR__ . '/phpstan-bootstrap.php',
    ])
    ->withPHPStanConfigs([
        __DIR__ . '/vendor/codeigniter/phpstan-codeigniter/extension.neon',
        __DIR__ . '/vendor/phpstan/phpstan-strict-rules/rules.neon',
        __DIR__ . '/vendor/shipmonk/phpstan-baseline-per-identifier/extension.neon',
        __DIR__ . '/phpstan.dist.neon',
    ])
    // is there a file you need to skip?
    ->withSkip([
        __DIR__ . '/structarmed-baseline.php',
        __DIR__ . '/system/Debug/Toolbar/Views/toolbar.tpl.php',
        __DIR__ . '/system/ThirdParty',
        __DIR__ . '/tests/system/Config/fixtures',
        __DIR__ . '/tests/system/Filters/fixtures',
        __DIR__ . '/tests/_support/Commands/Foobar.php',
        __DIR__ . '/tests/_support/View',
        __DIR__ . '/tests/system/View/Views',

        YieldDataProviderRector::class,

        RemoveUnusedPrivateMethodRector::class => [
            // private method called via getPrivateMethodInvoker
            __DIR__ . '/tests/_support/Test/TestForReflectionHelper.php',
        ],

        RemoveUnusedConstructorParamRector::class => [
            __DIR__ . '/system/HTTP/Response.php',
        ],

        // Keep property defaults for backward compatibility.
        RemoveDefaultValueFromAssignedPropertyRector::class,

        // Exclude test file because `is_cli()` is mocked and Rector might remove needed parameters.
        RemoveExtraParametersRector::class => [
            __DIR__ . '/tests/system/Debug/ToolbarTest.php',
        ],

        UnderscoreToCamelCaseVariableNameRector::class => [
            // session handlers have the gc() method with underscored parameter `$max_lifetime`
            __DIR__ . '/system/Session/Handlers',
            __DIR__ . '/tests/_support/Entity/CustomUser.php',
        ],

        DeclareStrictTypesRector::class => [
            __DIR__ . '/app',
            __DIR__ . '/system/CodeIgniter.php',
            __DIR__ . '/system/Config/BaseConfig.php',
            __DIR__ . '/system/Test/ControllerTestTrait.php',
            __DIR__ . '/system/View/Parser.php',
            __DIR__ . '/tests/system/Debug/ExceptionsTest.php',
        ],

        // use mt_rand instead of random_int on purpose on non-cryptographically random
        RandomFunctionRector::class,

        // PHP 8.0 features but cause breaking changes
        ClassPropertyAssignToConstructorPromotionRector::class => [
            __DIR__ . '/system/Database/BaseResult.php',
            __DIR__ . '/system/Database/RawSql.php',
            __DIR__ . '/system/Debug/BaseExceptionHandler.php',
            __DIR__ . '/system/Filters/Filters.php',
            __DIR__ . '/system/HTTP/CURLRequest.php',
            __DIR__ . '/system/HTTP/DownloadResponse.php',
            __DIR__ . '/system/Security/Security.php',
            __DIR__ . '/system/Session/Session.php',
        ],

        ReturnNeverTypeRector::class => [
            __DIR__ . '/system/CodeIgniter.php',
            __DIR__ . '/system/Database/MySQLi/Utils.php',
            __DIR__ . '/system/Database/OCI8/Utils.php',
            __DIR__ . '/system/Database/Postgre/Utils.php',
            __DIR__ . '/system/Database/SQLSRV/Utils.php',
            __DIR__ . '/system/Database/SQLite3/Utils.php',
            __DIR__ . '/system/HTTP/DownloadResponse.php',
            __DIR__ . '/system/HTTP/SiteURI.php',
        ],

        CompactToVariablesRector::class,

        // possibly isset() on purpose, on updated Config classes property across versions
        IssetOnPropertyObjectToPropertyExistsRector::class,

        // some tests extended by other tests
        FinalizeTestCaseClassRector::class,

        DeclareStrictTypesTestsRector::class => [
            __DIR__ . '/tests/system/Debug/ExceptionsTest.php',
        ],

        RemoveNullArgOnNullDefaultParamRector::class => [
            // skip form query usage, easier to read
            __DIR__ . '/system/Model.php',
            __DIR__ . '/tests/system/Database',
            __DIR__ . '/tests/system/Models',
        ],

        // to be applied in separate PRs to ease review
        NegatedAndsToPositiveOrsRector::class,
        SafeDeclareStrictTypesRector::class,
        LocallyCalledStaticMethodToNonStaticRector::class,
    ])
    // auto import fully qualified class names
    ->withImportNames()
    ->withRules([
        DeclareStrictTypesRector::class,
        UnderscoreToCamelCaseVariableNameRector::class,
        PassStrictParameterToFunctionParameterRector::class,
        RemoveErrorSuppressInTryCatchStmtsRector::class,
        FuncGetArgsToVariadicParamRector::class,
        MakeInheritedMethodVisibilitySameAsParentRector::class,
        PrivatizeFinalClassPropertyRector::class,
        VersionCompareFuncCallToConstantRector::class,
        AddClosureVoidReturnTypeWhereNoReturnRector::class,
        AddFunctionVoidReturnTypeWhereNoReturnRector::class,
        AddMethodCallBasedStrictParamTypeRector::class,
        TypedPropertyFromAssignsRector::class,
        ClosureReturnTypeRector::class,
        AddArrowFunctionReturnTypeRector::class,
    ])
    ->withConfiguredRule(RenameConstantRector::class, [
        'FILTER_DEFAULT' => 'FILTER_UNSAFE_RAW',
    ])
    ->reportUnusedSkips();