Rector

https://getrector.com/documentation
Admin
Rector is an open-source PHP tool that automates code upgrades and refactoring, helping developers...
Tokens:22,676
Snippets:245
Trust Score:8.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Output: Composer package bound rules table

Source: https://getrector.com/documentation/composer-based-sets

Example output showing the table of composer-bound rules with columns for rule, package, required version, installed version, and active status.

```text
Composer package bound rules
============================

 ------------------------------------------------- ----------------- ---------- ----------- --------
  Rule                                              Package           Requires   Installed   Active
 ------------------------------------------------- ----------------- ---------- ----------- --------
  AnnotationWithValueToAttributeRector              phpunit/phpunit   >=10.0     13.2.6.0    yes
  BareCreateMockAssignToDirectUseRector             phpunit/phpunit   >=11.0     13.2.6.0    yes
  CreateStubOverCreateMockArgRector                 phpunit/phpunit   >=11.0     13.2.6.0    yes
  RemoveOverrideFinalConstructTestCaseRector        phpunit/phpunit   >=12.0.3   13.2.6.0    yes
 ------------------------------------------------- ----------------- ---------- ----------- --------


```

--------------------------------

### rector.php configuration with paths and type coverage level

Source: https://getrector.com/documentation

Example rector.php configuration file. Defines paths to process and sets the type coverage level to 0. Start small and increase the level by one each run.

```php
<?php

use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withPaths([
        __DIR__ . '/src',
        __DIR__ . '/tests',
    ])
    ->withTypeCoverageLevel(0);
```

--------------------------------

### Install Easy Coding Standard

Source: https://getrector.com/documentation/integration-to-new-project

Install Easy Coding Standard as a dev dependency. Run this before using Rector to fix formatting issues introduced by Rector's code printing.

```bash
composer require --dev symplify/easy-coding-standard

```

--------------------------------

### Run Rector with --xdebug option

Source: https://getrector.com/documentation/debugging

Run Rector with the --xdebug option, which requires Xdebug to be installed and enabled. This example also uses --dry-run to preview changes without applying them.

```bash
vendor/bin/rector process src/Controller --dry-run --xdebug

```

--------------------------------

### Output: Composer package bound rule configuration table

Source: https://getrector.com/documentation/composer-based-sets

Example output showing the table of rule configurations with the configuration printed below each row, and a note about active items.

```text
Composer package bound rule configuration
=========================================

 -------------------------------------- ----------------- -------------- ----------- --------
  Rule                                   Package           Requires       Installed   Active
 -------------------------------------- ----------------- -------------- ----------- --------
  AnnotationToAttributeRector            phpunit/phpunit   >=10.0 <13.0   13.2.6.0    no
  AnnotationToAttribute(runClassInSeparateProcess,
  PHPUnit\Framework\Attributes\RunClassInSeparateProcess, [], false)
 -------------------------------------- ----------------- -------------- ----------- --------
  RenameMethodRector                     phpunit/phpunit   >=8.3          13.2.6.0    yes
  MethodCallRename(PHPUnit\Framework\MockObject\MockBuilder, setMethods, onlyMethods)
 -------------------------------------- ----------------- -------------- ----------- --------

 ! [NOTE] 32 of 33 composer package bound items are active


```

--------------------------------

### Configure Rector with prepared sets

Source: https://getrector.com/documentation/set-lists

Use withPreparedSets to enable a group of rules focused on a topic. This enables every rule in the set at once. On existing projects, start with levels instead and switch to the set once the level covers it.

```php
<?php

use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withPreparedSets(
        deadCode: true,
        codeQuality: true,
        codingStyle: true,
        naming: true,
        privatization: true,
        typeDeclarations: true,
        rectorPreset: true,
        // ...
    );

```

--------------------------------

### Install Swiss Knife with Composer

Source: https://getrector.com/documentation/swiss-knife

Install the Swiss Knife package via Composer. It requires PHP 7.2+ and can be installed on any legacy project.

```bash
composer require rector/swiss-knife --dev

```

--------------------------------

