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
123 changes: 123 additions & 0 deletions bin/list-unused-rules.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
<?php

declare(strict_types=1);

use Nette\Loaders\RobotLoader;
use Rector\Bridge\SetRectorsResolver;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Console\Output\ConsoleOutput;
use Symfony\Component\Console\Style\SymfonyStyle;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Finder\SplFileInfo;
use Webmozart\Assert\Assert;

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

// 1. find all rector rules in here and in all vendor/rector dirs
$rectorClassFinder = new RectorClassFinder();

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

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

$rectorSeFinder = new RectorSetFinder();

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

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

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

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

$unusedRectorRules = array_diff($rectorClasses, $usedRectorRules);
$symfonyStyle->writeln(
sprintf('<fg=yellow;options=bold>Found %d Rector rules not in any set</>', count($unusedRectorRules))
);

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

final class RectorClassFinder
{
/**
* @param string[] $dirs
* @return string[]
*/
public function find(array $dirs): array
{
$robotLoader = new RobotLoader();
$robotLoader->acceptFiles = ['*Rector.php'];
$robotLoader->addDirectory(...$dirs);

$robotLoader->setTempDirectory(sys_get_temp_dir() . '/rector-rules');
$robotLoader->refresh();

return array_keys($robotLoader->getIndexedClasses());
}
}

final class RectorSetFinder
{
/**
* @param string[] $configDirs
* @return string[]
*/
public function find(array $configDirs): array
{
Assert::allString($configDirs);
Assert::allDirectory($configDirs);

// find set files
$finder = (new Finder())->in($configDirs)
->files()
->name('*.php');

/** @var SplFileInfo[] $setFileInfos */
$setFileInfos = iterator_to_array($finder->getIterator());

$setFiles = [];
foreach ($setFileInfos as $setFileInfo) {
$setFiles[] = $setFileInfo->getRealPath();
}

return $setFiles;
}
}

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);
}
}
3 changes: 3 additions & 0 deletions composer-dependency-analyser.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
// ensure use version ^3.2.0
->ignoreErrorsOnPackage('composer/pcre', [ErrorType::UNUSED_DEPENDENCY])

// use din /bin, but only local script
->ignoreErrorsOnPackage('nette/robot-loader', [ErrorType::DEV_DEPENDENCY_IN_PROD])

->ignoreErrorsOnPaths([
__DIR__ . '/stubs',
__DIR__ . '/tests',
Expand Down
1 change: 1 addition & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
"webmozart/assert": "^1.11"
},
"require-dev": {
"nette/robot-loader": "^4.1",
"php-parallel-lint/php-parallel-lint": "^1.4",
"phpecs/phpecs": "^2.2",
"phpstan/extension-installer": "^1.4",
Expand Down
4 changes: 4 additions & 0 deletions phpstan.neon
Original file line number Diff line number Diff line change
Expand Up @@ -354,3 +354,7 @@ parameters:
path: src/CustomRules/SimpleNodeDumper.php

- '#Method Rector\\Utils\\Rector\\RemoveRefactorDuplicatedNodeInstanceCheckRector\:\:getInstanceofNodeClass\(\) should return class\-string<PhpParser\\Node>\|null but returns class\-string#'

-
path: bin/list-unused-rules.php
identifier: symplify.multipleClassLikeInFile
17 changes: 2 additions & 15 deletions src/Console/Command/ListRulesCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@

use Nette\Utils\Json;
use Rector\ChangesReporting\Output\ConsoleOutputFormatter;
use Rector\Configuration\ConfigurationRuleFilter;
use Rector\Configuration\OnlyRuleResolver;
use Rector\Configuration\Option;
use Rector\Contract\Rector\RectorInterface;
use Rector\PostRector\Contract\Rector\PostRectorInterface;
Expand All @@ -26,8 +24,6 @@ final class ListRulesCommand extends Command
public function __construct(
private readonly SymfonyStyle $symfonyStyle,
private readonly SkippedClassResolver $skippedClassResolver,
private readonly OnlyRuleResolver $onlyRuleResolver,
private readonly ConfigurationRuleFilter $configurationRuleFilter,
private readonly array $rectors
) {
parent::__construct();
Expand All @@ -53,12 +49,7 @@ protected function configure(): void

protected function execute(InputInterface $input, OutputInterface $output): int
{
$onlyRule = $input->getOption(Option::ONLY);
if ($onlyRule !== null) {
$onlyRule = $this->onlyRuleResolver->resolve($onlyRule);
}

$rectorClasses = $this->resolveRectorClasses($onlyRule);
$rectorClasses = $this->resolveRectorClasses();

$skippedClasses = $this->getSkippedCheckers();

Expand Down Expand Up @@ -90,17 +81,13 @@ protected function execute(InputInterface $input, OutputInterface $output): int
/**
* @return array<class-string<RectorInterface>>
*/
private function resolveRectorClasses(?string $onlyRule): array
private function resolveRectorClasses(): array
{
$customRectors = array_filter(
$this->rectors,
static fn (RectorInterface $rector): bool => ! $rector instanceof PostRectorInterface
);

if ($onlyRule !== null) {
$customRectors = $this->configurationRuleFilter->filterOnlyRule($customRectors, $onlyRule);
}

$rectorClasses = array_map(static fn (RectorInterface $rector): string => $rector::class, $customRectors);
sort($rectorClasses);

Expand Down