installation.md

Installation

Install the library.

$ composer require --dev ssch/typo3-rector

Composer conflicts

It is not uncommon to run into unresolvable composer conflicts when installing typo3-rector, especially with older TYPO3 Versions (< 9.5 LTS), for example TYPO3 8.7 LTS. In this case, you have multiple options:

Solution #1

The best solution is to install the package ssch/typo3-rector-shim

$ composer require --dev ssch/typo3-rector-shim

Solution #2

As an alternative to installing ssch/typo3-rector-shim, you may also want to use the package rector/rector-prefixed, which aims for maximum compatibility. Just install it via composer before installing ssch/typo3-rector, it works as a drop-in-replacement for rector/rector:

$ composer require --dev rector/rector-prefixed
$ composer require --dev ssch/typo3-rector

Solution #3

Another solution is to download the .phar file directly from the release version. Put the .phar file somewhere in our project directory and make it executable. Afterwards you can run the .phar file with one of the available commands.

Non composer installations

If you have a non composer TYPO3 installation. Don´t worry. Install typo3-rector either as a global dependency or use the .phar file from solution 3:

$ composer global require --dev ssch/typo3-rector

Add an extra autoload file. In the example case it is placed in the Document Root of your TYPO3 project. The autoload should look something like that:

use TYPO3\CMS\Core\Core\Bootstrap;
define('PATH_site', __DIR__.'/');
$classLoader = require PATH_site .'/typo3_src/vendor/autoload.php';

Bootstrap::getInstance()
         ->initializeClassLoader($classLoader)
         ->setRequestType(TYPO3_REQUESTTYPE_CLI)
         ->baseSetup();

Afterwards run rector:

php ~/.composer/vendor/bin/typo3-rector process public/typo3conf/ext/your_extension/  -c .rector/config.php -n --autoload-file autoload.php