### Example of set* to change* Method Call Transformation

Source: https://getrector.com/documentation/custom-rule

Shows the before and after of the desired transformation: changing a method call from set* to change*. The minus line is the original code and the plus line is the expected result.

```php
<?php

$user = new User();
-$user->setPassword('123456');
+$user->changePassword('123456');

```

--------------------------------

### Configure PHP upgrade level with withPhpLevel()

Source: https://getrector.com/documentation/levels

Start with level 0 for PHP upgrade sets. Rector only adds rules up to the PHP version in composer.json.

```php
<?php

use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
    ->withPhpLevel(0);

```

--------------------------------

### Install Rector with Composer

Source: https://getrector.com/documentation

Install Rector as a dev dependency using Composer. Requires PHP 7.2+.

```bash
composer require rector/rector --dev
```

--------------------------------

### Install PHPStan

Source: https://getrector.com/documentation/integration-to-new-project

Install PHPStan as a dev dependency. Remove any PHPStan baseline and reach level 3-4 without baseline to ensure Rector can see types clearly.

```bash
composer require --dev phpstan/phpstan

```

--------------------------------

### RenameClassRector Transformation Example

Source: https://getrector.com/documentation/configured-rules

Shows the expected transformation when RenameClassRector is applied: the use statement and instantiation are updated from the old class to the new class.

```diff
-use App\SomeOldClass;
+use App\SomeNewClass;

-$value = new App\SomeOldClass();
+$value = new App\SomeNewClass();

```

--------------------------------

### Bind rule configuration with ruleWithConfigurationComposerVersionBound()

Source: https://getrector.com/documentation/composer-based-custom-set

Use ruleWithConfigurationComposerVersionBound() in a set file to bind rule configuration to a package version. The arguments are the rule class, its configuration, the package name, and the version constraint. If the installed version does not satisfy the constraint, the configuration is not registered at all, but it is still reported by vendor/bin/rector composer-based as inactive.

```php
use Rector\Config\RectorConfig;
use Rector\Renaming\Rector\MethodCall\RenameMethodRector;
use Rector\Renaming\ValueObject\MethodCallRename;

return static function (RectorConfig $rectorConfig): void {
    // MockBuilder::onlyMethods() was added in PHPUnit 8.3
    $rectorConfig->ruleWithConfigurationComposerVersionBound(RenameMethodRector::class, [
        new MethodCallRename('PHPUnit\Framework\MockObject\MockBuilder', 'setMethods', 'onlyMethods'),
    ], 'phpunit/phpunit', '>=8.3');

    // expectExceptionMessageIsOrContains() was added in PHPUnit 13.2
    $rectorConfig->ruleWithConfigurationComposerVersionBound(RenameMethodRector::class, [
        new MethodCallRename(
            'PHPUnit\Framework\TestCase',
            'expectExceptionMessage',
            'expectExceptionMessageIsOrContains'
        ),
    ], 'phpunit/phpunit', '>=13.2');
};

```

--------------------------------

### Import Names Example: FQN to Short Class

Source: https://getrector.com/documentation/import-names

Shows the transformation Rector performs when import names is enabled: a fully qualified class name is replaced with a short name and a use statement is added.

```php
<?php

+use App\Some\Namespace\SomeClass;

-$object = new \App\Some\Namespace\SomeClass();
+$object = new SomeClass();

```

--------------------------------

### Configure withAutoloadPaths for static reflection

Source: https://getrector.com/documentation/static-reflection-and-autoload

Configure Rector to discover files or directories without relying on Composer autoload. Useful for legacy projects or custom autoload setups.

```php
<?php

use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withAutoloadPaths([
        // discover specific file
        __DIR__ . '/file-with-functions.php',
        // or full directory
        __DIR__ . '/project-without-composer',
    ]);

```

--------------------------------

### Import Single Short Classes Example

Source: https://getrector.com/documentation/import-names

Shows that single short classes are also imported: the fully qualified DateTime is replaced with a short name and a use statement is added.

