[12.x] Add --json option to EventListCommand (#55207)

* Add --json option to EventListCommand with tests

* formatting

---------

Co-authored-by: Taylor Otwell <taylor@laravel.com>

Author: hotsaucejake

src/Illuminate/Foundation/Console/EventListCommand.php

@@ -18,7 +18,9 @@ class EventListCommand extends Command
      *
      * @var string
      */
-    protected $signature = 'event:list {--event= : Filter the events by name}';
+    protected $signature = 'event:list
+                            {--event= : Filter the events by name}
+                            {--json : Output the events and listeners as JSON}';
 
     /**
      * The console command description.
@@ -44,11 +46,48 @@ public function handle()
         $events = $this->getEvents()->sortKeys();
 
         if ($events->isEmpty()) {
-            $this->components->info("Your application doesn't have any events matching the given criteria.");
+            if ($this->option('json')) {
+                $this->output->writeln('[]');
+            } else {
+                $this->components->info("Your application doesn't have any events matching the given criteria.");
+            }
 
             return;
         }
 
+        if ($this->option('json')) {
+            $this->displayJson($events);
+        } else {
+            $this->displayForCli($events);
+        }
+    }
+
+    /**
+     * Display events and their listeners in JSON.
+     *
+     * @param  \Illuminate\Support\Collection  $events
+     * @return void
+     */
+    protected function displayJson(Collection $events)
+    {
+        $data = $events->map(function ($listeners, $event) {
+            return [
+                'event' => strip_tags($this->appendEventInterfaces($event)),
+                'listeners' => collect($listeners)->map(fn ($listener) => strip_tags($listener))->values()->all(),
+            ];
+        })->values();
+
+        $this->output->writeln($data->toJson());
+    }
+
+    /**
+     * Display the events and their listeners for the CLI.
+     *
+     * @param  \Illuminate\Support\Collection  $events
+     * @return void
+     */
+    protected function displayForCli(Collection $events)
+    {
         $this->newLine();
 
         $events->each(function ($listeners, $event) {

tests/Integration/Console/Events/EventListCommandTest.php

@@ -6,6 +6,7 @@
 use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Events\Dispatcher;
 use Illuminate\Foundation\Console\EventListCommand;
+use Illuminate\Support\Facades\Artisan;
 use Orchestra\Testbench\TestCase;
 
 class EventListCommandTest extends TestCase
@@ -58,6 +59,54 @@ public function testDisplayFilteredEvent()
             ->expectsOutputToContain('ExampleEvent');
     }
 
+    public function testDisplayEmptyListAsJson()
+    {
+        $this->withoutMockingConsoleOutput()->artisan(EventListCommand::class, ['--json' => true]);
+        $output = Artisan::output();
+
+        $this->assertJson($output);
+        $this->assertJsonStringEqualsJsonString('[]', $output);
+    }
+
+    public function testDisplayEventsAsJson()
+    {
+        $this->dispatcher->subscribe(ExampleSubscriber::class);
+        $this->dispatcher->listen(ExampleEvent::class, ExampleListener::class);
+        $this->dispatcher->listen(ExampleEvent::class, ExampleQueueListener::class);
+        $this->dispatcher->listen(ExampleBroadcastEvent::class, ExampleBroadcastListener::class);
+        $this->dispatcher->listen(ExampleEvent::class, fn () => '');
+        $closureLineNumber = __LINE__ - 1;
+        $unixFilePath = str_replace('\\', '/', __FILE__);
+
+        $this->withoutMockingConsoleOutput()->artisan(EventListCommand::class, ['--json' => true]);
+        $output = Artisan::output();
+
+        $this->assertJson($output);
+        $this->assertStringContainsString('ExampleSubscriberEventName', $output);
+        $this->assertStringContainsString(json_encode('Illuminate\Tests\Integration\Console\Events\ExampleSubscriber@a'), $output);
+        $this->assertStringContainsString(json_encode('Illuminate\Tests\Integration\Console\Events\ExampleBroadcastEvent (ShouldBroadcast)'), $output);
+        $this->assertStringContainsString(json_encode('Illuminate\Tests\Integration\Console\Events\ExampleBroadcastListener'), $output);
+        $this->assertStringContainsString(json_encode('Illuminate\Tests\Integration\Console\Events\ExampleEvent'), $output);
+        $this->assertStringContainsString(json_encode('Closure at: '.$unixFilePath.':'.$closureLineNumber), $output);
+    }
+
+    public function testDisplayFilteredEventAsJson()
+    {
+        $this->dispatcher->subscribe(ExampleSubscriber::class);
+        $this->dispatcher->listen(ExampleEvent::class, ExampleListener::class);
+
+        $this->withoutMockingConsoleOutput()->artisan(EventListCommand::class, [
+            '--event' => 'ExampleEvent',
+            '--json' => true,
+        ]);
+        $output = Artisan::output();
+
+        $this->assertJson($output);
+        $this->assertStringContainsString('ExampleEvent', $output);
+        $this->assertStringContainsString('ExampleListener', $output);
+        $this->assertStringNotContainsString('ExampleSubscriberEventName', $output);
+    }
+
     protected function tearDown(): void
     {
         parent::tearDown();