README

Overview

When updating to a newer PHP version, you might encounter compatibility issues with third-party dependencies. This tool transforms the output from Rector into composer patches to address these incompatibilities in third-party packages.

Prerequisites

• PHP 8.1 or higher
• Composer 2.4.1 or higher

Dependencies

composer.json includes:

    "symfony/console": "^v6.3.4"

Installation Steps

Please follow the instructions:

• Run composer require --dev labofgood/rector-output-to-composer-patches
  or
• Run git clone git@github.com:abramchenkoaa/rector-output-to-composer-patches.git

Usage Guide

• Install Rector and gather the output for a third-party package.

composer require rector/rector --dev
php /path/to/project/vendor/bin/rector process /path/to/project/vendor/vendor_name/package_name --dry-run --output-format=json --autoload-file /path/to/project/vendor/autoload.php  > /path/to/project/rector.json

• In the case of manual installation, run the following command to generate patches:

php bin/rector-to-patch generate:composer-patches --file_path '/path/to/project/rector.json' --ticket ISSUE-123

• In the case of composer installation, run the following command to generate patches:

php /path/to/project/vendor/bin/rector-to-patch generate:composer-patches --file_path '/path/to/project/rector.json' --ticket ISSUE-123

• The patches will be generated in the /path/to/project/patches folder by default.

• Check command help for more options:

php bin/rector-to-patch generate:composer-patches --help

Output:

Description:
  Generate composer patches for each file in json output

Usage:
  generate:composer-patches [options]

Options:
      --file_path=FILE_PATH      Path to the file which contains the JSON output
      --ticket[=TICKET]          Identifier of the ticket in Jira or Github ect. [default: "identifier-not-set"]
      --output_dir[=OUTPUT_DIR]  Path to the output directory [default: "/path/to/project/rector-output-to-composer-patches/patches"]

Credits

• Anton Abramchenko anton.abramchenko@labofgood.com

Licensing

Copyright © 2023 Anton Abramchenko. All rights reserved.
This software is under the "3-Clause BSD License" license (see source).