bin | ||
docs | ||
packages | ||
src | ||
tests | ||
.coveralls.yml | ||
.gitignore | ||
.travis.yml | ||
CODE_OF_CONDUCT.md | ||
composer.json | ||
easy-coding-standard.neon | ||
ecs-after-rector.neon | ||
LICENSE | ||
phpstan.neon | ||
phpunit.xml | ||
README.md | ||
rector.yml |
Rector Reconstructs your Legacy Code to Modern Codebase
Rector upgrades your application for you, with focus on open-source projects:
Install
composer require --dev rector/rector @dev nikic/php-parser 'dev-master#5900d78 as v3.1.1'
Do you have old PHP or dependencies in conflict? Ok, it is not problem.
How To Reconstruct your Code?
A. Prepared Sets
Fetaured open-source projects have prepared sets. You'll find them in /src/config/level
.
E.g. Do you need to upgrade to Symfony 3.3?
- Run rector on your
/src
directory
vendor/bin/rector process src --level symfony33
Which is just a shortcut for using complete path with --config
option:
vendor/bin/rector process src --config vendor/rector/rector/src/config/level/symfony/symfony33.yml
You can also use your own config file:
vendor/bin/rector process src --config your-own-config.yml
- Check the Git
git diff
B. Custom Sets
- Create
rector.yml
with desired Rectors
rectors:
- Rector\Rector\Contrib\Nette\Application\InjectPropertyRector
- Run rector on your
/src
directory
vendor/bin/rector process src
- Check the Git
git diff
Simple setup with Dynamic Rectors
You don't have to always write PHP code. Many projects change only classes or method names, so it would be too much work for a simple task.
Instead you can use prepared Dynamic Rectors directly in *.yml
config:
You can:
-
replace class name
# phpunit60.yml rectors: Rector\Rector\Dynamic\ClassReplacerRector: # old class: new class 'PHPUnit_Framework_TestCase': 'PHPUnit\Framework\TestCase'
-
replace part of namespace
# better-reflection20.yml rectors: Rector\Rector\Dynamic\NamespaceReplacerRector: # old namespace: new namespace 'BetterReflection': 'Roave\BetterReflection'
-
change method name
rectors: Rector\Rector\Dynamic\MethodNameReplacerRector: # class 'Nette\Utils\Html': # old method: new method 'add': 'addHtml' # or in case of static methods calls # class 'Nette\Bridges\FormsLatte\FormMacros': # old method: [new class, new method] 'renderFormBegin': ['Nette\Bridges\FormsLatte\Runtime', 'renderFormBegin']
-
change property name
rectors: Rector\Rector\Dynamic\PropertyNameReplacerRector: # class: 'PhpParser\Node\Param': # old property: new property 'name': 'var'
-
change class constant name
rectors: Rector\Rector\Dynamic\ClassConstantReplacerRector: # class 'Symfony\Component\Form\FormEvents': # old constant: new constant 'PRE_BIND': 'PRE_SUBMIT' 'BIND': 'SUBMIT' 'POST_BIND': 'POST_SUBMIT'
-
change parameters typehint according to parent type
rectors: Rector\Rector\Dynamic\ParentTypehintedArgumentRector: # class 'PhpParser\Parser': # method 'parse': # parameter: typehint 'code': 'string'
-
change argument value
rectors: Rector\Rector\Dynamic\ArgumentReplacerRector: # class 'Symfony\Component\DependencyInjection\ContainerBuilder': # method 'compile': # argument position 0: # added default value ~: false # or remove completely ~: ~ # or replace by new value 'Symfony\Component\DependencyInjection\ContainerBuilder\ContainerBuilder::SCOPE_PROTOTYPE': false
-
or replace underscore naming
_
with namespaces\
rectors: Rector\Roector\Dynamic\PseudoNamespaceToNamespaceRector: # old namespace prefix - 'PHPUnit_' # exclude classes - '!PHPUnit_Framework_MockObject_MockObject'
-
or change property to method
rectors: Rector\Rector\Dynamic\PropertyToMethodRector: # type 'Symfony\Component\Translation\Translator': # property to replace 'locale': # (prepared key): get method name 'get': 'getLocale' # (prepared key): set method name 'set': 'setLocale'
Turn Magic to Methods
-
replace get/set magic methods with real ones
rectors: Rector\Rector\MagicDisclosure\GetAndSetToMethodCallRector: # class 'Nette\DI\Container': # magic method (prepared keys): new real method 'get': 'getService' 'set': 'addService'
For example:
$result = $container['key']; # to $result = $container->getService('key'); $container['key'] = $value; # to $container->addService('key', $value);
-
or replaces isset/unset magic methods with real ones
rectors: Rector\Rector\MagicDisclosure\UnsetAndIssetToMethodCallRector: # class 'Nette\DI\Container': # magic method (prepared keys): new real method 'isset': 'hasService' 'unset': 'removeService'
For example:
isset($container['key']); # to $container->hasService('key'); unset($container['key']); # to $container->removeService('key');
-
or replaces toString magic methods with real ones
rectors: Rector\Rector\MagicDisclosure\ToStringToMethodCallRector: # class 'Symfony\Component\Config\ConfigCache': # magic method (prepared key): new real method 'toString': 'getPath'
For example:
$result = (string) $someValue; # to $result = $someValue->someMethod(); $result = $someValue->__toString(); # to $result = $someValue->someMethod();
Coding Standards are Outsourced
This package has no intention in formatting your code, as coding standard tools handle this much better.
We prefer EasyCodingStandard that is already available:
# check
vendor/bin/ecs check --config vendor/rector/rector/ecs-after-rector.neon
# fix
vendor/bin/ecs check --config vendor/rector/rector/ecs-after-rector.neon --fix
More Detailed Documentation
How to Contribute
Just follow 3 rules:
-
1 feature per pull-request
-
New feature needs tests
-
Tests, coding standard and PHPStan checks must pass
composer all
Don you need to fix coding standards? Run:
composer fix-cs
We would be happy to merge your feature then.