add Junit formatter to use in ci/cd environments (#110)

Co-authored-by: Jan Nedbal <janedbal@gmail.com>

Author: reinfi

README.md

@@ -80,6 +80,7 @@ This tool reads your `composer.json` and scans all paths listed in `autoload` &
 - `--help` display usage & cli options
 - `--verbose` to see more example classes & usages
 - `--show-all-usages` to see all usages
+- `--format` to use different output format, available are: console (default), junit
 - `--ignore-unknown-classes` to globally ignore unknown classes
 - `--ignore-shadow-deps` to globally ignore shadow dependencies
 - `--ignore-unused-deps` to globally ignore unused dependencies

bin/composer-dependency-analyser

@@ -7,7 +7,6 @@ use ShipMonk\ComposerDependencyAnalyser\Exception\InvalidConfigException;
 use ShipMonk\ComposerDependencyAnalyser\Exception\InvalidPathException;
 use ShipMonk\ComposerDependencyAnalyser\Initializer;
 use ShipMonk\ComposerDependencyAnalyser\Printer;
-use ShipMonk\ComposerDependencyAnalyser\Result\ResultFormatter;
 use ShipMonk\ComposerDependencyAnalyser\Stopwatch;
 
 error_reporting(E_ALL);
@@ -42,7 +41,7 @@ try {
     $analyser = new Analyser($stopwatch, $classLoaders, $configuration, $composerJson->dependencies);
     $result = $analyser->run();
 
-    $formatter = new ResultFormatter($cwd, $printer);
+    $formatter = $initializer->initFormatter($options);
     $exitCode = $formatter->format($result, $options, $configuration);
 
 } catch (

src/Cli.php

@@ -24,6 +24,7 @@ class Cli
         'config' => true,
         'dump-usages' => true,
         'show-all-usages' => false,
+        'format' => true,
     ];
 
     /**
@@ -167,6 +168,10 @@ public function getProvidedOptions(): CliOptions
             $options->showAllUsages = true;
         }
 
+        if (isset($this->providedOptions['format'])) {
+            $options->format = $this->providedOptions['format']; // @phpstan-ignore-line type is ensured
+        }
+
         return $options;
     }
 

src/CliOptions.php

@@ -60,4 +60,9 @@ class CliOptions
      */
     public $showAllUsages = null;
 
+    /**
+     * @var string|null
+     */
+    public $format = null;
+
 }

src/Initializer.php

@@ -8,6 +8,9 @@
 use ShipMonk\ComposerDependencyAnalyser\Exception\InvalidCliException;
 use ShipMonk\ComposerDependencyAnalyser\Exception\InvalidConfigException;
 use ShipMonk\ComposerDependencyAnalyser\Exception\InvalidPathException;
+use ShipMonk\ComposerDependencyAnalyser\Result\ConsoleFormatter;
+use ShipMonk\ComposerDependencyAnalyser\Result\JunitFormatter;
+use ShipMonk\ComposerDependencyAnalyser\Result\ResultFormatter;
 use Throwable;
 use function count;
 use function get_class;
@@ -32,6 +35,7 @@ class Initializer
     --composer-json <path>      Provide custom path to composer.json
     --config <path>             Provide path to php configuration file
                                 (must return \ShipMonk\ComposerDependencyAnalyser\Config\Configuration instance)
+    --format <format>           Change output format. Available values: console (default), junit
 
 Ignore options:
     (or use --config for better granularity)
@@ -210,4 +214,22 @@ public function initCliOptions(string $cwd, array $argv): CliOptions
         return $cliOptions;
     }
 
+    /**
+     * @throws InvalidConfigException
+     */
+    public function initFormatter(CliOptions $options): ResultFormatter
+    {
+        switch ($options->format) {
+            case 'junit':
+                return new JunitFormatter($this->cwd, $this->printer);
+
+            case 'console':
+            case null:
+                return new ConsoleFormatter($this->cwd, $this->printer);
+
+            default:
+                throw new InvalidConfigException("Invalid format option provided, allowed are 'console' or 'junit'.");
+        }
+    }
+
 }

src/Printer.php

@@ -26,6 +26,11 @@ public function printLine(string $string): void
         echo $this->colorize($string) . PHP_EOL;
     }
 
+    public function print(string $string): void
+    {
+        echo $this->colorize($string);
+    }
+
     private function colorize(string $string): string
     {
         return str_replace(array_keys(self::COLORS), array_values(self::COLORS), $string);