Add run config and custom settings

Fixes issue #301

Author: sebastianfeldmann

src/Runner/Config/Reader.php

@@ -143,6 +143,10 @@ private function displaySettings(): void
         $this->io->write('  - <fg=cyan>Git directory:</fg=cyan> ' . $this->config->getGitDirectory());
         $this->io->write('  - <fg=cyan>Bootstrap file:</fg=cyan> ' . $this->config->getBootstrap());
         $this->io->write('  - <fg=cyan>Install mode:</fg=cyan> ' . $this->config->getRunConfig()->getMode());
+
+        $this->displayCustomSettings();
+        $this->displayRunSettings();
+        $this->displayPluginSettings();
     }
 
     /**
@@ -207,10 +211,11 @@ private function displayAction(Config\Action $action): void
     /**
      * Display all options
      *
-     * @param \CaptainHook\App\Config\Options $options
+     * @param  \CaptainHook\App\Config\Options $options
+     * @param  string                          $prefix
      * @return void
      */
-    private function displayOptions(Config\Options $options): void
+    private function displayOptions(Config\Options $options, string $prefix = ''): void
     {
         if (empty($options->getAll())) {
             return;
@@ -219,9 +224,9 @@ private function displayOptions(Config\Options $options): void
             return;
         }
 
-        $this->io->write('     <comment>Options:</comment>');
+        $this->io->write($prefix . '     <comment>Options:</comment>');
         foreach ($options->getAll() as $key => $value) {
-            $this->displayOption($key, $value);
+            $this->displayOption($key, $value, $prefix);
         }
     }
 
@@ -357,4 +362,54 @@ private function yesOrNo(bool $bool): string
     {
         return $bool ? '✅ ' : '❌ ';
     }
+
+    /**
+     * Display custom config settings
+     *
+     * @return void
+     */
+    private function displayCustomSettings(): void
+    {
+        if (count($this->config->getCustomSettings()) === 0) {
+            return;
+        }
+
+        $this->io->write('  <fg=yellow>Custom Settings:</>');
+        foreach ($this->config->getCustomSettings() as $key => $value) {
+            $this->io->write('    - <fg=cyan>' . $key . '</>: ' . $value);
+        }
+    }
+
+    /**
+     * Display run config settings
+     *
+     * @return void
+     */
+    private function displayRunSettings(): void
+    {
+        $runConfig = $this->config->getRunConfig();
+        $this->io->write('  <fg=yellow>Run Settings:</>');
+        $this->io->write('    - <fg=cyan>mode</>: ' . $runConfig->getMode());
+        $this->io->write('    - <fg=cyan>docker-command</>: ' . $runConfig->getDockerCommand());
+        $this->io->write('    - <fg=cyan>path-captain</>: ' . $runConfig->getCaptainsPath());
+        $this->io->write('    - <fg=cyan>path-git</>: ' . $runConfig->getGitPath());
+    }
+
+    /**
+     * Display plugin settings
+     *
+     * @return void
+     */
+    private function displayPluginSettings(): void
+    {
+        $plugins = $this->config->getPlugins();
+        if (count($plugins) === 0) {
+            return;
+        }
+        $this->io->write('  <fg=magenta>Plugins:</>');
+        foreach ($plugins as $plugin) {
+            $this->io->write('    - <fg=cyan>' . $plugin->getPlugin() . '</>');
+            $this->displayOptions($plugin->getOptions(), '  ');
+        }
+    }
 }

tests/_files/config/valid-with-plugins.json

@@ -0,0 +1,39 @@
+{
+  "config": {
+    "plugins": [
+      {
+        "plugin": "\\CaptainHook\\App\\Plugin\\DummyPlugin",
+        "options": {"foo": "bar"}
+      }
+    ],
+    "custom": {
+      "foo": "bar",
+      "fiz": "baz"
+    }
+  },
+  "prepare-commit-msg": {
+    "enabled": true,
+    "actions": []
+  },
+  "commit-msg": {
+    "enabled": true,
+    "actions": []
+  },
+  "pre-commit": {
+    "enabled": true,
+    "actions": [
+      {
+        "action": "phpunit --configuration=build/phpunit-hook.xml",
+        "config": {
+          "label": "PHPUnit",
+          "allow-failure": true
+        },
+        "options": {}
+      }
+    ]
+  },
+  "pre-push": {
+    "enabled": false,
+    "actions": []
+  }
+}

tests/unit/Runner/Config/ReaderTest.php

@@ -51,6 +51,22 @@ public function testDoesNotAllowInvalidHookNames(): void
                ->run();
     }
 
+    public function testItDisplaysApplicationConfig(): void
+    {
+        $path   = realpath(CH_PATH_FILES . '/config/valid-with-plugins.json');
+        $config = Config\Factory::create($path);
+        $io     = $this->createIOMock();
+        $repo   = $this->createRepositoryMock();
+
+        $io->expects($this->atLeast(2))->method('write');
+
+        $runner = new Reader($io, $config, $repo);
+        $runner->setHook('pre-commit')
+            ->display(Reader::OPT_ACTIONS, true)
+            ->display(Reader::OPT_SETTINGS, true)
+            ->run();
+    }
+
     public function testItDisplaysActionConfig(): void
     {
         $path   = realpath(CH_PATH_FILES . '/config/valid.json');