rector README

The project's README from github.com/rectorphp/rector. As one markdown file: 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.5 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.

Read our blogpost to see how to set up automated refactoring.

Install

composer require rector/rector --dev

Running Rector

There are 2 main ways to use Rector:

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

vendor/bin/rector

And modify it:

use Rector\Config\RectorConfig;
use Rector\TypeDeclaration\Rector\Property\TypedPropertyFromStrictConstructorRector;

return RectorConfig::configure()
    // register single rule
    ->withRules([
        TypedPropertyFromStrictConstructorRector::class
    ])
    // here we can define, what prepared sets of rules will be applied
    ->withPreparedSets(
        deadCode: true,
        codeQuality: true
    );

Then dry run Rector:

vendor/bin/rector src --dry-run

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

vendor/bin/rector 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 :heart:

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 :muscle:

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 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 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);

Known Drawbacks

How to Apply Coding Standards?

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.

May cause unexpected output on File with mixed PHP+HTML content

When you apply changes to files with PHP + HTML content, you may need to manually verify the changed file after apply the changes.

rector (rectorphp/rector)

Searching Database…

10.4K ·GitHub
Rector
Что это такое?Rector — это инструмент для PHP, который мгновенно обновляет и рефакторит PHP-код: он автоматизирует переходы с PHP 5.3 вплоть до 8.5, включая миграцию фреймворков, и помогает постоянно поддерживать качество кода через CI.
Это фреймворк, на котором я строю проект, или инструмент, который я запускаю над готовым кодом?Это консольный инструмент для разработчиков, а не библиотека: вы устанавливаете его как dev-зависимость, описываете нужные изменения в конфиге rector.php в корне проекта и запускаете его по всей кодовой базе из терминала.
Как подключить его к моему проекту?Установите через Composer, создайте rector.php с нужными правилами, а сначала выполните пробный запуск — Rector покажет diff изменений, которые собирается внести. Уберите --dry-run, чтобы применить их по-настоящему.
Что должно быть установлено на моей машине?Достаточно PHP и Composer — запускается из терминала на Linux, macOS и Windows, никакие дополнительные сервисы или базы данных не нужны.
Есть ли подводные камни, прежде чем давать ему переписывать мой код?Пара моментов: вывод может потерять форматирование, потому что AST игнорирует пробелы (дополните его инструментом для стандартов кода вроде ECS); файлы со смесью PHP и HTML нужно проверять вручную; а на Windows запускайте через cmd или bash — в параллельном режиме под PowerShell 7 инструмент сбоит.
Rector бесплатный или есть платная версия?Сам инструмент бесплатный и развивается открыто. Заработок команды — это необязательная платная поддержка для команд, которые предпочитают нанять их для применения Rector, вместо того чтобы самим разбираться в тонкостях абстрактного синтаксического дерева.
Есть ли готовый набор правил для моего фреймворка?Скорее всего да — мейнтейнеры сообщества поддерживают отдельные наборы для проектов вроде Laravel, Drupal, CakePHP, TYPO3, Craft CMS, Shopware, Sylius, Sulu, Nette, Contao, Yii2 и SilverStripe.
Что делать, если правило сработало не так, как я ожидал?Запустите с флагом --debug, чтобы вывести вложенные исключения, добавьте опцию --xdebug, если пользуетесь Xdebug, и используйте встроенные помощники, которые красиво печатают узлы AST.
What are similar projects?ast-grep, PHP-Parser, infer, fallow, phpstan, rust-clippy, pyright, perch
Which topics is it in?ast, refactoring, static-code-analysis, code-quality, static-analysis, php, ci, cli-tool, utility, command-line, developers, devops
Creator
rectorphp
Size
372.8 MB
Stars
10.4K
Updated
CommitOct 17Release2.7.0Oct 06
Age
9y
Commits · 90 Days