Instant fixes for your Drupal code by using Rector.
This package is auto-updated.
Last update: 2021-06-18 19:42:08 UTC
Automate fixing deprecated Drupal code.
Note that GitHub does not let us have different default homepage and merge branches. If you checked out the project using packagist/composer, read the docs for your version.
You can read more details in the following blog post:
Development guides, individual deprecation overviews, and other resources can be found here:
The development of this tool is prioritized by the perceived impact of the deprecations and updates. There are many deprecations that often involve several components and for each of these there are several ways to address the deprecation.
We've tried to determine impact based on:
- The use of the deprecated functionality in the contributed modules on Drupal.org
- If there are simple to develop ways to fix the deprecation
So, high impact (the code works in newer versions of Drupal for a large number of people), low effort (we can develop the rule based on our knowledge of Rector).
Known limitations are listed in the comment documentation for each rule.
Common limitations include:
- Using static calls like
Drupal->service('my_service')->myMethod();rather than injecting the service into the class
- Skipping complex use cases, such as when optional arguments are passed as variables
usestatements in weird ways. Rector has a global option to handle
usestatements and we think the benefits outweigh the drawbacks such as weird placement or lack of handling of less common patterns.
- Handling doc comments in weird ways, particularly around spacing. Rector uses dependencies that sometimes delete empty comments or remove white space. At this point, Drupal Rector does not intend to modify any doc comments, but Rector ends up doing this.
Our hope is that as we learn more about Rector, we may be able to update these rules to add these features.
Issues are managed on drupal.org
For contribution suggestions, please see the later section of this document.
NOTE: To have the best experience with Drupal Rector, your Drupal site should be running version 8.9. Support for Drupal 9 is in development
$ composer require --dev palantirnet/drupal-rector
You will need to have a
rector.php configuration in the root of your repository. This should sit beside your document root such as
This project uses
webflo/drupal-finder to find your document root that contains Drupal.
To get started, copy the
rector.php configuration file provided by this package:
cp vendor/palantirnet/drupal-rector/rector.php .
- Analyze your code with Rector and review suggested changes:
$ vendor/bin/rector process web/modules/contrib/[YOUR_MODULE] --dry-run
- Apply suggested changes:
$ vendor/bin/rector process web/modules/contrib/[YOUR_MODULE]
You can find more information about Rector here.
You may need to upgrade
phpstan/phpstan with Composer before installing this package.
Rector itself has conflicts with older versions of PhpStan.
If you are getting errors like
[ERROR] Class "DrupalRector\Rector\Deprecation\EntityManagerRector" was not found while loading
You may need to rebuild your autoload file.
If you are getting errors like
PHP Fatal error: Declaration of _HumbugBox3630ef99eac4\Symfony\Component\HttpKernel\Config\FileLocator::locate($file, $currentPath = NULL, $first = true) must be compatible with _HumbugBox3630ef99eac4\Symfony\Component\Config\FileLocatorInterface::locate(string $name, ?string $currentPath = NULL, bool $first = true) in phar:///var/www/html/vendor/rector/rector-prefixed/rector/vendor/symfony/http-kernel/Config/FileLocator.php on line 20 Fatal error: Declaration of _HumbugBox3630ef99eac4\Symfony\Component\HttpKernel\Config\FileLocator::locate($file, $currentPath = NULL, $first = true) must be compatible with _HumbugBox3630ef99eac4\Symfony\Component\Config\FileLocatorInterface::locate(string $name, ?string $currentPath = NULL, bool $first = true) in phar:///var/www/html/vendor/rector/rector-prefixed/rector/vendor/symfony/http-kernel/Config/FileLocator.php on line 20
You may need to check that you are
composer installfrom an environment that supports Php 7.2 or greater
- Running Drupal Rector from an environment that supports Php 7.2 or greater
Sometimes people install composer dependencies from one machine (host machine) and run Drupal Rector from another (such as a Lando VM).
If you are having these issues try running Rector from the environment that has Php 7.2 or greater. Drupal Rector does not need a fully functional web server, it only (more or less) needs Php and access to a standard Drupal set of files.
If you are getting errors like
iconv(): Wrong charset, conversion from UTF-8 to ASCII//TRANSLIT//IGNORE is not allowed
You can fix it in Dockerfile with
# fix work iconv library with alphine RUN apk add --no-cache --repository http://dl-cdn.alpinelinux.org/alpine/edge/community/ --allow-untrusted gnu-libiconv ENV LD_PRELOAD /usr/lib/preloadable_libiconv.so php
Credits to @zolotov88 in https://github.com/nunomaduro/phpinsights/issues/43#issuecomment-498108857
Thanks for your interest in contributing!
Our goal is to make contributing to this project easy for people. While we've made certain architectural decisions here to hopefully achieve that goal, it's a work in progress and feedback is appreciated.
We recommend using our
drupal-rector-sandbox development environment https://github.com/palantirnet/drupal-rector-sandbox
Alternatively, you can use your existing Drupal project and follow the instructions in README
If you would like to submit a Rector rule, we are looking for the following:
- A Rector rule class, see
/src/Rector/Deprecationfor existing rules
- An example file or files that show(s) the before and after, see
- An updated configuration file that registers the Rector rule, see
- A listing in the index file, see
A few guides are currently available and we encourage people to create additional guides to provide their perspective and help us better understand this tool together.
Rector rules should be named after the deprecation, including the class name.
We would like one Rector rule per deprecation. Some deprecations include updating multiple things and those would be separate rules.
To avoid duplication, we have created base classes for simple repeated patterns where possible. These end in
Base.php and are located in
/src/Rector/Deprecation/Base. In many of these rules, you will extend the base class, define class properties, add a class comment, and define the definition.
Rector supports passing parameters to rules and you can also define your rules in a variety of ways. To avoid confusion for new developers, we're trying to avoid these advanced features so that someone with limited familiarity with the tool can easily determine where things are located and what they are doing. If the copy & paste challenge isn't worth this trade-off, we can re-evaluate it as we go. Suggestions appreciated.
We are creating pairs of example files.
These should be named the same thing as the deprecation. So,
DrupalUrlRector has a
rector_examples/drupal_url.php example. An example
rector_examples_updated/drupal_url.php should also be created to show the updated code. You can run Drupal Rector on this file to show the update.
If you would like to show how the code is used in a class, you can add the class to the appropriate place in the
/rector_examples/test directories. Most of the examples in the example module are
services in that they are stand alone classes.
Since these classes can use static calls, dependency injection, or traits to get access to services, constants, etc, we have added more details to some class names. For example,
*Static to indicate that the class is not using dependency injection.
The configuration files in
/config/drupal-8 are broken down by Drupal minor versions.
Add your Rector rule to the relevant file.
The key is the fully qualified class name of the Rector rule. The key is the yaml null value
The index file is used in part to provide automated updates to https://dev.acquia.com/drupal9/deprecation_status/errors which is a helpful way to track coverage. The
PHPStan messages are listed there as well as in the change record comments throughout the Drupal codebase.