[0.1.9] Add non-interactive mode

src/Concerns/FakesInputOutput.php

@@ -16,6 +16,9 @@ trait FakesInputOutput
      */
     public static function fake(array $keys = []): void
     {
+        // Force interactive mode when testing because we will be mocking the terminal.
+        static::interactive();
+
         $mock = \Mockery::mock(Terminal::class);
 
         $mock->shouldReceive('write')->byDefault();

src/Concerns/Interactivity.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Laravel\Prompts\Concerns;
+
+use Laravel\Prompts\Exceptions\NonInteractiveValidationException;
+
+trait Interactivity
+{
+    /**
+     * Whether to render the prompt interactively.
+     */
+    protected static bool $interactive;
+
+    /**
+     * Set interactive mode.
+     */
+    public static function interactive(bool $interactive = true): void
+    {
+        static::$interactive = $interactive;
+    }
+
+    /**
+     * Return the default value if it passes validation.
+     */
+    protected function default(): mixed
+    {
+        $default = $this->value();
+
+        $this->validate($default);
+
+        if ($this->state === 'error') {
+            throw new NonInteractiveValidationException($this->error);
+        }
+
+        return $default;
+    }
+}

src/Exceptions/NonInteractiveValidationException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Laravel\Prompts\Exceptions;
+
+use RuntimeException;
+
+class NonInteractiveValidationException extends RuntimeException
+{
+    //
+}

src/Prompt.php

@@ -16,6 +16,7 @@ abstract class Prompt
     use Concerns\Events;
     use Concerns\FakesInputOutput;
     use Concerns\Fallback;
+    use Concerns\Interactivity;
     use Concerns\Themes;
 
     /**
@@ -73,6 +74,12 @@ abstract public function value(): mixed;
      */
     public function prompt(): mixed
     {
+        static::$interactive ??= stream_isatty(STDIN);
+
+        if (! static::$interactive) {
+            return $this->default();
+        }
+
         $this->capturePreviousNewLines();
 
         if (static::shouldFallback()) {
@@ -304,7 +311,7 @@ private function validate(mixed $value): void
     {
         $this->validated = true;
 
-        if (($this->required ?? false) && ($value === '' || $value === [] || $value === false)) {
+        if (($this->required ?? false) && ($value === '' || $value === [] || $value === false || $value === null)) {
             $this->state = 'error';
             $this->error = is_string($this->required) ? $this->required : 'Required.';
 

src/SearchPrompt.php

@@ -20,6 +20,11 @@ class SearchPrompt extends Prompt
      */
     public int $firstVisible = 0;
 
+    /**
+     * Whether user input is required.
+     */
+    public bool|string $required = true;
+
     /**
      * The cached matches.
      *

src/SelectPrompt.php

@@ -26,6 +26,11 @@ class SelectPrompt extends Prompt
      */
     public array $options;
 
+    /**
+     * Whether user input is required.
+     */
+    public bool|string $required = true;
+
     /**
      * Create a new SelectPrompt instance.
      *
@@ -82,6 +87,10 @@ public function __construct(
      */
     public function value(): int|string|null
     {
+        if (static::$interactive === false) {
+            return $this->default;
+        }
+
         if (array_is_list($this->options)) {
             return $this->options[$this->highlighted] ?? null;
         } else {

tests/Feature/ConfirmPromptTest.php

@@ -1,6 +1,7 @@
 <?php
 
 use Laravel\Prompts\ConfirmPrompt;
+use Laravel\Prompts\Exceptions\NonInteractiveValidationException;
 use Laravel\Prompts\Key;
 use Laravel\Prompts\Prompt;
 
@@ -99,3 +100,21 @@
 
     expect($result)->toBeFalse();
 });
+
+it('returns the default value when non-interactive', function () {
+    Prompt::interactive(false);
+
+    $result = confirm('Would you like to continue?', false);
+
+    expect($result)->toBeFalse();
+});
+
+it('validates the default value when non-interactive', function () {
+    Prompt::interactive(false);
+
+    confirm(
+        'Would you like to continue?',
+        default: false,
+        required: true,
+    );
+})->throws(NonInteractiveValidationException::class, 'Required.');

tests/Feature/MultiselectPromptTest.php

@@ -1,5 +1,6 @@
 <?php
 
+use Laravel\Prompts\Exceptions\NonInteractiveValidationException;
 use Laravel\Prompts\Key;
 use Laravel\Prompts\MultiSelectPrompt;
 use Laravel\Prompts\Prompt;
@@ -153,3 +154,37 @@
 
     expect($result)->toBe(['green', 'blue']);
 });
+
+it('returns an empty array when non-interactive', function () {
+    Prompt::interactive(false);
+
+    $result = multiselect('What is your favorite color?', [
+        'Red',
+        'Green',
+        'Blue',
+    ]);
+
+    expect($result)->toBe([]);
+});
+
+it('returns the default value when non-interactive', function () {
+    Prompt::interactive(false);
+
+    $result = multiselect('What is your favorite color?', [
+        'Red',
+        'Green',
+        'Blue',
+    ], default: ['Green']);
+
+    expect($result)->toBe(['Green']);
+});
+
+it('validates the default value when non-interactive', function () {
+    Prompt::interactive(false);
+
+    multiselect('What is your favorite color?', [
+        'Red',
+        'Green',
+        'Blue',
+    ], required: true);
+})->throws(NonInteractiveValidationException::class, 'Required.');

tests/Feature/PasswordPromptTest.php

@@ -1,5 +1,6 @@
 <?php
 
+use Laravel\Prompts\Exceptions\NonInteractiveValidationException;
 use Laravel\Prompts\Key;
 use Laravel\Prompts\PasswordPrompt;
 use Laravel\Prompts\Prompt;
@@ -64,3 +65,17 @@
 
     expect($result)->toBe('result');
 });
+
+it('returns an empty string when non-interactive', function () {
+    Prompt::interactive(false);
+
+    $result = password('What is the password?');
+
+    expect($result)->toBe('');
+});
+
+it('fails validation when non-interactive', function () {
+    Prompt::interactive(false);
+
+    password('What is the password?', required: true);
+})->throws(NonInteractiveValidationException::class, 'Required.');

tests/Feature/SearchPromptTest.php

@@ -1,5 +1,6 @@
 <?php
 
+use Laravel\Prompts\Exceptions\NonInteractiveValidationException;
 use Laravel\Prompts\Key;
 use Laravel\Prompts\Prompt;
 use Laravel\Prompts\SearchPrompt;
@@ -116,3 +117,9 @@
 
     expect($result)->toBe('blue');
 });
