[dx] log rules registered in both withRules() and sets, keep them once to avoid duplications or invalid use

Author: TomasVotruba

config/set/php-polyfills.php

@@ -10,14 +10,17 @@
 use Rector\Php80\Rector\NotIdentical\StrContainsRector;
 use Rector\Php80\Rector\Ternary\GetDebugTypeRector;
 
+// @note longer rule registration must be used here, to separate from withRules() from root rector.php
+
 // these rules can be used ahead of PHP version,
 // as long composer.json includes particular symfony/php-polyfill package
-return RectorConfig::configure()
-    ->withRules([
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rules([
         ArrayKeyFirstLastRector::class,
         IsCountableRector::class,
         GetDebugTypeRector::class,
         StrStartsWithRector::class,
         StrEndsWithRector::class,
         StrContainsRector::class,
     ]);
+};

src/Configuration/Option.php

@@ -290,4 +290,15 @@ final class Option
      * @internal To report overflow levels in ->with*Level() methods
      */
     public const LEVEL_OVERFLOWS = 'level_overflows';
+
+    /**
+     * @internal To avoid registering rules via ->withRules(), that are already loaded in sets,
+     * and keep rector.php clean
+     */
+    public const ROOT_STANDALONE_REGISTERED_RULES = 'root_standalone_registered_rules';
+
+    /**
+     * @internal The other half of ROOT_STANDALONE_REGISTERED_RULES to compare
+     */
+    public const SET_REGISTERED_RULES = 'set_registered_rules';
 }

src/Configuration/RectorConfigBuilder.php

@@ -246,6 +246,10 @@ public function __invoke(RectorConfig $rectorConfig): void
             $rectorConfig->sets($uniqueSets);
         }
 
+        // log rules from sets and compare them with explicit rules
+        $setRegisteredRectorClasses = $rectorConfig->getRectorClasses();
+        SimpleParameterProvider::addParameter(Option::SET_REGISTERED_RULES, $setRegisteredRectorClasses);
+
         if ($this->paths !== []) {
             $rectorConfig->paths($this->paths);
         }
@@ -782,6 +786,9 @@ public function withRules(array $rules): self
     {
         $this->rules = array_merge($this->rules, $rules);
 
+        // log all explicitly registered rules
+        SimpleParameterProvider::addParameter(Option::ROOT_STANDALONE_REGISTERED_RULES, $rules);
+
         return $this;
     }
 
@@ -1135,29 +1142,17 @@ public function withDowngradeSets(
 
         if ($php82) {
             $this->sets[] = DowngradeLevelSetList::DOWN_TO_PHP_82;
-        }
-
-        if ($php81) {
+        } elseif ($php81) {
             $this->sets[] = DowngradeLevelSetList::DOWN_TO_PHP_81;
-        }
-
-        if ($php80) {
+        } elseif ($php80) {
             $this->sets[] = DowngradeLevelSetList::DOWN_TO_PHP_80;
-        }
-
-        if ($php74) {
+        } elseif ($php74) {
             $this->sets[] = DowngradeLevelSetList::DOWN_TO_PHP_74;
-        }
-
-        if ($php73) {
+        } elseif ($php73) {
             $this->sets[] = DowngradeLevelSetList::DOWN_TO_PHP_73;
-        }
-
-        if ($php72) {
+        } elseif ($php72) {
             $this->sets[] = DowngradeLevelSetList::DOWN_TO_PHP_72;
-        }
-
-        if ($php71) {
+        } elseif ($php71) {
             $this->sets[] = DowngradeLevelSetList::DOWN_TO_PHP_71;
         }
 

src/Console/Command/ProcessCommand.php

@@ -22,6 +22,7 @@
 use Rector\StaticReflection\DynamicSourceLocatorDecorator;
 use Rector\Util\MemoryLimiter;
 use Rector\ValueObject\Configuration;
+use Rector\ValueObject\Configuration\LevelOverflow;
 use Rector\ValueObject\ProcessResult;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Command\Command;
@@ -101,18 +102,16 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         // 0. warn about too high levels
         foreach ($configuration->getLevelOverflows() as $levelOverflow) {
-            $suggestedSetMethod = PHP_VERSION_ID >= 80000 ? sprintf(
-                '->withPreparedSets(%s: true)',
-                $levelOverflow->getSuggestedRuleset()
-            ) : sprintf('->withSets(SetList::%s)', $levelOverflow->getSuggestedSetListConstant());
+            $this->reportLevelOverflow($levelOverflow);
+        }
 
+        // 0. warn about rules registered in both withRules() and sets to avoid bloated rector.php configs
+        $setAndRulesDuplicatedRegistrations = $configuration->getBothSetAndRulesDuplicatedRegistrations();
+        if ($setAndRulesDuplicatedRegistrations !== []) {
             $this->symfonyStyle->warning(sprintf(
-                'The "->%s()" level contains only %d rules, but you set level to %d.%sYou are using the full set now! Time to switch to more efficient "%s".',
-                $levelOverflow->getConfigurationName(),
-                $levelOverflow->getRuleCount(),
-                $levelOverflow->getLevel(),
-                PHP_EOL,
-                $suggestedSetMethod,
+                'These rules are registered in both sets and "withRules()". Remove them from "withRules()" to avoid duplications: %s* %s',
+                PHP_EOL . PHP_EOL,
+                implode(' * ', $setAndRulesDuplicatedRegistrations) . PHP_EOL
             ));
         }
 
@@ -225,4 +224,21 @@ private function reportLoadedComposerBasedSets(): void
         $this->symfonyStyle->writeln('[info] Sets loaded based on installed packages:');
         $this->symfonyStyle->listing($composerBasedSets);
     }
+
+    private function reportLevelOverflow(LevelOverflow $levelOverflow): void
+    {
+        $suggestedSetMethod = PHP_VERSION_ID >= 80000 ? sprintf(
+            '->withPreparedSets(%s: true)',
+            $levelOverflow->getSuggestedRuleset()
+        ) : sprintf('->withSets(SetList::%s)', $levelOverflow->getSuggestedSetListConstant());
+
+        $this->symfonyStyle->warning(sprintf(
+            'The "->%s()" level contains only %d rules, but you set level to %d.%sYou are using the full set now! Time to switch to more efficient "%s".',
+            $levelOverflow->getConfigurationName(),
+            $levelOverflow->getRuleCount(),
+            $levelOverflow->getLevel(),
+            PHP_EOL,
+            $suggestedSetMethod,
+        ));
+    }
 }

src/ValueObject/Configuration.php

@@ -5,6 +5,8 @@
 namespace Rector\ValueObject;
 
 use Rector\ChangesReporting\Output\ConsoleOutputFormatter;
+use Rector\Configuration\Option;
+use Rector\Configuration\Parameter\SimpleParameterProvider;
 use Rector\ValueObject\Configuration\LevelOverflow;
 use Webmozart\Assert\Assert;
 
@@ -124,4 +126,18 @@ public function getLevelOverflows(): array
     {
         return $this->levelOverflows;
     }
+
+    /**
+     * @return string[]
+     */
+    public function getBothSetAndRulesDuplicatedRegistrations(): array
+    {
+        $rootStandaloneRegisteredRules = SimpleParameterProvider::provideArrayParameter(
+            Option::ROOT_STANDALONE_REGISTERED_RULES
+        );
+        $setRegisteredRules = SimpleParameterProvider::provideArrayParameter(Option::SET_REGISTERED_RULES);
+
+        // @todo exclude duplitions
+        return array_intersect($rootStandaloneRegisteredRules, $setRegisteredRules);
+    }
 }