```php
<?php

+use DateTime;
-$someClass = \DateTime();
+$someClass = DateTime();

```

--------------------------------

### Example of an Expr part of assign

Source: https://getrector.com/documentation/creating-node-visitor

Shows a simple PHP assignment where the value is an integer literal. This is the motivating example for adding an attribute to nodes that are part of an assignment.

```php
$value = 100;

```

--------------------------------

### Use type coverage level with withTypeCoverageLevel()

Source: https://getrector.com/documentation/levels

Use the level instead of the full set to start with the safest rules. This is the after state.

```php
 return RectorConfig::configure()
     ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
-    ->withPreparedSets(typeDeclarations: true);
+    ->withTypeCoverageLevel(0);

```

--------------------------------

### Rector configuration with ExceptionAnnotationRector and RenameMethodRector

Source: https://getrector.com/documentation/how-rector-works

Example configuration that first converts @expectedException annotations to methods, then renames setExpectedException to expectedException. Demonstrates the order of Rectors in the config.

```php
<?php

use Rector\PHPUnit\Rector\ClassMethod\ExceptionAnnotationRector;
use Rector\Renaming\Rector\MethodCall\RenameMethodRector;
use Rector\Config\RectorConfig;
use Rector\Renaming\ValueObject\MethodCallRename;

return RectorConfig::configure()
    ->withRules([ExceptionAnnotationRector::class])
    ->withConfiguredRule(Rector\Renaming\Rector\MethodCall\RenameMethodRector::class, [
        new MethodCallRename('PHPUnit\Framework\TestClass', 'setExpectedException', 'expectedException'),
        new MethodCallRename('PHPUnit\Framework\TestClass', 'setExpectedExceptionRegExp', 'expectedException'),
    ]);
```

--------------------------------

### Use community or custom sets with withSets

Source: https://getrector.com/documentation/set-lists

Use withSets to include community sets or custom set files. This example includes the Doctrine code quality set and a custom set file.

```php
<?php

use Rector\Config\RectorConfig;
use Rector\Doctrine\Set\DoctrineSetList;

return RectorConfig::configure()
    ->withSets([
        DoctrineSetList::DOCTRINE_CODE_QUALITY,
        __DIR__.'/config/rector-custom-set.php'
    ]);

```

--------------------------------

### Configure indentation with withIndent()

Source: https://getrector.com/documentation/config-configuration

Override the default formatting (4 spaces and UNIX newlines) by setting the indent character and size. This example uses a space with size 4.

```php
use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withIndent(indentChar: ' ', indentSize: 4);

```

--------------------------------

### Warning output for unused skip

Source: https://getrector.com/documentation/reporting-unused-skips

Example warning message printed when a skip never matches any file. It shows the full rule => path so you know exactly what to remove.

```text
 [WARNING] This skip is unused, it never matched any element. You can remove it
           from "->withSkip()"

 * Rector\CodeQuality\Rector\FunctionLike\SimplifyUselessVariableRector => /src/NeverMatches.php
```

--------------------------------

### Register a Configurable Rule with withConfiguredRule

Source: https://getrector.com/documentation/configured-rules

Registers a configurable rule by passing the rule class and an array of configuration options. The example shows RenameClassRector mapping the old class name to the new one.

```php
<?php

use Rector\Renaming\Rector\Name\RenameClassRector;
use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withConfiguredRule(RenameClassRector::class, [
        'App\SomeOldClass' => 'App\SomeNewClass',
    ]);

```

--------------------------------

### Enable reportUnusedSkips() in rector.php

Source: https://getrector.com/documentation/reporting-unused-skips

Enable unused skip reporting by calling ->reportUnusedSkips() in your RectorConfig. Skips that never match a file are reported as warnings. In this example, the skip for NeverMatches.php will be reported.

```php
<?php

use Rector\Config\RectorConfig;
use Rector\CodeQuality\Rector\FunctionLike\SimplifyUselessVariableRector;

return RectorConfig::configure()
    ->withRules([SimplifyUselessVariableRector::class])
    ->reportUnusedSkips()
    ->withSkip([
        SimplifyUselessVariableRector::class => [
            __DIR__ . '/src/Used.php',         // matched → not reported
            __DIR__ . '/src/NeverMatches.php', // never matched → reported
        ],
    ]);
```

