Instant Upgrades and Automated Refactoring of any PHP 5.3+ code
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Tomas Votruba 63b8be39f7
Updated Rector to commit 7f1f57acc358e4c7724b146f3a9d976bae4cb0c9
11 hours ago
.github Updated Rector to commit b536a67738 8 months ago
bin Updated Rector to commit d118ae38e265476684bcf566b87301cca5716ed9 6 days ago
config Updated Rector to commit 5f4edd9230355cadc311ba8e8954fb9ae5bdc849 11 hours ago
docs Updated Rector to commit 5f4edd9230355cadc311ba8e8954fb9ae5bdc849 11 hours ago
e2e Updated Rector to commit 7f1f57acc358e4c7724b146f3a9d976bae4cb0c9 11 hours ago
packages Updated Rector to commit 5f4edd9230355cadc311ba8e8954fb9ae5bdc849 11 hours ago
rules Updated Rector to commit 5f4edd9230355cadc311ba8e8954fb9ae5bdc849 11 hours ago
src Updated Rector to commit 7f1f57acc358e4c7724b146f3a9d976bae4cb0c9 11 hours ago
stubs-rector Updated Rector to commit 38ed8d2f6d 9 months ago
templates Updated Rector to commit 86c0920bdf0222f3c3e6ddf8490804f428a39fae 3 months ago
vendor Updated Rector to commit 7f1f57acc358e4c7724b146f3a9d976bae4cb0c9 11 hours ago
.gitattributes Updated Rector to commit e3f20c1fb6 2 years ago
CODE_OF_CONDUCT.md Use HTTPS instead of HTTP 5 years ago
CONTRIBUTING.md Updated Rector to commit 87d8ac84d83e29f2d1d7479cdde69272bdf8a9e9 5 months ago
LICENSE Update LICENSE year forever 5 years ago
README.md Updated Rector to commit 7f873f0311679c23feacabd3089c8185b9a93c74 21 hours ago
bootstrap.php Updated Rector to commit dc22a952fe92e3574a27c8e9e7de3d9aead42a4f 5 months ago
composer.json Updated Rector to commit 651e283c439ef593c6609ccc2623e11142544f4f 17 hours ago
preload.php Updated Rector to commit 2d6869fe3933347397a2ce879805a91e829e09a9 3 weeks ago

README.md

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.

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\Config\RectorConfig;
use Rector\Set\ValueObject\SetList;
use Rector\TypeDeclaration\Rector\Property\TypedPropertyFromStrictConstructorRector;

return static function (RectorConfig $rectorConfig): void {
    // register single rule
    $rectorConfig->rule(TypedPropertyFromStrictConstructorRector::class);

    // here we can define, what sets of rules will be applied
    // tip: use "SetList" class to autocomplete sets with your IDE
    $rectorConfig->sets([
        SetList::CODE_QUALITY
    ]);
};

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

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.


Empowered by 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

To assist with simple debugging Rector provides 2 helpers to pretty-print AST-nodes:

use PhpParser\Node\Scalar\String_;
$node = new String_('hello world!');

// prints node to string, as PHP code displays it
print_node($node);

// dump nested node object with nested properties
dump_node($node);

// 2nd argument is how deep the nesting is - this makes sure the dump is short and useful
dump_node($node, 1);

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.