TYPO3 Upgrades with Rector

In this hands-on tutorial I want to show the whole process of setting up rector, creating the config file, adapting it to needs and finding cases that are not covered by it and how to change that.

Transcript

1. Upgrades with
2. Hello! I am Henrik Elsner Team DFAU / toujou TYPO3 Rector Developer since 2021 2
3. Hello! I am Simon Schaufelberger Freelancer TYPO3 Rector Developer since 2020 3
4. Audience Survey: Who does not use Rector already? 4 4000 3000 2000 1000 0
5. The Pain ⇨ Manual refactoring is slow and expensive ⇨ Reading Changelogs and understanding the migration path ⇨ Boring and Repetitive ⇨ Prone to Human Error ⇨ Small budget 5
6. 1. Rector The Migration Tool for automated Code Upgrades
7. What TYPO3 Rector can do ⇨ TCA Changes ⇨ Class/Method refactorings ⇨ Backendmodul registration / PageTS config / UserTS config ⇾ Create new (non PHP) files ⇨ Detect the extension name for some rules 7
8. What Rector can NOT do ⇨ Migrate Hooks to Events ⇨ Huge refactorings ⇨ Migrations that require adjustments in different files (e.g. PHP and SQL) ⇨ Migrate other file types than PHP 8
9. 195 Rules 6 Rules for TYPO3 14 45 Rules for TYPO3 13 9 Our achievements:
10. 52 Contributors 10 Your achievements: 263 public repos use TYPO3 Rector
11. +2.1 million downloads 11
12. Rector can do even more! ⇨ The Rector core project has plenty of rules ⇾ PHP’s own migrations (PHP 7.4 to PHP 8) ⇾ PhpUnit Migrations (@test to #[TEST]) ⇾ Doctrine Migrations ⇨ Improve Code Quality & Code style ⇨ Remove dead code ⇨ And lots more… 👉 Import the RuleSets from Rector! 12
13. Other Rector projects TYPO3 Rector is not the only one: ⇨ frosh/shopware-rector ⇨ sylius/sylius-rector ⇨ driftingly/rector-laravel ⇨ palantirnet/drupal-rector ⇨ neos/rector ⇨ … 13
14. 2. Fractor The new brother of Rector
15. What Fractor can do Migrate: ⇨ TypoScript ⇨ composer.json files ⇨ Form definitions (yaml) ⇨ FlexForms (xml) ⇨ .htaccess files ⇨ Fluid templates And format the code according to your style! 15
16. Format TypoScript 16
17. Format XML 17
18. 3. Tips & Tricks Things that help you using Rector
19. Run single rules Rector can execute single rules via CLI param: rector --only=”Namespaced\RuleName” You need to clear the cache afterwards with: rector --clear-cache --dry-run 19
20. “There is a script for that... 20 "git commit" each applied Rule as a single commit with: github.com/mogic-le/rector-single-commit You need to create the commit message files 👉 Adjust the script and fix the code style after each commit
21. PhpStorm Integration since 2022.2 21 Only works with the “old” config format! https://blog.jetbrains.com/phpstorm/2022/08/phpstorm-2022-2-is-now-available/
22. Configurable rules TYPO3 Rector has some configurable rules: ⇨ ExtEmConfRector ⇨ GeneralUtilityMakeInstanceToConstructorPro pertyRector ⇨ All Rules in the Docs with: “🔧 configure it!” How do I configure them? 👉 Look in the Docs or Tests! 22
23. Configurable rules 23 Adjust your Rector config file: // old format: $rectorConfig ->ruleWithConfiguration(ExtEmConfRector::class, [ ExtEmConfRector::PHP_VERSION_CONSTRAINT => '8.2.0-8.3.99', ExtEmConfRector::TYPO3_VERSION_CONSTRAINT => '13.4.0-13.4.99', ExtEmConfRector::ADDITIONAL_VALUES_TO_BE_REMOVED => [ 'createDirs', 'Uploadfolder' ], ]);
24. Configurable rules 24 Adjust your Rector config file: // new format: return RectorConfig::configure() ->withConfiguredRule(MigrateRenderTypeInputLinkToTypeLinkRector::class, [ MigrateRenderTypeInputLinkToTypeLinkRector::ALLOWED_TYPES => ['page', 'file', 'folder', 'record', 'telephone'], ]);
25. Configurable rules 25 Use existing rules from Rector and configure them: // new format: return RectorConfig::configure() ->withConfiguredRule(RenameMethodRector::class, [ new MethodCallRename('Doctrine\\DBAL\\Connection', 'getSchemaManager', 'createSchemaManager'), ]); ⇨ You don’t have to create new rules for each case.
26. Exclude rules & files 26 // new format: return RectorConfig::configure() ->withSkip([ __DIR__ . ‘/path/to/file/to/skip.ext’, // by file path / directory RuleToSkip::class, // by rule AnotherRuleToSkip::class, [ // by combination __DIR__ . ‘/path/to/file/to/skip.ext’, ], ]); ⇨ Works the same in Fractor
27. Code Style Rector can mess up your code style. Use a code style fixer! Our recommendation: “Easy Coding Standard” (ecs) ⇨ Based on PHP-CS-Fixer ⇨ Additional rules (for arrays) https://github.com/easy-coding-standard/easy-coding-standard 27
28. Rector & Fractor test project We have a test project for you! github.com/helsner/typo3-rector-demo 29
29. Thanks! 30 Any questions? You can find us at: ⇨ my.typo3.org/u/helsner ⇨ my.typo3.org/u/simonschaufi