Merge pull request #127 from magento-commerce/AC-1740

AC-1740: Add rectorphp as a dependency to magento-coding-standard and run it as part of the GitHub actions

Author: eliseacornejo

.github/workflows/php.yml

@@ -75,3 +75,20 @@ jobs:
 
       - name: Run ESLint
         run: npm run eslint -- eslint/rules
+  rector:
+    runs-on: ubuntu-latest
+    name: Rector tests
+    
+    steps:
+      - name: Setup node
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+
+      - uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: composer install  
+            
+      - name: Run rector
+        run: vendor/bin/rector process Magento2 Magento2Framework PHP_CodeSniffer --dry-run --autoload-file vendor/squizlabs/php_codesniffer/autoload.php

README.md

@@ -112,6 +112,25 @@ You can execute ESLint as follows:
 npm run eslint -- path/to/analyze
 ```
 
+### RECTOR PHP
+From `magento-condign-standard` project, you can execute rector php as follows:
+```bash
+vendor/bin/rector process Magento2 Magento2Framework PHP_CodeSniffer --dry-run --autoload-file vendor/squizlabs/php_codesniffer/autoload.php
+```
+The rules from rector that are applied are set inside the config file: `rector.php`
+
+The option `--dry-run` displays errors found, but code is not automatically fixed.
+
+To run rector for `magento` projects you need to:
+- Specify the magento path and the autoload file for the magento project: 
+```bash
+vendor/bin/rector process MAGENTO_PATH --dry-run --autoload-file MAGENTO_AUTOLOAD_FILE
+```
+Example:
+```bash
+vendor/bin/rector process magento2ce/app/code/Magento/Cms/Model --dry-run --autoload-file magento2ce/vendor/autoload.php
+```
+
 ## License
 
 Each Magento source file included in this distribution is licensed under the OSL-3.0 license.

composer.json

@@ -13,7 +13,8 @@
         "ext-simplexml": "*",
         "ext-dom": "*",
         "phpcompatibility/php-compatibility": "^9.3",
-        "squizlabs/php_codesniffer": "^3.6"
+        "squizlabs/php_codesniffer": "^3.6",
+        "rector/rector": "^0.12.4"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5.8"

composer.lock

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Core\Configuration\Option;
+use Rector\Core\ValueObject\PhpVersion;
+use Rector\Php80\Rector\Class_\StringableForToStringRector;
+use Rector\Php80\Rector\ClassMethod\FinalPrivateToPrivateVisibilityRector;
+use Rector\Php80\Rector\ClassMethod\OptionalParametersAfterRequiredRector;
+use Rector\Php80\Rector\ClassMethod\SetStateToStaticRector;
+use Rector\Php81\Rector\FuncCall\Php81ResourceReturnToObjectRector;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    // get parameters
+    $parameters = $containerConfigurator->parameters();
+
+    $parameters->set(Option::PHP_VERSION_FEATURES, PhpVersion::PHP_80);
+    $parameters->set(Option::PHP_VERSION_FEATURES, PhpVersion::PHP_81);
+
+    // get services (needed for register a single rule)
+    $services = $containerConfigurator->services();
+
+    // register a single rule
+    $services->set(FinalPrivateToPrivateVisibilityRector::class);
+    $services->set(OptionalParametersAfterRequiredRector::class);
+    $services->set(SetStateToStaticRector::class);
+    $services->set(StringableForToStringRector::class);
+    $services->set(Php81ResourceReturnToObjectRector::class);
+};