contao/contao-rector

Rector upgrades rules for Contao CMS

dev-main 2024-08-26 07:47 UTC

Requires

• php: ^8.1
• phpstan/phpstan: ^1.0
• rector/rector: ^0.19 || ^1.0
• webmozart/assert: ^1.7

Requires (Dev)

• contao/core-bundle: ^4.4 || ^5.0
• phpunit/phpunit: ^10.0
• symplify/rule-doc-generator: ^12.2

LGPL-3.0-or-later

README

This project contains Rector rules for Contao Open Source CMS upgrades.

!! WARNING !! this is currently experimental, use at your own risk

Install

Install contao-rector via composer to your project:

composer require contao/contao-rector --dev

Available sets

Available level sets

Level sets combine multiple changes for a specific Contao version, including dependencies like PHP, Symfony and Doctrine.

As an example, the ContaoLevelSetList::UP_TO_CONTAO_413 will upgrade your code to PHP 7.4 and Symfony 5.4, since Contao 4.13 does not support any lower versions.

Available rules

• Explore the current Rector rules

Development

You can generate the rules with the following command:

vendor/bin/rule-doc-generator generate src/Rector --output-file docs/rules_overview.md