Merge pull request #441 from greg0ire/progress-bar

Add progress bar to the run command

Author: jaapio

packages/guides-cli/src/Command/Run.php

@@ -21,9 +21,11 @@
 use phpDocumentor\Guides\Twig\Theme\ThemeManager;
 use RuntimeException;
 use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\ProgressBar;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\ConsoleOutputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
 use function array_pop;
@@ -89,6 +91,14 @@ public function __construct(
             'The theme used for rendering.',
             'default',
         );
+
+        $this->addOption(
+            'progress',
+            null,
+            InputOption::VALUE_NEGATABLE,
+            'Whether to show a progress bar',
+            true,
+        );
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
@@ -146,10 +156,16 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $outputFormats = $input->getOption('output-format');
 
         foreach ($outputFormats as $format) {
+            $progressBar = null;
+
+            if ($output instanceof ConsoleOutputInterface && $input->getOption('progress')) {
+                $progressBar = new ProgressBar($output->section());
+            }
+
             $this->commandBus->handle(
                 new RenderCommand(
                     $format,
-                    $documents,
+                    $progressBar === null ? $documents : $progressBar->iterate($documents),
                     $sourceFileSystem,
                     $destinationFileSystem,
                     $projectNode,

packages/guides/src/Handlers/RenderCommand.php

@@ -10,10 +10,10 @@
 
 final class RenderCommand
 {
-    /** @param DocumentNode[] $documents */
+    /** @param iterable<DocumentNode> $documents */
     public function __construct(
         private readonly string $outputFormat,
-        private readonly array $documents,
+        private readonly iterable $documents,
         private readonly FilesystemInterface $origin,
         private readonly FilesystemInterface $destination,
         private readonly ProjectNode $projectNode,
@@ -26,8 +26,8 @@ public function getOutputFormat(): string
         return $this->outputFormat;
     }
 
-    /** @return DocumentNode[] */
-    public function getDocuments(): array
+    /** @return iterable<DocumentNode> */
+    public function getDocuments(): iterable
     {
         return $this->documents;
     }