[cli] give clean output

Author: TomasVotruba

src/Console/Command/CleanListCommand.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Jack\Console\Command;
+
+use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Command\ListCommand;
+use Symfony\Component\Console\Descriptor\ApplicationDescription;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Webmozart\Assert\Assert;
+
+/**
+ * Simple command list, without bloated options
+ */
+final class CleanListCommand extends ListCommand
+{
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        Assert::isInstanceOf($this->getApplication(), Application::class);
+
+        $output->writeln($this->getApplication()->getName());
+        $output->writeln('');
+        $output->writeln('<comment>Available commands:</>');
+
+        $applicationDescription = new ApplicationDescription($this->getApplication());
+        $this->describeCommands($applicationDescription, $output);
+
+        return self::SUCCESS;
+    }
+
+    /**
+     * @param non-empty-array<Command> $commands
+     */
+    private function resolveCommandNameColumnWidth(array $commands): int
+    {
+        $commandNameLengths = [];
+        foreach ($commands as $command) {
+            $commandNameLengths[] = strlen((string) $command->getName());
+        }
+
+        return max($commandNameLengths) + 4;
+    }
+
+    private function describeCommands(ApplicationDescription $applicationDescription, OutputInterface $output): void
+    {
+        if ($applicationDescription->getCommands() === []) {
+            return;
+        }
+
+        $commands = $applicationDescription->getCommands();
+        $commandNameColumnWidth = $this->resolveCommandNameColumnWidth($commands);
+
+        foreach ($commands as $command) {
+            $spacingWidth = $commandNameColumnWidth - strlen((string) $command->getName());
+
+            $output->writeln(sprintf(
+                '  <info>%s</>%s%s',
+                $command->getName(),
+                str_repeat(' ', $spacingWidth),
+                $command->getDescription()
+            ));
+        }
+    }
+}

src/Console/JackConsoleApplication.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Jack\Console;
+
+use Rector\Jack\Console\Command\CleanListCommand;
+use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Command\CompleteCommand;
+use Symfony\Component\Console\Command\DumpCompletionCommand;
+use Symfony\Component\Console\Command\HelpCommand;
+
+final class JackConsoleApplication extends Application
+{
+    protected function getDefaultCommands(): array
+    {
+        return [
+            new HelpCommand(),
+            new CompleteCommand(),
+            new DumpCompletionCommand(),
+
+            // clean list, without bloated options
+            new CleanListCommand(),
+        ];
+    }
+}

src/DependencyInjection/ContainerFactory.php

@@ -5,6 +5,7 @@
 namespace Rector\Jack\DependencyInjection;
 
 use Illuminate\Container\Container;
+use Rector\Jack\Console\JackConsoleApplication;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Output\ConsoleOutput;
@@ -23,7 +24,7 @@ public function create(): Container
 
         // console
         $container->singleton(Application::class, function (Container $container): Application {
-            $application = new Application('Rector Jack');
+            $application = new JackConsoleApplication('Rector Jack');
 
             $commandClasses = $this->findCommandClasses();