Free yourself from manual TYPO3 upgrades . TYPO3 Rector takes care of migrations, deprecations, and TCA updates, letting you focus on testing.
What is TYPO3 Rector?
TYPO3 Rector is an automation tool designed to simplify and accelerate the process of upgrading TYPO3 websites and extensions. It handles code refactoring, updates deprecated methods, and adjusts configurations, ensuring smooth and efficient upgrades to newer TYPO3 versions.
Key Features of TYPO3 Rector
Code Refactoring: Automatically updates PHP code to comply with the latest TYPO3 standards.
Configuration Updates: Adjusts TCA and other configurations to ensure compatibility with newer TYPO3 releases.
Class and Method Replacements: Replaces deprecated classes and methods with their modern equivalents.
File Format Compatibility: Ensures configuration files are updated to prevent compatibility issues during upgrades.
Why TYPO3 Rector?
Time-Saving: Automates upgrade tasks, allowing developers to focus on more important tasks.
Consistency: Ensures uniformity across the project, preventing discrepancies.
Error-Free Upgrades: Reduces the risk of manual errors during upgrades.
Faster Upgrades: With automation, the upgrade process is quicker and more efficient.
Installation Methods
1. Global Installation: Run composer global require ssch/typo3-rector to install it globally and add Composer’s global bin directory to your PATH.
2. Project-Specific Installation: Use composer require --dev ssch/typo3-rector to install it locally in your project.
3. PHAR Installation: Download the PHAR file, make it executable, and run it directly.
Configuring TYPO3 Rector
Create rector.php: Define paths and configurations for files to be processed.
Select Version Sets: Choose the appropriate version set (e.g., TYPO3_9, TYPO3_10) to apply the necessary updates.
Skip Files: Use withSkip to exclude files that don’t need updates.
Running TYPO3 Rector
1. Backup Your Project: Always commit your code and back it up before running TYPO3 Rector.
2. Dry Run: Run typo3-rector process --dry-run to preview the changes.
3. Apply Changes: Once satisfied, execute typo3-rector process to apply the updates.
CI/CD Integration
GitHub Actions: Set up workflows to trigger TYPO3 Rector automatically during code pushes or pull requests.
GitLab CI: Integrate TYPO3 Rector into your CI pipeline for seamless upgrades during merge requests.
Performance Optimization
Selective Processing: Run TYPO3 Rector only on modified files, using Git to detect changes.
Excluding Files: Skip unmodified files to improve processing time.
Maintenance and Updates
Regular Updates: Keep TYPO3 Rector updated to ensure compatibility with the latest TYPO3 versions.
Monitor Changes: Track TYPO3 Rector’s changelog for any new features or rules.
Fractor for Non-PHP Files
Fractor Integration: Use Fractor for updating non-PHP files like TypoScript, XML, and composer.json.
Install Fractor: Run composer require --dev a-r-m-i-n/fractor to install Fractor.
Common TYPO3 Rector Tasks
Database Connection Updates: Automatically updates old database connections to modern standards.
Hook Conversion: Converts deprecated hooks to PSR-14 events.
TCA Migration: Migrates TCA configurations to associative arrays for compatibility.
Extending TYPO3 Rector
Create Custom Rules: Develop your own rules to meet project-specific needs.
Community Contributions: Share your custom rules with the TYPO3 community.
Conclusion
TYPO3 Rector automates the upgrade process, reducing manual effort and minimizing errors. By refactoring code, updating configurations, and handling deprecated methods, it ensures that your TYPO3 projects stay up to date and compatible with the latest versions. With easy integration into CI/CD workflows and regular updates, TYPO3 Rector is an essential tool for any TYPO3 developer.
