ci: add rector

Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>

Author: neilime

.github/workflows/__shared-ci.yml

@@ -24,25 +24,25 @@ jobs:
           php-version: ${{ matrix.php-versions }}
           extensions: none,iconv,dom,curl,mbstring,tokenizer,xml,xmlwriter,simplexml,ctype
           coverage: pcov
-  
+
       - name: ♻️ Get composer cache directory
         id: composer-cache
         shell: bash
         run: echo "dir=$(composer config cache-files-dir)" >> "$GITHUB_OUTPUT"
-  
+
       - name: ♻️ Cache composer dependencies
         uses: actions/cache@v4
         with:
           path: ${{ steps.composer-cache.outputs.dir }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
           restore-keys: ${{ runner.os }}-composer-
-  
+
       - name: ⚙️ Install dependencies
         shell: bash
         run: |
           composer install --no-progress --prefer-dist --optimize-autoloader
           composer --working-dir=tools install --no-progress --prefer-dist --optimize-autoloader
-  
+
       - name: ♻️ Tools cache
         uses: actions/cache@v4
         with:
@@ -55,9 +55,57 @@ jobs:
         if: matrix.stable
         run: composer php-cs-fixer -- --format=checkstyle | tools/vendor/bin/cs2pr
 
+      - name: 🔬 Rector
+        id: rector
+        if: matrix.stable
+        run: |
+          REPORT=$(composer rector -- --output-format json || true)
+          echo "report<<EOF" >> "$GITHUB_OUTPUT" && echo "$REPORT" >> "$GITHUB_OUTPUT" && echo "EOF" >> "$GITHUB_OUTPUT"
+
+      - uses: actions/github-script@v6
+        if: matrix.stable
+        with:
+          script: |
+            const report = ${{ steps.rector.outputs.report }}
+
+            core.startGroup('Rector report')
+
+            for(const fileDiff of report.file_diffs) {
+              const message = fileDiff.diff;
+
+              const title = fileDiff.applied_rectors.join(' / ').trim();
+              const file = fileDiff.file;
+
+              // Extract line start and end, and column start and end from fileDiff.diff (diff format)
+              const diffMeta = fileDiff.diff.match(/@@ -(\d+),(\d+) \+(\d+),(\d+) @@/);
+              if (!diffMeta) {
+                core.error(`Could not parse diff for file: ${fileDiff.file}`);
+                continue;
+              }
+
+              const startLine = parseInt(diffMeta[1], 10);
+              const endLine = startLine + parseInt(diffMeta[2], 10) - 1;
+              const startColumn = 1;
+              const endColumn = undefined;
+
+              core.error(
+                message,
+                {
+                  title,
+                  file,
+                  startLine,
+                  endLine,
+                  startColumn,
+                  endColumn,
+                },
+              );
+            }
+
+            core.endGroup();
+
       - name: 🔬 Static analysis
         if: matrix.stable
-        run: composer stan -- --error-format=checkstyle | tools/vendor/bin/cs2pr
+        run: composer stan -- --error-format=github
 
       - name: ♻️ Tests cache
         uses: actions/cache@v4
@@ -66,7 +114,7 @@ jobs:
           key: ${{ runner.os }}-tests-${{ github.sha }}
           restore-keys: |
             ${{ runner.os }}-tests-
-      
+
       - name: 🧪 Test
         run: composer test:ci
 

Makefile

@@ -34,7 +34,13 @@ lint: ## Execute lint for given PHP version
 	@$(call run-php,composer php-cs-fixer $(filter-out $@,$(MAKECMDGOALS)))
 
 lint-fix: ## Execute lint fixing for given PHP version
-	@$(call run-php,composer php-cs-fixer:fix $(filter-out $@,$(MAKECMDGOALS)))
+	@$(call run-php,composer php-cs-fixer:fix $(filter-out $@,$(MAKECMDGOALS)))	
+
+rector: ## Execute rector for given PHP version
+	@$(call run-php,composer rector $(filter-out $@,$(MAKECMDGOALS)))
+
+rector-fix: ## Execute rector fixing for given PHP version
+	@$(call run-php,composer rector:fix $(filter-out $@,$(MAKECMDGOALS)))
 
 stan: ## Execute PHPStan for given PHP version
 	@$(call run-php,composer stan $(filter-out $@,$(MAKECMDGOALS)))

composer.json

@@ -49,9 +49,12 @@
     "test:ci": "@test -d pcov.enabled=1 -d max_execution_time=0 --coverage-text --coverage-clover ./build/logs/clover.xml --coverage-html ./build/coverage/",
     "php-cs-fixer": "@php-cs-fixer:fix --dry-run",
     "php-cs-fixer:fix": "tools/vendor/bin/php-cs-fixer fix --show-progress=dots --diff --config=.php-cs-fixer.dist.php",
-    "stan": "tools/vendor/bin/phpstan analyse --level 5 src",
+    "rector": "@rector:fix --dry-run",
+    "rector:fix": "tools/vendor/bin/rector process src",
+    "stan": "tools/vendor/bin/phpstan analyse --level max src",
     "ci": [
       "@php-cs-fixer",
+      "@rector",
       "@stan",
       "@test:ci"
     ]

rector.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Caching\ValueObject\Storage\FileCacheStorage;
+use Rector\Config\RectorConfig;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->withPhpSets()
+    ->withCache(
+        cacheClass: FileCacheStorage::class,
+        cacheDirectory: __DIR__ . '/tools/cache/rector'
+    );;

src/CssLint/CliArgs.php

@@ -9,22 +9,22 @@ class CliArgs
 
     /**
      * Constructor
-     * @param array $aArguments arguments to be parsed (@see $_SERVER['argv'])
+     * @param array $arguments arguments to be parsed (@see $_SERVER['argv'])
      *              Accepts "-o", "--options" '{}'
      *              Accepts a string as last argument, a file path or a string containing CSS
      */
-    public function __construct(array $aArguments)
+    public function __construct(array $arguments)
     {
-        if (empty($aArguments) || count($aArguments) === 1) {
+        if (empty($arguments) || count($arguments) === 1) {
             return;
         }
 
-        array_shift($aArguments);
+        array_shift($arguments);
 
-        $this->filePathOrCssString = array_pop($aArguments);
+        $this->filePathOrCssString = array_pop($arguments);
 
-        if ($aArguments) {
-            $aParsedArguments = $this->extractArguments($aArguments);
+        if ($arguments) {
+            $aParsedArguments = $this->extractArguments($arguments);
 
             if (!empty($aParsedArguments['options'])) {
                 $this->options = $aParsedArguments['options'];
@@ -33,14 +33,14 @@ public function __construct(array $aArguments)
     }
 
     /**
-     * @param array $aArguments array of arguments to be parsed (@see $_SERVER['argv'])
+     * @param array $arguments array of arguments to be parsed (@see $_SERVER['argv'])
      * @return array an associative array of key=>value arguments
      */
-    private function extractArguments(array $aArguments): array
+    private function extractArguments(array $arguments): array
     {
         $aParsedArguments = [];
 
-        foreach ($aArguments as $sArgument) {
+        foreach ($arguments as $sArgument) {
             // --foo --bar=baz
             if (substr($sArgument, 0, 2) == '--') {
                 $sEqualPosition = strpos($sArgument, '=');

tools/composer.json

@@ -1,14 +1,15 @@
 {
-    "require": {
-      "friendsofphp/php-cs-fixer": "^3.68",
-      "phpstan/extension-installer": "^1.4",
-      "phpstan/phpstan": "^1.12",
-      "phpstan/phpstan-phpunit": "^1.4",
-      "staabm/annotate-pull-request-from-checkstyle": "^1.8"
-    },
-    "config": {
-      "allow-plugins": {
-        "phpstan/extension-installer": true
-      }
+  "require": {
+    "friendsofphp/php-cs-fixer": "^3.68",
+    "phpstan/extension-installer": "^1.4",
+    "phpstan/phpstan": "^1.12",
+    "phpstan/phpstan-phpunit": "^1.4",
+    "staabm/annotate-pull-request-from-checkstyle": "^1.8",
+    "rector/rector": "^1.2"
+  },
+  "config": {
+    "allow-plugins": {
+      "phpstan/extension-installer": true
     }
-  }
+  }
+}