rector.md

Rector

Rector is a tool to instantly upgrade and automatically refactor your PHP 5.3+ code. It lives under the rector namespace and has following configurable parameters:

Composer

composer require --dev rector/rector

Config

# grumphp.yml
grumphp:
    tasks:
        rector:
            config: null
            triggered_by: ['php']
            ignore_patterns: []
            clear_cache: true
            no_diffs: false

config

Default: null

With this parameter you can specify the path your project's configuration file. When 'null' rector will run with the default file: rector.php

triggered_by

Default: [php]

This is a list of extensions to be sniffed.

ignore_patterns

Default: []

This is a list of patterns that will be ignored by Rector. With this option you can skip files like tests. Leave this option blank to run Rector for every php file/directory specified in your configuration.

clear_cache

Default: true

With this parameter you can run Rector without using the cache.

no_diffs

Default: false

With this parameter you can run Rector without showing file diffs.