feat: add support for command events

Author: mychidarko

src/Sprout/App.php

@@ -12,6 +12,8 @@ class App
         'commands' => [],
     ];
 
+    protected $eventListeners = [];
+
     public function __construct(array $config = [])
     {
         $this->config = $config;
@@ -96,6 +98,66 @@ public function autoloadCommands(string $path): void
         }
     }
 
+    /**
+     * Register an event listener
+     * @param string $event The event name
+     * @param callable $listener The event listener callback
+     * @return void
+     */
+    public function on(string $event, callable $listener): void
+    {
+        if (!isset($this->eventListeners[$event])) {
+            $this->eventListeners[$event] = [];
+        }
+
+        $this->eventListeners[$event][] = $listener;
+    }
+
+    /**
+     * Emit an event to all registered listeners
+     * @param string $event The event name
+     * @param array $data Event data
+     * @return Event
+     */
+    public function emit(string $event, array $data = []): Event
+    {
+        $eventObject = new Event($event, $data);
+
+        if (!isset($this->eventListeners[$event])) {
+            return $eventObject;
+        }
+
+        foreach ($this->eventListeners[$event] as $listener) {
+            if ($eventObject->isPropagationStopped()) {
+                break;
+            }
+
+            call_user_func($listener, $eventObject);
+        }
+
+        return $eventObject;
+    }
+
+    /**
+     * Remove event listeners for a specific event
+     * @param string $event The event name
+     * @return void
+     */
+    public function off(string $event): void
+    {
+        unset($this->eventListeners[$event]);
+    }
+
+    /**
+     * Check if an event has any listeners
+     * @param string $event The event name
+     * @return bool
+     */
+    public function hasListeners(string $event): bool
+    {
+        return isset($this->eventListeners[$event]) && !empty($this->eventListeners[$event]);
+    }
+
     protected function normalizeCommandInput(string $input): array
     {
         $tokens = preg_split('/\s+/', trim($input));
@@ -182,10 +244,54 @@ public function run()
         }
 
         if (!isset($this->config['commands'][$commandName])) {
+            if ($this->hasListeners('command.notFound')) {
+                $event = $this->emit('command.notFound', [
+                    'commandName' => $commandName,
+                    'commandData' => $commandData,
+                    'argv' => $argv
+                ]);
+
+                if ($event->getExitCode() !== 0) {
+                    exit($event->getExitCode());
+                }
+
+                return;
+            }
+
             echo "Command not found\n";
             return;
         }
 
+        $beforeEvent = $this->emit('command.before', [
+            'commandName' => $commandName,
+            'commandData' => $commandData,
+            'argv' => $argv
+        ]);
+
+        if ($beforeEvent->isPropagationStopped()) {
+            if ($beforeEvent->getExitCode() !== 0) {
+                exit($beforeEvent->getExitCode());
+            }
+
+            return;
+        }
+
+        if ($this->hasListeners($commandName)) {
+            $customEvent = $this->emit($commandName, [
+                'commandName' => $commandName,
+                'commandData' => $commandData,
+                'argv' => $argv
+            ]);
+
+            if ($customEvent->isPropagationStopped()) {
+                if ($customEvent->getExitCode() !== 0) {
+                    exit($customEvent->getExitCode());
+                }
+
+                return;
+            }
+        }
+
         $command = $this->config['commands'][$commandName]['handler'];
 
         foreach (array_values($command->getHelp()['params']) as $paramData) {
@@ -219,7 +325,18 @@ public function run()
             return;
         }
 
-        return $command->call($command);
+        $result = $command->call($command);
+
+        $this->emit('command.after', [
+            'commandName' => $commandName,
+            'commandData' => $commandData,
+            'params' => $params,
+            'arguments' => $arguments,
+            'result' => $result,
+            'argv' => $argv
+        ]);
+
+        return $result;
     }
 
     protected function parseCommandSignature(string $signature)

src/Sprout/Event.php

@@ -0,0 +1,115 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Leaf\Sprout;
+
+class Event
+{
+    protected $name;
+    protected $data;
+    protected $propagationStopped = false;
+    protected $exitCode = 0;
+
+    public function __construct(string $name, array $data = [])
+    {
+        $this->name = $name;
+        $this->data = $data;
+    }
+
+    /**
+     * Get the event name
+     */
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    /**
+     * Get the command name from event data
+     */
+    public function getCommandName(): ?string
+    {
+        return $this->data['commandName'] ?? null;
+    }
+
+    /**
+     * Get all event data
+     */
+    public function getData(): array
+    {
+        return $this->data;
+    }
+
+    /**
+     * Get a specific piece of event data
+     */
+    public function get(string $key, $default = null)
+    {
+        return $this->data[$key] ?? $default;
+    }
+
+    /**
+     * Set event data
+     */
+    public function set(string $key, $value): void
+    {
+        $this->data[$key] = $value;
+    }
+
+    /**
+     * Set the exit code
+     */
+    public function setExitCode(int $exitCode): void
+    {
+        $this->exitCode = $exitCode;
+    }
+
+    /**
+     * Get the exit code
+     */
+    public function getExitCode(): int
+    {
+        return $this->exitCode;
+    }
+
+    /**
+     * Stop event propagation
+     */
+    public function stopPropagation(): void
+    {
+        $this->propagationStopped = true;
+    }
+
+    /**
+     * Check if propagation is stopped
+     */
+    public function isPropagationStopped(): bool
+    {
+        return $this->propagationStopped;
+    }
+
+    /**
+     * Get command arguments
+     */
+    public function getArguments(): array
+    {
+        return $this->data['arguments'] ?? [];
+    }
+
+    /**
+     * Get command parameters/options
+     */
+    public function getParams(): array
+    {
+        return $this->data['params'] ?? [];
+    }
+
+    /**
+     * Get the raw command data
+     */
+    public function getCommandData(): array
+    {
+        return $this->data['commandData'] ?? [];
+    }
+}