+
+it('fails when when non-interactive', function () {
+    Prompt::interactive(false);
+
+    search('What is your favorite color?', fn () => []);
+})->throws(NonInteractiveValidationException::class, 'Required.');

tests/Feature/SelectPromptTest.php

@@ -1,5 +1,6 @@
 <?php
 
+use Laravel\Prompts\Exceptions\NonInteractiveValidationException;
 use Laravel\Prompts\Key;
 use Laravel\Prompts\Prompt;
 use Laravel\Prompts\SelectPrompt;
@@ -224,3 +225,41 @@
 
     expect($result)->toBe('Green');
 });
+
+it('fails when there is no default in non-interactive mode', function () {
+    Prompt::interactive(false);
+
+    select('What is your favorite color?', [
+        'Red',
+        'Green',
+        'Blue',
+    ]);
+})->throws(NonInteractiveValidationException::class, 'Required.');
+
+it('returns the default value when non-interactive', function () {
+    Prompt::interactive(false);
+
+    $result = select('What is your favorite color?', [
+        'Red',
+        'Green',
+        'Blue',
+    ], default: 'Green');
+
+    expect($result)->toBe('Green');
+});
+
+it('validates the default value when non-interactive', function () {
+    Prompt::interactive(false);
+
+    select(
+        label: 'What is your favorite color?',
+        options: [
+            'None',
+            'Red',
+            'Green',
+            'Blue',
+        ],
+        default: 'None',
+        validate: fn ($value) => $value === 'None' ? 'Required.' : null,
+    );
+})->throws(NonInteractiveValidationException::class, 'Required.');

tests/Feature/SuggestPromptTest.php

@@ -1,5 +1,6 @@
 <?php
 
+use Laravel\Prompts\Exceptions\NonInteractiveValidationException;
 use Laravel\Prompts\Key;
 use Laravel\Prompts\Prompt;
 use Laravel\Prompts\SuggestPrompt;
@@ -117,3 +118,37 @@
 
     expect($result)->toBe('Black');
 });
+
+it('returns an empty string when non-interactive', function () {
+    Prompt::interactive(false);
+
+    $result = suggest('What is your favorite color?', [
+        'Red',
+        'Green',
+        'Blue',
+    ]);
+
+    expect($result)->toBe('');
+});
+
+it('returns the default value when non-interactive', function () {
+    Prompt::interactive(false);
+
+    $result = suggest('What is your favorite color?', [
+        'Red',
+        'Green',
+        'Blue',
+    ], default: 'Yellow');
+
+    expect($result)->toBe('Yellow');
+});
+
+it('validates the default value when non-interactive', function () {
+    Prompt::interactive(false);
+
+    suggest('What is your favorite color?', [
+        'Red',
+        'Green',
+        'Blue',
+    ], required: true);
+})->throws(NonInteractiveValidationException::class, 'Required.');

tests/Feature/TextPromptTest.php

@@ -1,5 +1,6 @@
 <?php
 
+use Laravel\Prompts\Exceptions\NonInteractiveValidationException;
 use Laravel\Prompts\Key;
 use Laravel\Prompts\Prompt;
 use Laravel\Prompts\TextPrompt;
@@ -91,3 +92,25 @@
 
     expect($result)->toBe('Jess');
 });
+
+it('returns an empty string when non-interactive', function () {
+    Prompt::interactive(false);
+
+    $result = text('What is your name?');
+
+    expect($result)->toBe('');
+});
+
+it('returns the default value when non-interactive', function () {
+    Prompt::interactive(false);
+
+    $result = text('What is your name?', default: 'Taylor');
+
+    expect($result)->toBe('Taylor');
+});
+
+it('validates the default value when non-interactive', function () {
+    Prompt::interactive(false);
+
+    text('What is your name?', required: true);
+})->throws(NonInteractiveValidationException::class, 'Required.');