README.md

Rector Extension Installer

Composer plugin for automatic installation of Rector extensions.

Important Note

As this project became a part of a core project (rector/rector) it shouldn't be installed in addition if you already installed rector/rector. See comments here.

Usage

composer require --dev rector/extension-installer

Instructions for extension developers

It's best to set the extension's composer package type to rector-extension for this plugin to be able to recognize it and to be discoverable on Packagist.

Add rector key in the extension composer.json's extra section:

{
    "extra": {
        "rector": {
            "includes": [
                "config/config.php"
            ]
        }
    }
}

Limitations

The extension installer depends on Composer script events, therefore you cannot use --no-scripts flag.

Acknowledgment

This package is heavily inspired by phpstan/extension-installer by Ondřej Mirtes. Thank you.