feat(app): Add xdebug and configuration options to Artisan commands

- Introduce '--xdebug' option to display xdebug output during command execution.
- Enhance configuration handling with a '--configuration' option for dynamic key-value pairs.
- Improve command starting event to manage xdebug behavior based on options.
- Integrate new environment variables for PHPUnit configuration in the testing context.

These changes enhance the flexibility of Artisan commands, allowing users to control debugging output and pass configurations dynamically. The updated PHPUnit environment settings ensure a consistent testing environment.

Author: ityaozm@gmail.com

bootstrap/app.php

@@ -20,11 +20,18 @@
 use App\ConfigManager;
 use App\GeneratorManager;
 use App\Listeners\DefineTraceIdListener;
+use Composer\XdebugHandler\XdebugHandler;
+use Illuminate\Console\Events\CommandStarting;
 use Illuminate\Foundation\Configuration\Exceptions;
 use Illuminate\Log\LogManager;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Artisan;
+use Illuminate\Support\Facades\Event;
 use Illuminate\Validation\ValidationException;
 use Intonate\TinkerZero\TinkerZeroServiceProvider;
 use Psr\Log\LoggerInterface;
+use Symfony\Component\Console\Command\Command as SymfonyCommand;
+use Symfony\Component\Console\Input\InputOption;
 
 return Application::configure(basePath: \dirname(__DIR__))
     ->withSingletons([
@@ -47,6 +54,49 @@
             ): LogManager => $logger instanceof LogManager ? $logger : new LogManager($app)
         );
     })
+    ->booted(static function (): void {
+        collect(Artisan::all())
+            ->each(
+                static fn (SymfonyCommand $command): SymfonyCommand => $command
+                    ->addOption('xdebug', null, InputOption::VALUE_NONE, 'Display xdebug output')
+                    ->addOption(
+                        'configuration',
+                        null,
+                        InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
+                        'Used to dynamically pass one or more configuration key-value pairs(e.g. `--configuration=app.name=guanguans` or `--configuration app.name=guanguans`).',
+                    )
+            )
+            ->tap(static function (): void {
+                /**
+                 * @see \Illuminate\Foundation\Console\Kernel::rerouteSymfonyCommandEvents()
+                 * @see \Rector\Console\ConsoleApplication::doRun()
+                 */
+                Event::listen(CommandStarting::class, static function (CommandStarting $commandStarting): void {
+                    $isXdebugAllowed = $commandStarting->input->hasParameterOption('--xdebug') || app()->runningUnitTests();
+
+                    if (!$isXdebugAllowed) {
+                        $xdebugHandler = new XdebugHandler(config('app.name'));
+                        $xdebugHandler->setPersistent();
+                        $xdebugHandler->check();
+                        unset($xdebugHandler);
+                    }
+
+                    collect($commandStarting->input->getOption('configuration'))
+                        // ->dump()
+                        ->mapWithKeys(static function (string $configuration): array {
+                            \assert(
+                                str_contains($configuration, '='),
+                                "The configureable option [$configuration] must be formatted as key=value."
+                            );
+
+                            [$key, $value] = str($configuration)->explode('=', 2)->all();
+
+                            return [$key => $value];
+                        })
+                        ->tap(static fn (Collection $configuration): mixed => config($configuration->all()));
+                });
+            });
+    })
     ->withExceptions(static function (Exceptions $exceptions): void {
         $exceptions->map(
             ValidationException::class,

composer-dependency-analyser.php

@@ -48,6 +48,7 @@
     )
     ->ignoreErrorsOnPackages(
         [
+            'composer/xdebug-handler',
             'guzzlehttp/psr7',
             'laravel-lang/config',
             'laravel-lang/locale-list',

phpunit.xml.dist

@@ -26,4 +26,17 @@
       <file>app/Support/helpers.php</file>
     </exclude>
   </source>
+  <php>
+    <env name="APP_ENV" value="testing"/>
+    <env name="APP_MAINTENANCE_DRIVER" value="file"/>
+    <env name="BCRYPT_ROUNDS" value="4"/>
+    <env name="CACHE_STORE" value="array"/>
+    <env name="DB_CONNECTION" value="sqlite"/>
+    <env name="DB_DATABASE" value=":memory:"/>
+    <env name="MAIL_MAILER" value="array"/>
+    <env name="PULSE_ENABLED" value="false"/>
+    <env name="QUEUE_CONNECTION" value="sync"/>
+    <env name="SESSION_DRIVER" value="array"/>
+    <env name="TELESCOPE_ENABLED" value="false"/>
+  </php>
 </phpunit>