Skip to content

[Console] Deprecate list-rules command #8396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TomasVotruba merged 1 commit into from
Aug 28, 2026
Merged

[Console] Deprecate list-rules command #8396

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
89 changes: 5 additions & 84 deletions src/Console/Command/ListRulesCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,112 +4,33 @@

namespace Rector\Console\Command;

use Nette\Utils\Json;
use Rector\ChangesReporting\Output\ConsoleOutputFormatter;
use Rector\Configuration\Option;
use Rector\Contract\Rector\RectorInterface;
use Rector\PostRector\Contract\Rector\PostRectorInterface;
use Rector\Skipper\SkipCriteriaResolver\SkippedClassResolver;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;

final class ListRulesCommand extends Command
{
/**
* @param RectorInterface[] $rectors
*/
public function __construct(
private readonly SymfonyStyle $symfonyStyle,
private readonly SkippedClassResolver $skippedClassResolver,
private readonly array $rectors
private readonly SymfonyStyle $symfonyStyle
) {
parent::__construct();
}

protected function configure(): void
{
$this->setName('list-rules');
$this->setDescription('Show loaded Rectors');
$this->setDescription('[DEPRECATED] Show loaded Rectors');

$this->setAliases(['show-rules']);

$this->addOption(
Option::OUTPUT_FORMAT,
null,
InputOption::VALUE_REQUIRED,
'Select output format',
ConsoleOutputFormatter::NAME
);

$this->addOption(Option::ONLY, null, InputOption::VALUE_REQUIRED, 'Fully qualified rule class name');
}

protected function execute(InputInterface $input, OutputInterface $output): int
{
$rectorClasses = $this->resolveRectorClasses();

$skippedClasses = $this->getSkippedRectorClasses();

$outputFormat = $input->getOption(Option::OUTPUT_FORMAT);
if ($outputFormat === 'json') {
$data = [
'rectors' => $rectorClasses,
'skipped-rectors' => $skippedClasses,
];

echo Json::encode($data, pretty: true) . PHP_EOL;
return Command::SUCCESS;
}

$this->symfonyStyle->title('Loaded Rector rules');
$this->symfonyStyle->listing($rectorClasses);

if ($skippedClasses !== []) {
$this->symfonyStyle->title('Skipped Rector rules');
$this->symfonyStyle->listing($skippedClasses);
}

$this->symfonyStyle->newLine();
$this->symfonyStyle->note(sprintf('Loaded %d rules', count($rectorClasses)));

return Command::SUCCESS;
}

/**
* @return array<class-string<RectorInterface>>
*/
private function resolveRectorClasses(): array
{
$customRectors = array_filter(
$this->rectors,
static fn (RectorInterface $rector): bool => ! $rector instanceof PostRectorInterface
$this->symfonyStyle->error(
'The "list-rules" command is deprecated and no longer provided. Run Rector with the set or rules you desire instead.'
);

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

return array_unique($rectorClasses);
}

/**
* @return array<class-string>
*/
private function getSkippedRectorClasses(): array
{
$skippedRectorClasses = [];

foreach ($this->skippedClassResolver->resolve() as $rectorClass => $fileList) {
// ignore specific skips
if ($fileList !== null) {
continue;
}

$skippedRectorClasses[] = $rectorClass;
}

return $skippedRectorClasses;
return Command::FAILURE;
}
}
Loading