--------------------------------

### Composer PHP Version Constraint

Source: https://getrector.com/documentation/integration-to-new-project

Example composer.json snippet showing the PHP version constraint. This is used to determine the lowest PHP version the codebase can use.

```json
{
    "require": {
        "php": "^7.4"
    }
}

```

--------------------------------

### Enable composer-based sets for Twig, Doctrine, PHPUnit, and Symfony

Source: https://getrector.com/documentation/composer-based-sets

Use withComposerBased with named arguments to automatically load relevant sets for the specified packages based on installed versions. Rector reads versions from vendor/composer/installed.json and falls back to composer.json require and require-dev sections.

```php
use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withComposerBased(twig: true, doctrine: true, phpunit: true, symfony: true);

```

--------------------------------

### Upgrade from withSets to withPhpSets with named arguments

Source: https://getrector.com/documentation/set-lists

On PHP 8+, you can use withPhpSets() with named arguments to upgrade to a desired PHP version in a single line. This example shows the change from withSets([SetList::PHP_74]) to withPhpSets(php80: true).

```php
-   ->withSets([SetList::PHP_74]);
+   ->withPhpSets(php80: true);

```

--------------------------------

### MyFirstRector Class Extending AbstractRector

Source: https://getrector.com/documentation/custom-rule

Defines a custom Rector class that extends AbstractRector. It targets MethodCall nodes and renames methods starting with 'set' to 'change' using preg_replace. Returns null to skip nodes that do not match, and returns the modified node when changed.

```php
<?php

namespace Utils\Rector\Rector;

use PhpParser\Node;
use PhpParser\Node\Identifier;
use PhpParser\Node\Expr\MethodCall;
use Rector\Rector\AbstractRector;

final class MyFirstRector extends AbstractRector
{
    /**
     * @return array<class-string<Node>>
     */
    public function getNodeTypes(): array
    {
        // what node types are we looking for?
        // pick from
        // https://github.com/rectorphp/php-parser-nodes-docs/
        return [MethodCall::class];
    }

    /**
     * @param MethodCall $node
     */
    public function refactor(Node $node): ?Node
    {
        $methodCallName = $this->getName($node->name);
        if ($methodCallName === null) {
            return null;
        }

        // we only care about "set*" method names
        if (! str_starts_with($methodCallName, 'set')) {
            // return null to skip it
            return null;
        }

        $newMethodCallName = preg_replace(
            '#^set#', 'change', $methodCallName
        );

        $node->name = new Identifier($newMethodCallName);

        // return $node if you modified it
        return $node;
    }
}

```

--------------------------------

### Apply changes with process command

Source: https://getrector.com/documentation

Run the bare process command to apply the suggested changes.

```bash
vendor/bin/rector process
```

--------------------------------

### Include root files with withRootFiles()

Source: https://getrector.com/documentation/config-configuration

Include all *.php files from the root directory by adding withRootFiles() after withPaths().

```php
use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withPaths([
        __DIR__ . '/src',
    ])
    ->withRootFiles();

```

--------------------------------

### First run with config generation prompt

Source: https://getrector.com/documentation

First run of Rector without a config file. It prompts to generate rector.php and confirms the config is added.

```bash
vendor/bin/rector

 No "rector.php" config found. Should we generate it for you? [yes]:
 > yes


 [OK] The config is added now. Re-run command to make Rector do the work!
```

--------------------------------

### Override provideComposerJsonFilePath() with standalone composer.json

Source: https://getrector.com/documentation/composer-based-custom-set

Override provideComposerJsonFilePath() in a Rector test case to point to a standalone composer.json. The versions are then read from its require and require-dev sections, instead of from the installed packages. This allows testing the rule against a version you don't have installed.

