Merge pull request #147 from neos/upgrade-2.x

Upgrade package to rector/rector 2.x

Author: mhsdesign

.github/workflows/build.yml

@@ -15,7 +15,7 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                php-versions: ['8.2', '8.3']
+                php-versions: ['8.3', '8.4']
 
         runs-on: ubuntu-latest
 

README.md

@@ -2,19 +2,26 @@
 
 This package contains a Rector ruleset which is used for migrating from Neos 8.x to 9.0 (and lateron also further up).
 
-It will eventually replace Core/Code Migrations (./flow flow:core:migrate) (which are not used anymore for migrating to Neos 9 and further).
-
 Right now we focus especially on rules to migrate from the old Content Repository API (< Neos 9.0) to the
 Event Sourced Content Repository (>= 9.0).
 
+**PHP-only migrations**
+
+Earlier version of `neos/rector` also did the migration of Yaml and Fusion file. They have been moved into Neos core migrations starting version 9.0.8. Now `neos/rector` only contains PHP migrations.
+
+See for more details: https://github.com/neos/neos-development-collection/issues/5607
+
+
+
 ## Installation
-As Rector has strict dependency requirements, which might not match your own project, we strongly recommend to install 
-neos/rector in a dedicated directory and **not to add it to your project**.
+
+Please install the neos/rector package in your Distribution as a dev dependency with composer.
+<br>(This has changed to previous versions of this package)
 
 ```bash
 # inside your Distribution folder
-composer create-project neos/rector:dev-main --stability=dev rector
-cp rector/rector.template.php rector.php
+composer require --dev neos/rector:dev-main
+cp Packages/Libraries/neos/rector/rector.template.php rector.php
 ```
 
 ## Configuration
@@ -24,19 +31,12 @@ migrated). By default, all of `./DistributionPackages` will be migrated.
 
 Right now, we ship the following sets of Rector rules:
 
-- `\Neos\Rector\NeosRectorSets::CONTENTREPOSITORY_9_0`: all rules needed to migrate to the Event-Sourced Content Repository
-
-Also you need to add the autoload paths, to allow rector to parse your code properly. By default we added `./Packages` and `./DistributionPackages` to the template.
+- `\Neos\Rector\NeosRectorSets::CONTENTREPOSITORY_9_0`: all rules needed to migrate to the Event-Sourced Content
+  Repository
 
 ```php
 $rectorConfig->sets([
     NeosRectorSets::CONTENTREPOSITORY_9_0,
-    //NeosRectorSets::NEOS_8_4,
-]);
-
-$rectorConfig->autoloadPaths([
-    __DIR__ . '/Packages',
-    __DIR__ . '/DistributionPackages',
 ]);
 
 $rectorConfig->paths([
@@ -52,11 +52,12 @@ Run the following command at the root of your distribution (i.e. where `rector.p
 
 ```bash
 # for trying out what would be done
-./rector/vendor/bin/rector --dry-run
+./bin/rector --dry-run
 
 # for running the migrations
-./rector/vendor/bin/rector
+./bin/rector
 ```
+
 ---
 
 # Developing Rector Rules for Neos
@@ -77,58 +78,13 @@ The test setup runs completely self contained; does not need *any* Distribution
 
 ```bash
 # if inside a Neos Distribution, change to the Package's folder
-cd rector
+cd Packages/Libraries/neos/rector
 
 # install PHPunit 
 composer install
 
 # run PHPUnit
-composer test
-```
-
-## Fusion Rector
-
-We extended Rector specifically for migrating Fusion files, by providing a `FusionFileProcessor` and a `FusionRectorInterface`
-which you can implement if you want to build Fusion transformations.
-
-The Fusion Rectors will usually use one of the following tooling classes:
-
-- `EelExpressionTransformer`: for finding all Eel expressions inside Fusion and AFX; and transforming them in some way.
-
-The Fusion and AFX Parsing functionality is based on the official Fusion and AFX parsers. However, the classes are
-vendored/copied into this package by the `./embed-fusion-and-afx-parsers.sh` script, because of the following reasons:
-
-- Rector needs to run even when Flow cannot compile the classes; so we cannot depend on a Flow package.
-- We slightly need to patch the AFX parser, because we need position information for Eel Expressions.
-
-The Fusion parser was subclassed by `Neos\Rector\Core\FusionProcessing\CustomObjectTreeParser` for retaining position
-information of AFX and Eel Expressions.
-
-
-**Updating Fusion and AFX Parser**
-
-To update the vendored Fusion and AFX parsers, run the `./embed-fusion-and-afx-parsers.sh` script.
-
-
-**Updating the AFX Parser Patch**
-
-The AFX parser needs a custom patch (see `./scripts/afx-eel-positions.patch`) to retain positions.
-
-To create/update this patch, do the following:
-
-```bash
-cd Packages/Neos
-
-# apply the current patch
-patch -p1 < ../../rector/scripts/afx-eel-positions.patch
-
-# Now, do your modifications as needed.
-
-# when you are finished, create the new patch 
-git diff -- Neos.Fusion.Afx/ > ../../rector/scripts/afx-eel-positions.patch
-
-# ... and reset the code changes inside Neos.Fusion.Afx.
-git restore -- Neos.Fusion.Afx/
+composer tests
 ```
 
 ## Generating docs

composer.json

@@ -16,15 +16,14 @@
         "tests": "phpunit tests"
     },
     "require": {
-        "php": "8.0.* || 8.1.* || 8.2.* || 8.3.*",
-        "rector/rector": "0.15.25",
-        "phpstan/phpstan": "1.10.14",
+        "php": "^8.3",
+        "rector/rector": "^2.0",
         "symfony/yaml": "*",
         "neos/utility-arrays": "*",
         "webmozart/assert": "^1.11"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.5",
-        "symplify/rule-doc-generator": "^11.1"
+        "phpunit/phpunit": "^12.0",
+        "symplify/rule-doc-generator": "^12.2"
     }
 }