nextcloud/rector

Rector upgrade rules for Nextcloud

About

This is a package containing rector rules and sets to use to upgrade your Nextcloud application to the latest API changes.

This project adheres to a code of conduct. By participating in this project and its community, you are expected to uphold this code.

Installation

Install this package as a dependency using Composer. We recommend to do so in a vendor bin directory along with rector.

composer require --dev bamarni/composer-bin-plugin
composer bin rector require rector/rector --dev
composer bin rector require nextcloud/rector --dev

Usage

First generate a rector.php configuration by running process command a first time:

./vendor/bin/rector process

We recommend that you first run rector with an empty configuration, commit the result, and then add the sets from Nextcloud and PHP one by one and commit the rule along with its result each time. You should stop at the oldest version your application is supporting of both Nextcloud and PHP. Do not apply a newer set or you might lose compatibility. Each Nextcloud set includes the older ones so you only need one of them in your configuration. You could end up with a configuration like this one:

<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-only
 */

use Nextcloud\Rector\Set\NextcloudSets;
use Rector\Config\RectorConfig;

return RectorConfig::configure()
	->withPaths([
		__DIR__ . '/appinfo',
		__DIR__ . '/lib',
		__DIR__ . '/tests',
	])
	->withPhpSets(php81: true)
	->withTypeCoverageLevel(0)
	->withSets([
		NextcloudSets::NEXTCLOUD_30,
	]);

nextcloud/ocp dependency

Some rules e.g. ->withPhpSets(php82: true) require a reference to the OCP package. If you are receiving an error like the following, you are facing one of them:

System error: "Class "OCP\AppFramework\Db\Entity" not found

The nextcloud/rector package comes with a version of nextcloud/ocp, that can be good enough, but it can also be outdated later. So if you have an up-to-date dependency to nextcloud/ocp anyway, it totally makes sense to link that root instead. Simply add the following autoload-information into the vendor-bin/rector/composer.json file, to use the internal package, or use paths like ../../vendor/nextcloud/ocp to reference the OCP package from your root composer or ../vendor-bin/nextcloud-ocp/vendor/nextcloud/ocp if you have it in another composer-bin:

    "autoload": {
        "psr-4": {
            "OCP\\": "vendor/nextcloud/ocp/OCP/",
            "NCU\\": "vendor/nextcloud/ocp/NCU/"
        }
    }

Make sure that you also have nextcloud/coding-standard setup and to run the code style fixer after rector to fix styling.

Contributing

Contributions are welcome! To contribute, please familiarize yourself with CONTRIBUTING.md.

Copyright and License

nextcloud/rector is copyright © Christoph Wurst and licensed for use under the terms of the GNU Affero General Public License (AGPL-3.0-or-later) as published by the Free Software Foundation. Please see COPYING and NOTICE for more information.