```php
use Rector\Testing\PHPUnit\AbstractRectorTestCase;

final class CreateStubOverCreateMockArgRectorTest extends AbstractRectorTestCase
{
    protected function provideComposerJsonFilePath(): ?string
    {
        return __DIR__ . '/composer.json';
    }

    // ...
}

```

```json
{
    "require-dev": {
        "phpunit/phpunit": "^11.0"
    }
}

```

--------------------------------

### Check attribute in a Rector rule

Source: https://getrector.com/documentation/creating-node-visitor

Example of how to check the attribute set by the visitor inside a Rector rule's refactor method.

```php
final class SomeRector extends AbstractRector
{
    public function refactor(Node $node): ?Node
    {
        if ($node->getAttribute(AssignAwareNodeVisitor::IS_PART_OF_ASSIGN)) {
            // we know node is part of assign
        }

        // ...

        return null;
    }
}

```

--------------------------------

### Configure withBootstrapFiles for custom autoload

Source: https://getrector.com/documentation/static-reflection-and-autoload

Include constants, class aliases, or custom autoloaders via bootstrap files. The listed files are executed using include $filePath.

```php
<?php

use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withBootstrapFiles([
        __DIR__ . '/constants.php',
        __DIR__ . '/project/special/autoload.php',
    ]);

```

```php
include $filePath;

```

--------------------------------

### Run Rector process command

Source: https://getrector.com/documentation/cli-options

Shows the two equivalent ways to run Rector's default `process` command on the `src` directory. The `process` subcommand is optional because it is the default.

```bash
vendor/bin/rector process src
vendor/bin/rector src
```

--------------------------------

### Configure File Extensions with withFileExtensions

Source: https://getrector.com/documentation/config-configuration

Adds .phtml files to the list of file extensions Rector processes. By default, only .php files are processed.

```php
use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withFileExtensions(['php', 'phtml']);
```

--------------------------------

### Run Rector from bin directory

Source: https://getrector.com/documentation

Run Rector from the bin directory. If no rector.php config is found, Rector will prompt to generate one.

```bash
vendor/bin/rector
```

--------------------------------

### Enable full type declarations set with withPreparedSets()

Source: https://getrector.com/documentation/levels

The full type declarations set changes almost every file. This is the before state before switching to the level.

```php
 return RectorConfig::configure()
     ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
+    ->withPreparedSets(typeDeclarations: true);

```

--------------------------------

### Run tests with vendor/bin/phpunit

Source: https://getrector.com/documentation/custom-rule

Command to run the tests for the custom rule using PHPUnit.

```bash
vendor/bin/phpunit tests
```

--------------------------------

### Combine multiple patterns with AND logic

Source: https://getrector.com/documentation/filter-files

Pass a comma-separated list to require all patterns at once. This keeps only *Test.php files that live under a /tests/ path.

```bash
vendor/bin/rector process src --filter="/tests/,*Test.php"
```

--------------------------------

### Enable per-line fluent call output with withFluentCallNewLine

Source: https://getrector.com/documentation/config-configuration

Enables per-line method call output for fluent calls.

```php
use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withFluentCallNewLine();

```

--------------------------------

### Preview changes with --dry-run

Source: https://getrector.com/documentation

Run the process command with the --dry-run option to preview suggested changes without applying them.

```bash
vendor/bin/rector process --dry-run
```

--------------------------------

### Run Rector with custom config file

Source: https://getrector.com/documentation/config-configuration

Use this command to run Rector with a custom configuration file instead of the default rector.php in the project root.

```bash
vendor/bin/rector process --config rector-custom-config.php

```

--------------------------------

### Equivalent path substring and glob patterns

Source: https://getrector.com/documentation/filter-files

A glob containing a '/' is matched against the full path, so these two commands are equivalent.

```bash
vendor/bin/rector process src --filter="/Controller/"
```

```bash
vendor/bin/rector process src --filter="*/Controller/*"
```

--------------------------------

### Run the composer-based command

Source: https://getrector.com/documentation/composer-based-sets

Executes the `composer-based` command to list composer-bound rules and their active status.

```bash
vendor/bin/rector composer-based

```

