[DX] Make configurable include post rector classes in result

Author: samsonasik

config/config.php

@@ -46,4 +46,6 @@
     $rectorConfig->reportingRealPath(false);
 
     $rectorConfig->treatClassesAsFinal(false);
+
+    $rectorConfig->includePostRectorsInReports(false);
 };

e2e/applied-auto-import/expected-output.diff

@@ -23,6 +23,10 @@
 
 Applied rules:
  * RenameClassRector
+ * DocblockNameImportingPostRector
+ * NameImportingPostRector
+ * UnusedImportRemovingPostRector
+ * UseAddingPostRector
 
 
  [OK] 1 file would have been changed (dry-run) by Rector

e2e/applied-auto-import/rector.php

@@ -16,4 +16,5 @@
 
     $rectorConfig->importNames();
     $rectorConfig->removeUnusedImports();
+    $rectorConfig->includePostRectorsInReports(true);
 };

src/Config/RectorConfig.php

@@ -451,4 +451,9 @@ public function setOverflowLevels(array $levelOverflows): void
     {
         SimpleParameterProvider::addParameter(Option::LEVEL_OVERFLOWS, $levelOverflows);
     }
+
+    public function includePostRectorsInReports(bool $includePostRectorsInReports = true): void
+    {
+        SimpleParameterProvider::setParameter(Option::INCLUDE_POST_RECTORS_IN_REPORTS, $includePostRectorsInReports);
+    }
 }

src/Configuration/Option.php

@@ -327,4 +327,9 @@ final class Option
      * @var string
      */
     public const KAIZEN = 'kaizen';
+
+    /**
+     * @var string
+     */
+    public const INCLUDE_POST_RECTORS_IN_REPORTS = 'include_post_rectors_in_reports';
 }

src/Configuration/RectorConfigBuilder.php

@@ -177,6 +177,8 @@ final class RectorConfigBuilder
 
     private ?bool $isWithPhpLevelUsed = null;
 
+    private ?bool $includePostRectorsInReports = null;
+
     /**
      * @var array<class-string<SetProviderInterface>,bool>
      */
@@ -390,6 +392,10 @@ public function __invoke(RectorConfig $rectorConfig): void
         if ($this->levelOverflows !== []) {
             $rectorConfig->setOverflowLevels($this->levelOverflows);
         }
+
+        if ($this->includePostRectorsInReports !== null) {
+            $rectorConfig->includePostRectorsInReports($this->includePostRectorsInReports);
+        }
     }
 
     /**
@@ -1291,4 +1297,10 @@ public function withSetProviders(string ...$setProviders): self
 
         return $this;
     }
+
+    public function withIncludePostRectorsInReports(bool $includePostRectorsInReports = true): self
+    {
+        $this->includePostRectorsInReports = $includePostRectorsInReports;
+        return $this;
+    }
 }

src/Testing/PHPUnit/ValueObject/RectorTestResult.php

@@ -5,6 +5,7 @@
 namespace Rector\Testing\PHPUnit\ValueObject;
 
 use Rector\Contract\Rector\RectorInterface;
+use Rector\PostRector\Contract\Rector\PostRectorInterface;
 use Rector\Util\RectorClassesSorter;
 use Rector\ValueObject\ProcessResult;
 
@@ -25,7 +26,7 @@ public function getChangedContents(): string
     }
 
     /**
-     * @return array<class-string<RectorInterface>>
+     * @return array<class-string<RectorInterface|PostRectorInterface>>
      */
     public function getAppliedRectorClasses(): array
     {
@@ -35,6 +36,6 @@ public function getAppliedRectorClasses(): array
             $rectorClasses = array_merge($rectorClasses, $fileDiff->getRectorClasses());
         }
 
-        return RectorClassesSorter::sortAndFilterOutPostRectors($rectorClasses);
+        return RectorClassesSorter::sort($rectorClasses);
     }
 }

src/Util/RectorClassesSorter.php

@@ -4,16 +4,18 @@
 
 namespace Rector\Util;
 
+use Rector\Configuration\Option;
+use Rector\Configuration\Parameter\SimpleParameterProvider;
 use Rector\Contract\Rector\RectorInterface;
 use Rector\PostRector\Contract\Rector\PostRectorInterface;
 
 final class RectorClassesSorter
 {
     /**
      * @param array<class-string<RectorInterface|PostRectorInterface>> $rectorClasses
-     * @return array<class-string<RectorInterface>>
+     * @return array<class-string<RectorInterface|PostRectorInterface>>
      */
-    public static function sortAndFilterOutPostRectors(array $rectorClasses): array
+    public static function sort(array $rectorClasses): array
     {
         $rectorClasses = array_unique($rectorClasses);
 
@@ -23,6 +25,16 @@ public static function sortAndFilterOutPostRectors(array $rectorClasses): array
         );
         sort($mainRectorClasses);
 
+        if (SimpleParameterProvider::provideBoolParameter(Option::INCLUDE_POST_RECTORS_IN_REPORTS)) {
+            $postRectorClasses = array_filter(
+                $rectorClasses,
+                fn (string $rectorClass): bool => is_a($rectorClass, PostRectorInterface::class, true)
+            );
+            sort($postRectorClasses);
+
+            return array_merge($mainRectorClasses, $postRectorClasses);
+        }
+
         return $mainRectorClasses;
     }
 }

src/ValueObject/Reporting/FileDiff.php

@@ -8,6 +8,7 @@
 use Rector\ChangesReporting\ValueObject\RectorWithLineChange;
 use Rector\Contract\Rector\RectorInterface;
 use Rector\Parallel\ValueObject\BridgeItem;
+use Rector\PostRector\Contract\Rector\PostRectorInterface;
 use Rector\Util\RectorClassesSorter;
 use Symplify\EasyParallel\Contract\SerializableInterface;
 use Webmozart\Assert\Assert;
@@ -82,7 +83,7 @@ public function getRectorShortClasses(): array
     }
 
     /**
-     * @return array<class-string<RectorInterface>>
+     * @return array<class-string<RectorInterface|PostRectorInterface>>
      */
     public function getRectorClasses(): array
     {
@@ -92,7 +93,7 @@ public function getRectorClasses(): array
             $rectorClasses[] = $rectorWithLineChange->getRectorClass();
         }
 
-        return RectorClassesSorter::sortAndFilterOutPostRectors($rectorClasses);
+        return RectorClassesSorter::sort($rectorClasses);
     }
 
     public function getFirstLineNumber(): ?int