[10.x] Prompts

.github/workflows/databases.yml

@@ -29,6 +29,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -72,6 +74,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -115,6 +119,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -159,6 +165,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -201,6 +209,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2

.github/workflows/facades.yml

@@ -18,6 +18,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2

.github/workflows/static-analysis.yml

@@ -21,6 +21,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2

.github/workflows/tests.yml

@@ -47,6 +47,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -128,6 +130,8 @@ jobs:
 
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2

composer.json

@@ -30,6 +30,7 @@
         "egulias/email-validator": "^3.2.1|^4.0",
         "fruitcake/php-cors": "^1.2",
         "guzzlehttp/uri-template": "^1.0",
+        "laravel/prompts": "^0.1",
         "laravel/serializable-closure": "^1.3",
         "league/commonmark": "^2.2.1",
         "league/flysystem": "^3.8.0",

src/Illuminate/Console/Command.php

@@ -13,6 +13,7 @@
 class Command extends SymfonyCommand
 {
     use Concerns\CallsCommands,
+        Concerns\ConfiguresPrompts,
         Concerns\HasParameters,
         Concerns\InteractsWithIO,
         Concerns\InteractsWithSignals,
@@ -173,6 +174,8 @@ public function run(InputInterface $input, OutputInterface $output): int
 
         $this->components = $this->laravel->make(Factory::class, ['output' => $this->output]);
 
+        $this->configurePrompts($input);
+
         try {
             return parent::run(
                 $this->input = $input, $this->output

src/Illuminate/Console/Concerns/ConfiguresPrompts.php

@@ -0,0 +1,122 @@
+<?php
+
+namespace Illuminate\Console\Concerns;
+
+use Laravel\Prompts\ConfirmPrompt;
+use Laravel\Prompts\MultiSelectPrompt;
+use Laravel\Prompts\PasswordPrompt;
+use Laravel\Prompts\Prompt;
+use Laravel\Prompts\SearchPrompt;
+use Laravel\Prompts\SelectPrompt;
+use Laravel\Prompts\SuggestPrompt;
+use Laravel\Prompts\TextPrompt;
+use Symfony\Component\Console\Input\InputInterface;
+
+trait ConfiguresPrompts
+{
+    /**
+     * Configure the prompt fallbacks.
+     *
+     * @param  \Symfony\Component\Console\Input\InputInterface  $input
+     * @return void
+     */
+    protected function configurePrompts(InputInterface $input)
+    {
+        Prompt::setOutput($this->output);
+
+        Prompt::fallbackWhen(! $input->isInteractive() || windows_os() || $this->laravel->runningUnitTests());
+
+        TextPrompt::fallbackUsing(fn (TextPrompt $prompt) => $this->promptUntilValid(
+            fn () => $this->components->ask($prompt->label, $prompt->default ?: null) ?? '',
+            $prompt->required,
+            $prompt->validate
+        ));
+
+        PasswordPrompt::fallbackUsing(fn (PasswordPrompt $prompt) => $this->promptUntilValid(
+            fn () => $this->components->secret($prompt->label) ?? '',
+            $prompt->required,
+            $prompt->validate
+        ));
+
+        ConfirmPrompt::fallbackUsing(fn (ConfirmPrompt $prompt) => $this->promptUntilValid(
+            fn () => $this->components->confirm($prompt->label, $prompt->default),
+            $prompt->required,
+            $prompt->validate
+        ));
+
+        SelectPrompt::fallbackUsing(fn (SelectPrompt $prompt) => $this->promptUntilValid(
+            fn () => $this->components->choice($prompt->label, $prompt->options, $prompt->default),
+            false,
+            $prompt->validate
+        ));
+
+        MultiSelectPrompt::fallbackUsing(function (MultiSelectPrompt $prompt) {
+            if ($prompt->default !== []) {
+                return $this->promptUntilValid(
+                    fn () => $this->components->choice($prompt->label, $prompt->options, implode(',', $prompt->default), multiple: true),
+                    $prompt->required,
+                    $prompt->validate
+                );
+            }
+
+            return $this->promptUntilValid(
+                fn () => collect($this->components->choice($prompt->label, ['' => 'None', ...$prompt->options], 'None', multiple: true))
+                    ->reject('')
+                    ->all(),
+                $prompt->required,
+                $prompt->validate
+            );
+        });
+
+        SuggestPrompt::fallbackUsing(fn (SuggestPrompt $prompt) => $this->promptUntilValid(
+            fn () => $this->components->askWithCompletion($prompt->label, $prompt->options, $prompt->default ?: null) ?? '',
+            $prompt->required,
+            $prompt->validate
+        ));
+
+        SearchPrompt::fallbackUsing(fn (SearchPrompt $prompt) => $this->promptUntilValid(
+            function () use ($prompt) {
+                $query = $this->components->ask($prompt->label);
+
+                $options = ($prompt->options)($query);
+
+                return $this->components->choice($prompt->label, $options);
+            },
+            false,
+            $prompt->validate
+        ));
+    }
+
+    /**
+     * Prompt the user until the given validation callback passes.
+     *
+     * @param  \Closure  $prompt
+     * @param  bool|string  $required
+     * @param  \Closure|null  $validate
+     * @return mixed
+     */
+    protected function promptUntilValid($prompt, $required, $validate)
+    {
+        while (true) {
+            $result = $prompt();
+
+            if ($required && ($result === '' || $result === [] || $result === false)) {
+                $this->components->error(is_string($required) ? $required : 'Required.');
+
+                continue;
+            }
+
+            if ($validate) {
+                $error = $validate($result);
+
+                if (is_string($error) && strlen($error) > 0) {
+                    $this->components->error($error);
+
+                    continue;
+                }
+            }
+
+            return $result;
+        }
+    }
+}

src/Illuminate/Console/Concerns/PromptsForMissingInput.php

@@ -2,10 +2,13 @@
 
 namespace Illuminate\Console\Concerns;
 
+use Closure;
 use Illuminate\Contracts\Console\PromptsForMissingInput as PromptsForMissingInputContract;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+use function Laravel\Prompts\text;
+
 trait PromptsForMissingInput
 {
     /**
@@ -36,13 +39,24 @@ protected function promptForMissingArguments(InputInterface $input, OutputInterf
         $prompted = collect($this->getDefinition()->getArguments())
             ->filter(fn ($argument) => $argument->isRequired() && is_null($input->getArgument($argument->getName())))
             ->filter(fn ($argument) => $argument->getName() !== 'command')
-            ->each(fn ($argument) => $input->setArgument(
-                $argument->getName(),
-                $this->askPersistently(
-                    $this->promptForMissingArgumentsUsing()[$argument->getName()] ??
-                    'What is '.lcfirst($argument->getDescription()).'?'
-                )
-            ))
+            ->each(function ($argument) use ($input) {
+                $label = $this->promptForMissingArgumentsUsing()[$argument->getName()] ??
+                    'What is '.lcfirst($argument->getDescription() ?: ('the '.$argument->getName())).'?';
+
+                if ($label instanceof Closure) {
+                    return $input->setArgument($argument->getName(), $label());
+                }
+
+                if (is_array($label)) {
+                    [$label, $placeholder] = $label;
+                }
+
+                $input->setArgument($argument->getName(), text(
+                    label: $label,
+                    placeholder: $placeholder ?? '',
+                    validate: fn ($value) => empty($value) ? "The {$argument->getName()} is required." : null,
+                ));
+            })
             ->isNotEmpty();
 
         if ($prompted) {
@@ -84,25 +98,4 @@ protected function didReceiveOptions(InputInterface $input)
             ->reject(fn ($option) => $input->getOption($option->getName()) === $option->getDefault())
             ->isNotEmpty();
     }
-
-    /**
-     * Continue asking a question until an answer is provided.
-     *
-     * @param  string  $question
-     * @return string
-     */
-    private function askPersistently($question)
-    {
-        $answer = null;
-
-        while ($answer === null) {
-            $answer = $this->components->ask($question);
-
-            if ($answer === null) {
-                $this->components->error('The answer is required.');
-            }
-        }
-
-        return $answer;
-    }
 }

src/Illuminate/Console/ConfirmableTrait.php

@@ -2,6 +2,8 @@
 
 namespace Illuminate\Console;
 
+use function Laravel\Prompts\confirm;
+
 trait ConfirmableTrait
 {
     /**
@@ -26,12 +28,10 @@ public function confirmToProceed($warning = 'Application In Production', $callba
 
             $this->components->alert($warning);
 
-            $confirmed = $this->components->confirm('Do you really wish to run this command?');
+            $confirmed = confirm('Are you sure you want to run this command?', default: false);
 
             if (! $confirmed) {
-                $this->newLine();
-
-                $this->components->warn('Command canceled.');
+                $this->components->warn('Command cancelled.');
 
                 return false;
             }

src/Illuminate/Console/Contracts/NewLineAware.php

@@ -4,10 +4,19 @@
 
 interface NewLineAware
 {
+    /**
+     * How many trailing newlines were written.
+     *
+     * @return int
+     */
+    public function newLinesWritten();
+
     /**
      * Whether a newline has already been written.
      *
      * @return bool
+     *
+     * @deprecated use newLinesWritten
      */
     public function newLineWritten();
 }

src/Illuminate/Console/GeneratorCommand.php

@@ -485,7 +485,35 @@ protected function getArguments()
     protected function promptForMissingArgumentsUsing()
     {
         return [
-            'name' => 'What should the '.strtolower($this->type).' be named?',
+            'name' => [
+                'What should the '.strtolower($this->type).' be named?',
+                match ($this->type) {
+                    'Cast' => 'E.g. Json',
+                    'Channel' => 'E.g. OrderChannel',
+                    'Console command' => 'E.g. SendEmails',
+                    'Component' => 'E.g. Alert',
+                    'Controller' => 'E.g. UserController',
+                    'Event' => 'E.g. PodcastProcessed',
+                    'Exception' => 'E.g. InvalidOrderException',
+                    'Factory' => 'E.g. PostFactory',
+                    'Job' => 'E.g. ProcessPodcast',
+                    'Listener' => 'E.g. SendPodcastNotification',
+                    'Mail' => 'E.g. OrderShipped',
+                    'Middleware' => 'E.g. EnsureTokenIsValid',
+                    'Model' => 'E.g. Flight',
+                    'Notification' => 'E.g. InvoicePaid',
+                    'Observer' => 'E.g. UserObserver',
+                    'Policy' => 'E.g. PostPolicy',
+                    'Provider' => 'E.g. ElasticServiceProvider',
+                    'Request' => 'E.g. StorePodcastRequest',
+                    'Resource' => 'E.g. UserResource',
+                    'Rule' => 'E.g. Uppercase',
+                    'Scope' => 'E.g. TrendingScope',
+                    'Seeder' => 'E.g. UserSeeder',
+                    'Test' => 'E.g. UserTest',
+                    default => '',
+                },
+            ],
         ];
     }
 }