--------------------------------

### Set paths to process with withPaths()

Source: https://getrector.com/documentation/config-configuration

Define which directories or files Rector should refactor by passing an array of paths to withPaths().

```php
<?php

use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withPaths([
        __DIR__ . '/src',
        __DIR__ . '/tests',
        __DIR__ . '/packages/Domain',
    ]);

```

--------------------------------

### Register class in composer.json files and dump autoload

Source: https://getrector.com/documentation/static-reflection-and-autoload

Add the class file to composer.json's "files" config under autoload-dev, then dump the autoloader and re-run Rector.

```json
{
    "autoload-dev": {
        "files": [
            "vendor/acme/my-custom-dependency/src/Your/Own/Namespace/TheAffectedClass.php"
        ]
    }
}

```

```bash
composer dump-autoload

```

--------------------------------

### Rector Config with withPhpLevel(1)

Source: https://getrector.com/documentation/integration-to-new-project

Rector configuration diff showing how to replace withPhpSets() with withPhpLevel(1) to apply only the first rule from the PHP sets.

```php
 <?php

 use Rector\Config\RectorConfig;

 return RectorConfig::configure()
     ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
-    ->withPhpSets();
+    ->withPhpLevel(1);

```

--------------------------------

### Rector Config with withPhpLevel(2)

Source: https://getrector.com/documentation/integration-to-new-project

Rector configuration diff showing how to raise the PHP level from 1 to 2 after the previous level is merged.

```php
 <?php

 use Rector\Config\RectorConfig;

 return RectorConfig::configure()
     ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
-    ->withPhpLevel(1);
+    ->withPhpLevel(2);

```

--------------------------------

### Register Multiple Rules Mixing Configured and Non-Configured

Source: https://getrector.com/documentation/configured-rules

Combines a configurable rule (RenameClassRector) with a non-configurable rule (ClassPropertyAssignToConstructorPromotionRector) in a single Rector configuration. Use withConfiguredRule() for each configured rule and withRules() for the rest.

```php
<?php

use Rector\Renaming\Rector\Name\RenameClassRector;
use Rector\Php80\Rector\Class_\ClassPropertyAssignToConstructorPromotionRector;
use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withConfiguredRule(RenameClassRector::class, [
        'App\SomeOldClass' => 'App\SomeNewClass',
    ])
    ->withRules([
        ClassPropertyAssignToConstructorPromotionRector::class,
    ]);

```

--------------------------------

### Configure dead code, code quality, and coding style levels

Source: https://getrector.com/documentation/levels

After reaching high type coverage, use these levels to incrementally apply rules for dead code removal, code quality, and coding style.

```php
return RectorConfig::configure()
    ->withDeadCodeLevel(0)
    ->withCodeQualityLevel(0)
    ->withCodingStyleLevel(0);

```

--------------------------------

### Register class path with withAutoloadPaths

Source: https://getrector.com/documentation/static-reflection-and-autoload

Register the path to the affected class or a wider scope to resolve the 'Class ... was not found' error. Narrow the path to avoid performance slowdowns.

```php
<?php

use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withAutoloadPaths([
        // the path to the exact class file
        __DIR__ . '/vendor/acme/my-custom-dependency/src/Your/Own/Namespace/TheAffectedClass.php',
        // or you can specify a wider scope
        __DIR__ . '/vendor/acme/my-custom-dependency/src',
        // WARNING: beware of performances, try to narrow down the path
        //          as much as you can or you will slow down each run
    ]);

```

--------------------------------

### Fixture/test_fixture.php.inc - Before/after test fixture

Source: https://getrector.com/documentation/custom-rule

Fixture file with before and after code separated by '-----'. The test runs the rule on the before part and asserts the result matches the after part.

```php
<?php

namespace Utils\Rector\Tests\Rector\MyFirstRector\Fixture;

class SomeClass
{
    public function handlePasswordChange(User $user, string $password)
    {
        $user->setPassword($password);
    }
}

?>
-----
<?php

namespace Utils\Rector\Tests\Rector\MyFirstRector\Fixture;

class SomeClass
{
    public function handlePasswordChange(User $user, string $password)
    {
        $user->changePassword($password);
    }
}

?>

```

