Improve errors on unsupported environments (#20)

* Improve error message when running on Windows

* Check that the terminal is tall enough to render the prompt

src/Prompt.php

@@ -4,6 +4,7 @@
 
 use Closure;
 use Laravel\Prompts\Output\ConsoleOutput;
+use RuntimeException;
 use Symfony\Component\Console\Output\OutputInterface;
 
 abstract class Prompt
@@ -77,6 +78,8 @@ public function prompt(): mixed
             return $this->fallback();
         }
 
+        $this->checkEnvironment();
+
         register_shutdown_function(function () {
             $this->restoreCursor();
             static::terminal()->restoreTty();
@@ -302,4 +305,14 @@ private function validate(mixed $value): void
             $this->error = $error;
         }
     }
+
+    /**
+     * Check whether the environment can support the prompt.
+     */
+    private function checkEnvironment(): void
+    {
+        if (PHP_OS_FAMILY === 'Windows') {
+            throw new RuntimeException('Prompts is not currently supported on Windows. Please use WSL or configure a fallback.');
+        }
+    }
 }

src/Themes/Default/Renderer.php

@@ -5,6 +5,7 @@
 use InvalidArgumentException;
 use Laravel\Prompts\Concerns\Colors;
 use Laravel\Prompts\Prompt;
+use RuntimeException;
 
 abstract class Renderer
 {
@@ -20,7 +21,7 @@ abstract class Renderer
      */
     public function __construct(protected Prompt $prompt)
     {
-        //
+        $this->checkTerminalSize($prompt);
     }
 
     /**
@@ -80,4 +81,19 @@ public function __toString()
             .$this->output
             .(in_array($this->prompt->state, ['submit', 'cancel']) ? PHP_EOL : '');
     }
+
+    /**
+     * Check that the terminal is large enough to render the prompt.
+     */
+    private function checkTerminalSize(Prompt $prompt): void
+    {
+        $required = 8;
+        $actual = $prompt->terminal()->lines();
+
+        if ($actual < $required) {
+            throw new RuntimeException(
+                "The terminal height must be at least [$required] lines but is currently [$actual]. Please increase the height or reduce the font size."
+            );
+        }
+    }
 }