fix: improve exception handling

Author: ramsey

src/LibraryStarterKit/Setup.php

@@ -46,17 +46,20 @@ class Setup
     private Filesystem $filesystem;
     private Finder $finder;
     private Project $project;
+    private int $verbosity;
 
     public function __construct(
         Project $project,
         Event $event,
         Filesystem $filesystem,
-        Finder $finder
+        Finder $finder,
+        int $verbosity
     ) {
         $this->project = $project;
         $this->event = $event;
         $this->filesystem = $filesystem;
         $this->finder = $finder;
+        $this->verbosity = $verbosity;
     }
 
     /**
@@ -107,6 +110,14 @@ public function getProject(): Project
         return $this->project;
     }
 
+    /**
+     * Returns the verbosity level
+     */
+    public function getVerbosity(): int
+    {
+        return $this->verbosity;
+    }
+
     /**
      * Returns an instance used for executing a system command
      *

src/LibraryStarterKit/Wizard.php

@@ -36,6 +36,7 @@
 use Symfony\Component\Console\Question\Question;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\Finder\Finder;
+use Throwable;
 
 use function basename;
 use function dirname;
@@ -78,6 +79,8 @@ public function getSetup(): Setup
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
+        $output->setVerbosity($this->getSetup()->getVerbosity());
+
         $console = $this->styleFactory->factory($input, $output);
         $console->title('Welcome to the PHP Library Starter Kit!');
         $console->block(
@@ -89,12 +92,16 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $this->registerInterruptHandler($console);
 
-        if (!$this->confirmStart($console)) {
-            return 0;
-        }
+        try {
+            if (!$this->confirmStart($console)) {
+                return 0;
+            }
 
-        $this->askQuestions($console);
-        $this->setup->run($console, $this->answers);
+            $this->askQuestions($console);
+            $this->setup->run($console, $this->answers);
+        } catch (Throwable $throwable) {
+            return $this->handleException($throwable, $console);
+        }
 
         $console->success([
             sprintf('Congratulations! Your project, %s, is ready!', (string) $this->answers->packageName),
@@ -173,6 +180,30 @@ private function registerInterruptHandler(SymfonyStyle $console): void
         // phpcs:enable
     }
 
+    private function handleException(Throwable $throwable, SymfonyStyle $console): int
+    {
+        $errorMessages = [
+            $throwable->getMessage(),
+            sprintf('At line %d in %s', $throwable->getLine(), $throwable->getFile()),
+        ];
+
+        if ($console->getVerbosity() === OutputInterface::VERBOSITY_DEBUG) {
+            $errorMessages[] = $throwable->getTraceAsString();
+        }
+
+        $console->error($errorMessages);
+
+        $console->block([
+            'Oops! I encountered an error.',
+            'Please go here and click the "New issue" button to report this error: '
+                . 'https://github.com/ramsey/php-library-starter-kit/issues',
+        ]);
+
+        $console->newLine();
+
+        return (int) $throwable->getCode() ?: 1;
+    }
+
     public static function newApplication(): Application
     {
         return self::$application ?? new Application();
@@ -186,7 +217,7 @@ public static function start(Event $event): void
         $projectName = (string) preg_replace('/[^a-z0-9]/', '-', $projectName);
 
         $project = new Project($projectName, $appPath);
-        $setup = new Setup($project, $event, new Filesystem(), new Finder());
+        $setup = new Setup($project, $event, new Filesystem(), new Finder(), self::determineVerbosityLevel($event));
 
         $command = new self($setup);
 
@@ -196,4 +227,17 @@ public static function start(Event $event): void
 
         $application->run(new StringInput('starter-kit'));
     }
+
+    public static function determineVerbosityLevel(Event $event): int
+    {
+        if ($event->getIO()->isDebug()) {
+            return OutputInterface::VERBOSITY_DEBUG;
+        } elseif ($event->getIO()->isVeryVerbose()) {
+            return OutputInterface::VERBOSITY_VERY_VERBOSE;
+        } elseif ($event->getIO()->isVerbose()) {
+            return OutputInterface::VERBOSITY_VERBOSE;
+        }
+
+        return OutputInterface::VERBOSITY_NORMAL;
+    }
 }

tests/LibraryStarterKit/SetupTest.php

@@ -11,6 +11,7 @@
 use Ramsey\Dev\LibraryStarterKit\Project;
 use Ramsey\Dev\LibraryStarterKit\Setup;
 use Ramsey\Dev\LibraryStarterKit\Task\Build;
+use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\Process\Process;
@@ -49,6 +50,7 @@ public function setUp(): void
             $event,
             $filesystem,
             $finder,
+            OutputInterface::VERBOSITY_NORMAL,
         );
     }
 
@@ -77,6 +79,11 @@ public function testGetProjectName(): void
         $this->assertSame('a-project-name', $this->setup->getProjectName());
     }
 
+    public function testGetVerbosity(): void
+    {
+        $this->assertSame(OutputInterface::VERBOSITY_NORMAL, $this->setup->getVerbosity());
+    }
+
     public function testGetBuild(): void
     {
         /** @var SymfonyStyle & MockInterface $console */

tests/LibraryStarterKit/Task/Builder/UpdateSourceFileHeadersTest.php

@@ -15,6 +15,7 @@
 use Ramsey\Test\Dev\LibraryStarterKit\SnapshotsTool;
 use Ramsey\Test\Dev\LibraryStarterKit\TestCase;
 use Ramsey\Test\Dev\LibraryStarterKit\WindowsSafeTextDriver;
+use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\Finder\SplFileInfo;
@@ -46,6 +47,7 @@ public function testBuild(string $license, ?string $copyrightEmail = null, ?stri
             $this->mockery(Event::class),
             $this->mockery(Filesystem::class),
             $this->mockery(Finder::class),
+            OutputInterface::VERBOSITY_NORMAL,
         );
 
         $file1 = $this->mockery(SplFileInfo::class, [