--------------------------------

### MyFirstRectorTest.php - Test class for custom Rector rule

Source: https://getrector.com/documentation/custom-rule

Test class for a custom Rector rule. Extends AbstractRectorTestCase, uses a DataProvider to run each fixture file, and provides the config file path for the test.

```php
<?php

declare(strict_types=1);

namespace Utils\Rector\Tests\Rector\MyFirstRector;

use Iterator;
use PHPUnit\Framework\Attributes\DataProvider;
use Rector\Testing\PHPUnit\AbstractRectorTestCase;

final class MyFirstRectorTest extends AbstractRectorTestCase
{
    #[DataProvider('provideData')]
    public function test(string $filePath): void
    {
        $this->doTestFile($filePath);
    }

    public static function provideData(): Iterator
    {
        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
    }

    public function provideConfigFilePath(): string
    {
        return __DIR__ . '/config/config.php';
    }
}

```

--------------------------------

### Enable composer-based sets for all available packages

Source: https://getrector.com/documentation/composer-based-sets

Use named arguments to enable composer-based sets for all supported packages: twig, doctrine, phpunit, symfony, laravel, and drupal. This limits the run to the specified groups.

```php
use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withComposerBased(
        twig: true,
        doctrine: true,
        phpunit: true,
        symfony: true,
        laravel: true,
        drupal: true,
    );

```

--------------------------------

### Configure Parallel Execution with withParallel and withoutParallel

Source: https://getrector.com/documentation/config-configuration

Tunes parallel execution settings or disables it entirely. Rector runs in parallel by default.

```php
use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withParallel(timeoutSeconds: 120, maxNumberOfProcess: 32, jobSize: 16);
    // or
    ->withoutParallel();
```

--------------------------------

### Skip paths and files with withSkip()

Source: https://getrector.com/documentation/config-configuration

Exclude directories, files, or patterns from processing using withSkip(). Accepts absolute paths, single files, and * masks.

```php
use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withPaths([
        __DIR__ . '/src',
    ])
    ->withSkip([
        // skip an exact directory
        __DIR__ . '/src/Legacy',

        // skip a single file
        __DIR__ . '/src/Bootstrap/container.php',

        // skip any "Fixture" directory, anywhere in the paths
        '*/Fixture/*',

        // skip files by name mask
        '*/*.generated.php',
    ]);

```

--------------------------------

### Configure docblock type coverage level with withTypeCoverageDocblockLevel()

Source: https://getrector.com/documentation/levels

Since Rector 2.2, a second level for docblock types like @param, @return, and @var where native type hints are not possible.

```php
return RectorConfig::configure()
    ->withTypeCoverageLevel(0)
    ->withTypeCoverageDocblockLevel(0);

```

--------------------------------

### Enable Import Names in rector.php

Source: https://getrector.com/documentation/import-names

Enables import names in rector.php. This configuration makes Rector replace fully qualified class names with short names and add use statements.

```php
<?php

use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withImportNames();

```

--------------------------------

### Run Rector Process on src

Source: https://getrector.com/documentation/custom-rule

Runs Rector on the src directory. First use --dry-run to see the diff, then run without it to apply the changes.

```bash
# see the diff first
vendor/bin/rector process src --dry-run

# if it's ok, apply
vendor/bin/rector process src

```

--------------------------------

### Fixture/skip_rule_test_fixture.php.inc - Skip test fixture

Source: https://getrector.com/documentation/custom-rule

Fixture file with only a before snippet (no '-----'). The test runs the rule and asserts no changes are applied.

```php
<?php

namespace Utils\Rector\Tests\Rector\MyFirstRector\Fixture;

class SomeClass
{
    public function handleLogin(User $user, string $password)
    {
        return $user->isCorrectPassword($password);
    }
}

?>

```

--------------------------------

### Use PHP sets with automatic version detection

