Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 75 additions & 0 deletions scripts/list-non-composer-based-rules.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<?php

declare(strict_types=1);

use Rector\Scripts\Finder\RectorClassFinder;
use Rector\Scripts\Finder\RectorSetFilesFinder;
use Rector\Scripts\Resolver\UsedRectorClassResolver;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Console\Output\ConsoleOutput;
use Symfony\Component\Console\Style\SymfonyStyle;

require __DIR__ . '/../vendor/autoload.php';

// 1. find all rector rules in doctrine, phpunit and symfony packages; core rules are not package-version bound
$rectorClassFinder = new RectorClassFinder();

$rectorClasses = $rectorClassFinder->find([
__DIR__ . '/../vendor/rector/rector-doctrine',
__DIR__ . '/../vendor/rector/rector-phpunit',
__DIR__ . '/../vendor/rector/rector-symfony',
]);

$symfonyStyle = new SymfonyStyle(new ArrayInput([]), new ConsoleOutput());
$symfonyStyle->writeln(sprintf('<fg=green>Found Rector %d rules</>', count($rectorClasses)));

// 2. find "composer-based.php" sets, that bind rules to the installed package version
$rectorSetFilesFinder = new RectorSetFilesFinder();

$rectorSetFiles = $rectorSetFilesFinder->find([
__DIR__ . '/../vendor/rector/rector-symfony/config/sets',
__DIR__ . '/../vendor/rector/rector-doctrine/config/sets',
__DIR__ . '/../vendor/rector/rector-phpunit/config/sets',
]);

$composerBasedSetFiles = array_filter(
$rectorSetFiles,
static fn (string $rectorSetFile): bool => basename($rectorSetFile) === 'composer-based.php'
);

$symfonyStyle->writeln(sprintf('<fg=green>Found %d composer-based sets</>', count($composerBasedSetFiles)));
$symfonyStyle->listing($composerBasedSetFiles);

$usedRectorClassResolver = new UsedRectorClassResolver();
$usedRectorRules = $usedRectorClassResolver->resolve($composerBasedSetFiles);

$symfonyStyle->writeln(
sprintf('<fg=yellow>Found %d Rector rules used in composer-based sets</>', count($usedRectorRules))
);

// these rules are not bound to any package version, so they never belong to a composer-based set
$versionAgnosticSetFileNames = ['code-quality.php', 'typed-collections.php', 'typed-collections-docblocks.php'];

$versionAgnosticSetFiles = array_filter($rectorSetFiles, static fn (string $rectorSetFile): bool => array_any($versionAgnosticSetFileNames, fn (string $versionAgnosticSetFileName): bool => str_ends_with(basename($rectorSetFile), $versionAgnosticSetFileName)));

$versionAgnosticRectorRules = $usedRectorClassResolver->resolve($versionAgnosticSetFiles);

$symfonyStyle->writeln(
sprintf(
'<fg=yellow>Found %d Rector rules used in version-agnostic sets</>',
count($versionAgnosticRectorRules)
)
);

$nonComposerBasedRectorRules = array_diff($rectorClasses, $usedRectorRules, $versionAgnosticRectorRules);

$symfonyStyle->newLine();
$symfonyStyle->listing($nonComposerBasedRectorRules);

$symfonyStyle->writeln(
sprintf(
'<fg=yellow;options=bold>Found %d Rector rules not in any composer-based set, likely dead</>',
count($nonComposerBasedRectorRules)
)
);
$symfonyStyle->newLine();
24 changes: 1 addition & 23 deletions scripts/list-unused-rules.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

declare(strict_types=1);

use Rector\Bridge\SetRectorsResolver;
use Rector\Contract\Rector\ConfigurableRectorInterface;
use Rector\Scripts\Finder\RectorClassFinder;
use Rector\Scripts\Finder\RectorSetFilesFinder;
use Rector\Scripts\Resolver\UsedRectorClassResolver;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Console\Output\ConsoleOutput;
use Symfony\Component\Console\Style\SymfonyStyle;
Expand Down Expand Up @@ -64,25 +64,3 @@
sprintf('<fg=green>Skipped %d configurable Rector rules</>', count($configurableRectorRules))
);
$symfonyStyle->newLine();

final class UsedRectorClassResolver
{
/**
* @param string[] $rectorSetFiles
* @return string[]
*/
public function resolve(array $rectorSetFiles): array
{
$setRectorsResolver = new SetRectorsResolver();
$rulesConfiguration = $setRectorsResolver->resolveFromFilePathsIncludingConfiguration($rectorSetFiles);

$usedRectorRules = [];
foreach ($rulesConfiguration as $ruleConfiguration) {
$usedRectorRules[] = is_string($ruleConfiguration) ? $ruleConfiguration : array_keys($ruleConfiguration)[0];
}

sort($usedRectorRules);

return array_unique($usedRectorRules);
}
}
22 changes: 22 additions & 0 deletions scripts/src/Finder/RectorClassFinder.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

namespace Rector\Scripts\Finder;

use Deprecated;
use Nette\Loaders\RobotLoader;
use Rector\Configuration\Deprecation\Contract\DeprecatedInterface;
use ReflectionClass;
Expand Down Expand Up @@ -39,9 +40,30 @@ public function find(array $dirs): array
continue;
}

if ($this->isDeprecated($rectorClassReflection)) {
continue;
}

$usableRectorClasses[] = $rectorClass;
}

return $usableRectorClasses;
}

/**
* @param ReflectionClass<object> $reflectionClass
*/
private function isDeprecated(ReflectionClass $reflectionClass): bool
{
if ($reflectionClass->getAttributes(Deprecated::class) !== []) {
return true;
}

$docComment = $reflectionClass->getDocComment();
if (! is_string($docComment)) {
return false;
}

return str_contains($docComment, '@deprecated');
}
}
29 changes: 29 additions & 0 deletions scripts/src/Resolver/UsedRectorClassResolver.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?php

declare(strict_types=1);

namespace Rector\Scripts\Resolver;

use Rector\Bridge\SetRectorsResolver;

final class UsedRectorClassResolver
{
/**
* @param string[] $rectorSetFiles
* @return string[]
*/
public function resolve(array $rectorSetFiles): array
{
$setRectorsResolver = new SetRectorsResolver();
$rulesConfiguration = $setRectorsResolver->resolveFromFilePathsIncludingConfiguration($rectorSetFiles);

$usedRectorRules = [];
foreach ($rulesConfiguration as $ruleConfiguration) {
$usedRectorRules[] = is_string($ruleConfiguration) ? $ruleConfiguration : array_keys($ruleConfiguration)[0];
}

sort($usedRectorRules);

return array_unique($usedRectorRules);
}
}
8 changes: 8 additions & 0 deletions src/Configuration/RectorConfigBuilder.php
Original file line number Diff line number Diff line change
Expand Up @@ -754,6 +754,14 @@ public function withComposerBased(
$this->sets[] = PHPUnitSetList::COMPOSER_BASED;
}

if ($doctrine) {
// $this->sets[] = DoctrineSetList::COMPOSER_BASED;
}

if ($twig) {
// $this->sets[] = TwigSetList::COMPOSER_BASED;
}

if ($symfony) {
// single set, as every rule inside is bound to the installed Symfony package version on its own
$this->sets[] = SymfonySetList::COMPOSER_BASED;
Expand Down
Loading