Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rectorphp/rector-symfony
Rector upgrade rules for Symfony
https://github.com/rectorphp/rector-symfony
ast instant-upgrades php rector symfony
Last synced: 4 days ago
JSON representation
Rector upgrade rules for Symfony
- Host: GitHub
- URL: https://github.com/rectorphp/rector-symfony
- Owner: rectorphp
- License: mit
- Created: 2021-03-18T14:46:19.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-08T17:51:25.000Z (14 days ago)
- Last Synced: 2024-12-17T00:39:02.742Z (6 days ago)
- Topics: ast, instant-upgrades, php, rector, symfony
- Language: PHP
- Homepage: https://getrector.com/find-rule?activeRectorSetGroup=symfony
- Size: 2.13 MB
- Stars: 188
- Watchers: 10
- Forks: 90
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rector Rules for Symfony
See available [Symfony rules](https://getrector.com/find-rule?activeRectorSetGroup=symfony)
## Install
This package is already part of [rector/rector](http://github.com/rectorphp/rector) package, so it works out of the box.
All you need to do is install the main package, and you're good to go:
```bash
composer require rector/rector --dev
```
## Use Sets
To add a set to your config, use `Rector\Symfony\Set\SymfonySetList` class and pick one of constants:
```php
use Rector\Config\RectorConfig;
use Rector\Symfony\Set\SymfonySetList;
return RectorConfig::configure()
->withSymfonyContainerXml(__DIR__ . '/var/cache/dev/App_KernelDevDebugContainer.xml')
->withSets([
SymfonySetList::SYMFONY_62,
SymfonySetList::SYMFONY_CODE_QUALITY,
SymfonySetList::SYMFONY_CONSTRUCTOR_INJECTION,
]);
```
## Configuration
### Provide Symfony XML Service List
Some rules like `StringFormTypeToClassRector` need access to your Symfony container dumped XML. It contains list of form types with their string names, so it can convert them to class references.
How to add it? Check your `var/cache/` directory and find the XML file for your test env. Then add it in `rector.php`:
```php
use Rector\Config\RectorConfig;
return RectorConfig::configure()
->withSymfonyContainerXml(__DIR__ . '/var/cache/dev/App_KernelDevDebugContainer.xml');
```
That's it! Now you can run the `StringFormTypeToClassRector` and get your form classes converted safely.
---
### Provide Symfony PHP Container
Some rules like `AddRouteAnnotationRector` require additional access to your Symfony container. The rule takes container service "router" to load metadata about your routes.
```php
use Rector\Config\RectorConfig;
use Rector\Symfony\Bridge\Symfony\Routing\SymfonyRoutesProvider;
use Rector\Symfony\Configs\Rector\ClassMethod\AddRouteAnnotationRector;
use Rector\Symfony\Contract\Bridge\Symfony\Routing\SymfonyRoutesProviderInterface;
return RectorConfig::configure()
->withSymfonyContainerPhp(__DIR__ . '/tests/symfony-container.php')
->registerService(SymfonyRoutesProvider::class, SymfonyRoutesProviderInterface::class);
```
The `tests/symfony-container.php` should provide your dependency injection container. The way you create the container is up to you. It can be as simple as:
```php
// tests/symfony-container.php
use App\Kernel;
require __DIR__ . '/bootstrap.php';
$appKernel = new Kernel('test', false);
$appKernel->boot();
return $appKernel->getContainer();
```
The version of your Symfony can be quite old. Public methods are stable from Symfony 2 to through 6 and the router have not changed much. The `AddRouteAnnotationRector` rule was tested and developed on Symfony 2.8 project.
---
> [!NOTE]
> In this case, container cache PHP file located in `/var/cache//appProjectContainer.php` is not enough. Why? Few services require Kernel to be set, e.g. routes that are resolved in lazy way. This container file is only dumped without Kernel and [would crash with missing "kernel" error](https://github.com/symfony/symfony/issues/19840). That's why the rule needs full blown container.
## Learn Rector Faster
Rector is a tool that [we develop](https://getrector.org/) and share for free, so anyone can save hundreds of hours on refactoring. But not everyone has time to understand Rector and AST complexity. You have 2 ways to speed this process up:
* read a book - The Power of Automated Refactoring
* hire our experienced team to improve your code base
Both ways support us to and improve Rector in sustainable way by learning from practical projects.