Add label functionality

You can provide actions with labels to enhance the output.
Suggested in issue #212

Author: sebastianfeldmann

src/Config.php

@@ -31,6 +31,7 @@ class Config
     public const SETTING_GIT_DIR             = 'git-directory';
     public const SETTING_INCLUDES            = 'includes';
     public const SETTING_INCLUDES_LEVEL      = 'includes-level';
+    public const SETTING_LABEL               = 'label';
     public const SETTING_RUN_EXEC            = 'run-exec';
     public const SETTING_RUN_MODE            = 'run-mode';
     public const SETTING_RUN_PATH            = 'run-path';

src/Config/Action.php

@@ -28,36 +28,37 @@ class Action
      *
      * @var string
      */
-    private $action;
+    private string $action;
 
     /**
      * Map of options name => value
      *
      * @var \CaptainHook\App\Config\Options
      */
-    private $options;
+    private Options $options;
 
     /**
      * List of action conditions
      *
      * @var \CaptainHook\App\Config\Condition[]
      */
-    private $conditions = [];
+    private array $conditions = [];
 
     /**
      * Action settings
      *
      * @var array<string, mixed>
      */
-    private $settings = [];
+    private array $settings = [];
 
     /**
      * List of available settings
      *
      * @var string[]
      */
-    private static $availableSettings = [
-        Config::SETTING_ALLOW_FAILURE
+    private static array $availableSettings = [
+        Config::SETTING_ALLOW_FAILURE,
+        Config::SETTING_LABEL
     ];
 
     /**
@@ -108,7 +109,7 @@ private function setupSettings(array $settings): void
     {
         foreach (self::$availableSettings as $setting) {
             if (isset($settings[$setting])) {
-                $this->settings[Config::SETTING_ALLOW_FAILURE] = $settings[$setting];
+                $this->settings[$setting] = $settings[$setting];
             }
         }
     }
@@ -124,6 +125,16 @@ public function isFailureAllowed(bool $default = false): bool
         return (bool) ($this->settings[Config::SETTING_ALLOW_FAILURE] ?? $default);
     }
 
+    /**
+     * Return the label or the action if no label is set
+     *
+     * @return string
+     */
+    public function getLabel(): string
+    {
+        return (string) ($this->settings[Config::SETTING_LABEL] ?? $this->getAction());
+    }
+
     /**
      * Action getter
      *

src/Runner/Hook.php

@@ -304,15 +304,12 @@ private function executeFailAfterAllActions(array $actions): void
     private function handleAction(Config\Action $action): void
     {
         if ($this->shouldSkipActions()) {
-            $this->io->write(
-                $this->formatActionOutput($action->getAction()) . ': <comment>deactivated</comment>',
-                true
-            );
+            $this->io->write($this->formatActionOutput($action->getLabel()) . ': <comment>deactivated</comment>');
             return;
         }
 
         $this->io->write(
-            ' - <fg=blue>' . $this->formatActionOutput($action->getAction()) . '</> : ',
+            ' - <fg=blue>' . $this->formatActionOutput($action->getLabel()) . '</> : ',
             $this->io->isVerbose()
         );
 

tests/unit/Config/ActionTest.php

@@ -62,6 +62,26 @@ public function testGetAction(): void
         $this->assertEquals('\\Foo\\Bar', $action->getAction());
     }
 
+    /**
+     * Tests Action::getLabel
+     */
+    public function testGetLabel(): void
+    {
+        $action = new Action('\\Foo\\Bar', [], [], ['label' => 'My label']);
+
+        $this->assertEquals('My label', $action->getLabel());
+    }
+
+    /**
+     * Tests Action::getLabel
+     */
+    public function testGetLabelEmpty(): void
+    {
+        $action = new Action('\\Foo\\Bar');
+
+        $this->assertEquals('\\Foo\\Bar', $action->getLabel());
+    }
+
     /**
      * Tests Action::getOptions
      */