[dx] warn early about deprecated skipped rules, as not neccessary to skip anymore

Author: TomasVotruba

rector.php

@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+use Rector\CodingStyle\Rector\FunctionLike\FunctionLikeToFirstClassCallableRector;
 use Rector\CodingStyle\Rector\String_\UseClassKeywordForClassNameResolutionRector;
 use Rector\Config\RectorConfig;
 use Rector\DeadCode\Rector\ConstFetch\RemovePhpVersionIdCheckRector;
@@ -41,6 +42,9 @@
     ->withImportNames(removeUnusedImports: true)
     ->withRules([RemoveRefactorDuplicatedNodeInstanceCheckRector::class, AddSeeTestAnnotationRector::class])
     ->withSkip([
+        // testing skip of deprecated class
+        FunctionLikeToFirstClassCallableRector::class,
+
         StringClassNameToClassConstantRector::class,
         // tests
         '*/Fixture*',

src/Console/Command/ListRulesCommand.php

@@ -51,7 +51,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $rectorClasses = $this->resolveRectorClasses();
 
-        $skippedClasses = $this->getSkippedCheckers();
+        $skippedClasses = $this->getSkippedRectorClasses();
 
         $outputFormat = $input->getOption(Option::OUTPUT_FORMAT);
         if ($outputFormat === 'json') {
@@ -95,20 +95,21 @@ private function resolveRectorClasses(): array
     }
 
     /**
-     * @return string[]
+     * @return array<class-string>
      */
-    private function getSkippedCheckers(): array
+    private function getSkippedRectorClasses(): array
     {
-        $skippedCheckers = [];
-        foreach ($this->skippedClassResolver->resolve() as $checkerClass => $fileList) {
+        $skippedRectorClasses = [];
+
+        foreach ($this->skippedClassResolver->resolve() as $rectorClass => $fileList) {
             // ignore specific skips
             if ($fileList !== null) {
                 continue;
             }
 
-            $skippedCheckers[] = $checkerClass;
+            $skippedRectorClasses[] = $rectorClass;
         }
 
-        return $skippedCheckers;
+        return $skippedRectorClasses;
     }
 }

src/Console/Command/ProcessCommand.php

@@ -19,6 +19,7 @@
 use Rector\Exception\ShouldNotHappenException;
 use Rector\Reporting\DeprecatedRulesReporter;
 use Rector\Reporting\MissConfigurationReporter;
+use Rector\Skipper\SkipCriteriaResolver\SkippedClassResolver;
 use Rector\StaticReflection\DynamicSourceLocatorDecorator;
 use Rector\Util\MemoryLimiter;
 use Rector\ValueObject\Configuration;
@@ -45,6 +46,7 @@ public function __construct(
         private readonly DeprecatedRulesReporter $deprecatedRulesReporter,
         private readonly MissConfigurationReporter $missConfigurationReporter,
         private readonly ConfigurationRuleFilter $configurationRuleFilter,
+        private readonly SkippedClassResolver $skippedClassResolver,
     ) {
         parent::__construct();
     }
@@ -105,6 +107,15 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $this->reportLevelOverflow($levelOverflow);
         }
 
+        // 0. warn about skipped rules that are deprecated
+        if ($this->skippedClassResolver->resolveDeprecatedSkippedClasses() !== []) {
+            $this->symfonyStyle->warning(sprintf(
+                'These rules are skipped, but are deprecated. Most likely you do not need to skip them anymore as not part of any set and remove them: %s* %s',
+                "\n\n",
+                implode(' * ', $this->skippedClassResolver->resolveDeprecatedSkippedClasses()) . "\n"
+            ));
+        }
+
         // 1. warn about rules registered in both withRules() and sets to avoid bloated rector.php configs
         $setAndRulesDuplicatedRegistrations = $configuration->getBothSetAndRulesDuplicatedRegistrations();
         if ($setAndRulesDuplicatedRegistrations !== []) {

src/Skipper/SkipCriteriaResolver/SkippedClassResolver.php

@@ -4,16 +4,32 @@
 
 namespace Rector\Skipper\SkipCriteriaResolver;
 
+use Rector\Configuration\Deprecation\Contract\DeprecatedInterface;
 use Rector\Configuration\Option;
 use Rector\Configuration\Parameter\SimpleParameterProvider;
 use Rector\Testing\PHPUnit\StaticPHPUnitEnvironment;
 
+/**
+ * @see \Rector\Tests\Skipper\Skipper\SkippedClassResolverTest
+ */
 final class SkippedClassResolver
 {
     /**
      * @var null|array<string, string[]|null>
      */
-    private null|array $skippedClasses = null;
+    private null|array $skippedClassesToFiles = null;
+
+    /**
+     * @return array<DeprecatedInterface>
+     */
+    public function resolveDeprecatedSkippedClasses(): array
+    {
+        $skippedClassNames = array_keys($this->resolve());
+
+        return array_filter($skippedClassNames, function (string $class): bool {
+            return is_a($class, DeprecatedInterface::class, true);
+        });
+    }
 
     /**
      * @return array<string, string[]|null>
@@ -22,16 +38,16 @@ public function resolve(): array
     {
         // disable cache in tests
         if (StaticPHPUnitEnvironment::isPHPUnitRun()) {
-            $this->skippedClasses = null;
+            $this->skippedClassesToFiles = null;
         }
 
         // already cached, even only empty array
-        if ($this->skippedClasses !== null) {
-            return $this->skippedClasses;
+        if ($this->skippedClassesToFiles !== null) {
+            return $this->skippedClassesToFiles;
         }
 
         $skip = SimpleParameterProvider::provideArrayParameter(Option::SKIP);
-        $this->skippedClasses = [];
+        $this->skippedClassesToFiles = [];
 
         foreach ($skip as $key => $value) {
             // e.g. [SomeClass::class] → shift values to [SomeClass::class => null]
@@ -49,9 +65,9 @@ public function resolve(): array
                 continue;
             }
 
-            $this->skippedClasses[$key] = $value;
+            $this->skippedClassesToFiles[$key] = $value;
         }
 
-        return $this->skippedClasses;
+        return $this->skippedClassesToFiles;
     }
 }

tests/Skipper/Skipper/SkippedClassResolverTest.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Skipper\Skipper;
+
+use Rector\Skipper\SkipCriteriaResolver\SkippedClassResolver;
+use Rector\Testing\PHPUnit\AbstractLazyTestCase;
+
+final class SkippedClassResolverTest extends AbstractLazyTestCase
+{
+    public function test(): void
+    {
+        $skippedClassResolver = $this->make(SkippedClassResolver::class);
+
+        $this->assertSame([], $skippedClassResolver->resolveDeprecatedSkippedClasses());
+    }
+}