Source: https://getrector.com/documentation/set-lists

Rector automatically picks up the PHP version from composer.json when using withPhpSets(). For legacy projects, prefer withPhpLevel() over the full set and raise it one step at a time.

```php
<?php

use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withPhpSets();

```

--------------------------------

### Rector Config with withPhpSets()

Source: https://getrector.com/documentation/integration-to-new-project

Rector configuration that applies all PHP sets up to the version in composer.json. This is not recommended because it applies over 100 rules at once.

```php
<?php

use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
    ->withPhpSets();

```

--------------------------------

### Rector file processing lifecycle with PhpRectorInterface

Source: https://getrector.com/documentation/how-rector-works

Shows the main loop that parses each file into nodes and applies matching Rectors via refactor(). Use when extending Rector or understanding its core iteration.

```php
<?php

use Rector\Contract\Rector\PhpRectorInterface;
use PhpParser\Parser;

/** @var SplFileInfo[] $fileInfos */
foreach ($fileInfos as $fileInfo) {
    // 1 file => nodes
    /** @var Parser $phpParser */
    $nodes = $phpParser->parse(file_get_contents($fileInfo->getRealPath()));

    // nodes => 1 node
    foreach ($nodes as $node) { // rather traverse all of them
        /** @var PhpRectorInterface[] $rectors */
        foreach ($rectors as $rector) {
            foreach ($rector->getNodeTypes() as $nodeType) {
                if (is_a($node, $nodeType, true)) {
                    $rector->refactor($node);
                }
            }
        }
    }
}
```

--------------------------------

### Set Rector cache directory

Source: https://getrector.com/documentation/run-in-ci

Configure a stable cache directory for Rector in CI. The default path may vary per OS, so set it explicitly to keep it the same on CI and development.

```php
<?php

use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withCache(
        // a path that works locally as well as on CI job runners
        cacheDirectory: '/tmp/rector'
    );

```

--------------------------------

### Register the visitor in rector.php

Source: https://getrector.com/documentation/creating-node-visitor

Configuration to register the custom node visitor using the registerDecoratingNodeVisitor method in the RectorConfig.

```php
<?php

use Rector\Config\RectorConfig;
use My\Rector\Visitor\AssignAwareNodeVisitor;

return RectorConfig::configure()
    ->registerDecoratingNodeVisitor(AssignAwareNodeVisitor::class);

```

--------------------------------

### Set PHP Version in composer.json

Source: https://getrector.com/documentation/config-configuration

Shows the composer.json snippet that Rector uses to detect the PHP version. This is the recommended way to set the PHP version.

```json
{
    "require": {
        "php": "^7.4"
    }
}
```

--------------------------------

### Enable all attribute sets with withAttributesSets()

Source: https://getrector.com/documentation/attributes

Configures Rector to automatically upgrade annotations to attributes for all attribute classes found in /vendor. Requires PHP 8.0 in composer.json; on PHP 7 the sets do nothing.

```php
<?php

use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withAttributesSets();


```

--------------------------------

### Customize Cache Directory with withCache

Source: https://getrector.com/documentation/config-configuration

Customizes the cache directory. By default, Rector uses sys_get_temp_dir() . '/rector_cached_files'.

```php
use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withCache(__DIR__ . '/var/rector');
```

--------------------------------

### Load PHPStan extension configs with withPHPStanConfigs

Source: https://getrector.com/documentation/config-configuration

Loads PHPStan extension configs when needed for specific Rector rules. Rector loads phpstan.neon and phpstan.neon.dist by default, but extensions are ignored on purpose.

```php
use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withPHPStanConfigs([
        __DIR__ . '/config/custom-phpstan-extension.neon',
    ]);

```

--------------------------------

### Skip a rule for specific files

Source: https://getrector.com/documentation/config-configuration

Skip a rule only for specific files by mapping the rule class to an array of file paths in withSkip().

```php
use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withSkip([
        SomeRule::class => [
            __DIR__ . '/src/SpecialCase.php',
        ],
    ]);

```
Tokens:
Raw