Instant Upgrades and Automated Refactoring of any PHP 5.3+ code
Go to file
Tomas Votruba ff75474d25 Updated Rector to commit 39f43c01cbc34a8bb064f056d39f1b8d2bd7a152
39f43c01cb Use Symfony ~6.1.x to avoid crash on update vendor-patch (#3134)
2022-12-01 14:10:32 +00:00
.github Updated Rector to commit b536a67738 2022-06-14 06:49:40 +00:00
bin Updated Rector to commit 39f43c01cbc34a8bb064f056d39f1b8d2bd7a152 2022-12-01 14:10:32 +00:00
config Updated Rector to commit 39f43c01cbc34a8bb064f056d39f1b8d2bd7a152 2022-12-01 14:10:32 +00:00
docs Updated Rector to commit 36e9b6cf74173091196fd91c858f663e65bb9af1 2022-11-30 12:08:14 +00:00
e2e Updated Rector to commit 6fa3ade0c296e366490d1e4bcc642dc53ad92674 2022-09-02 10:27:12 +00:00
packages Updated Rector to commit 39f43c01cbc34a8bb064f056d39f1b8d2bd7a152 2022-12-01 14:10:32 +00:00
rules Updated Rector to commit 39f43c01cbc34a8bb064f056d39f1b8d2bd7a152 2022-12-01 14:10:32 +00:00
src Updated Rector to commit 39f43c01cbc34a8bb064f056d39f1b8d2bd7a152 2022-12-01 14:10:32 +00:00
stubs-rector Updated Rector to commit 38ed8d2f6d 2022-05-27 15:54:40 +00:00
templates Updated Rector to commit 86c0920bdf0222f3c3e6ddf8490804f428a39fae 2022-11-11 14:53:57 +00:00
vendor Updated Rector to commit 39f43c01cbc34a8bb064f056d39f1b8d2bd7a152 2022-12-01 14:10:32 +00:00
.gitattributes Updated Rector to commit e3f20c1fb6 2021-08-08 16:52:18 +00:00
bootstrap.php Updated Rector to commit dc22a952fe92e3574a27c8e9e7de3d9aead42a4f 2022-09-01 22:05:56 +00:00
CODE_OF_CONDUCT.md Use HTTPS instead of HTTP 2018-02-14 07:23:09 -02:00
composer.json Updated Rector to commit a1ec5d278803a7f31105911da8063ca42ded2735 2022-11-18 20:47:19 +00:00
CONTRIBUTING.md Updated Rector to commit 87d8ac84d83e29f2d1d7479cdde69272bdf8a9e9 2022-09-04 15:50:34 +00:00
LICENSE Update LICENSE year forever 2018-01-02 20:27:07 -02:00
preload.php Updated Rector to commit 7b1b3568da825c850f5a8338d55edb108e77f845 2022-10-16 00:46:44 +00:00
README.md Updated Rector to commit 571a1e6067342b21c2baaa10976103915299b0c6 2022-11-29 16:10:51 +00:00

Rector - Instant Upgrades and Automated Refactoring

Downloads


Rector instantly upgrades and refactors the PHP code of your application. It can help you in 2 major areas:

1. Instant Upgrades

Rector now supports upgrades from PHP 5.3 to 8.1 and major open-source projects like Symfony, PHPUnit, and Doctrine. Do you want to be constantly on the latest PHP and Framework without effort?

Use Rector to handle instant upgrades for you.

2. Automated Refactoring

Do you have code quality you need, but struggle to keep it with new developers in your team? Do you want to see smart code-reviews even when every senior developers sleeps?

Add Rector to your CI and let it continuously refactor your code and keep the code quality high.


Documentation

For Rule Developers and Contributors

See the full documentation.


Learn Faster with a Book

Are you curious, how Rector works internally, how to create your own rules and test them and why Rector was born? Read Rector - The Power of Automated Refactoring that will take you step by step through the Rector setup and how to create your own rules.


Install

composer require rector/rector --dev

Running Rector

There are 2 main ways to use Rector:

  • a single rule, to have the change under control
  • or group of rules called sets

To use them, create a rector.php in your root directory:

vendor/bin/rector init

And modify it:

use Rector\Php74\Rector\Property\TypedPropertyRector;
use Rector\Set\ValueObject\SetList;
use Rector\Config\RectorConfig;

return static function (RectorConfig $rectorConfig): void {
    // here we can define, what sets of rules will be applied
    // tip: use "SetList" class to autocomplete sets
    $rectorConfig->sets([
        SetList::CODE_QUALITY
    ]);

    // register single rule
    $rectorConfig->rule(TypedPropertyRector::class);
};

Then dry run Rector:

vendor/bin/rector process src --dry-run

Rector will show you diff of files that it would change. To make the changes, drop --dry-run:

vendor/bin/rector process src

Note: rector.php is loaded by default. For different location, use --config option.

Note: Rector will only update legacy code to utilize new features which are supported by the PHP version defined in your composer.json file. For instance, if require.php is >=7.2.5, Rector will not make changes which are only available for PHP versions after 7.2.5.


Configuration

// rector.php
use Rector\Core\ValueObject\PhpVersion;
use Rector\Config\RectorConfig;

return static function (RectorConfig $rectorConfig): void {
    // paths to refactor; solid alternative to CLI arguments
    $rectorConfig->paths([__DIR__ . '/src', __DIR__ . '/tests']);

    // is your PHP version different from the one you refactor to? [default: your PHP version], uses PHP_VERSION_ID format
    $rectorConfig->phpVersion(PhpVersion::PHP_72);

    // Path to PHPStan with extensions, that PHPStan in Rector uses to determine types
    $rectorConfig->phpstanConfig(__DIR__ . '/phpstan-for-config.neon');
};

Empowered by Rector Community ❤️

The Rector community is powerful thanks to active maintainers who take care of Rector sets for particular projects.

Among there projects belong:


Hire us to get Job Done 💪

Rector is a tool that we develop and share for free, so anyone can automate their refactoring. But not everyone has dozens of hours to understand complexity of abstract-syntax-tree in their own time. That's why we provide commercial support - to save your time.

Would you like to apply Rector on your code base but don't have time for the struggle with your project? Hire us to get there faster.


How to Contribute

See the contribution guide or go to development repository rector/rector-src.


Debugging

You can use --debug option, that will print nested exceptions output:

vendor/bin/rector process src/Controller --dry-run --debug

Or with Xdebug:

  1. Make sure Xdebug is installed and configured
  2. Add --xdebug option when running Rector
vendor/bin/rector process src/Controller --dry-run --xdebug

Known Drawbacks

How to Apply Coding Standards?

Rector uses nikic/php-parser, built on technology called an abstract syntax tree (AST). An AST doesn't know about spaces and when written to a file it produces poorly formatted code in both PHP and docblock annotations. That's why your project needs to have a coding standard tool and a set of formatting rules, so it can make Rector's output code nice and shiny again.

We're using ECS with this setup.