Allow to use custom reporters

UPGRADE.md

@@ -6,6 +6,7 @@ UPGRADE FROM 2.x to 3.0
 - The position of `TrailingCommaMultiLineRule` error changed.
 - The position of `TrailingCommaSingleLineRule` error changed.
 - `TwigCsFixer\Command\TwigCsFixerCommand` class moved to `TwigCsFixer\Console\Command` folder.
+- `TwigCsFixer\Report\Reporter\ReporterInterface` now require a `getName` method.
 
 If you never implemented a custom rule, nothing else changed. Otherwise, ...
 

docs/command.md

@@ -11,6 +11,9 @@ Supported formats are:
 - `junit` following JUnit schema XML from Jenkins.
 - `null` if you don't want any reporting.
 
+If you implemented and configured [a custom reporter](configuration.md#Custom-Reporters),
+it can be used too.
+
 ## Debug mode
 
 The `--debug` option displays error identifiers instead of messages. This is

docs/configuration.md

@@ -50,7 +50,7 @@ vendor/bin/twig-cs-fixer lint --config=dir/.twig-cs-fixer.php /path/to/code
 ## Non fixable rules
 
 Most of the rules are automatically fixable but some of them are not.
-By default, the twig-cs-fixer disable all the non-fixable-rules, but you can still allow them in the config file:
+By default, the twig-cs-fixer disable all the non-fixable-rules, but you can still allow them in your config file:
 
 ```php
 <?php
@@ -75,7 +75,7 @@ Still, these rules can be useful for some static analysis. All of them can be fo
 By default, all `.twig` files in the current directory are linted, except the ones in the `vendor` directory.
 
 If you want to lint specific files or directories you can pass them as argument.
-If you want a more sophisticated rule, you can configure it in the config file:
+If you want a more sophisticated rule, you can configure it in your config file:
 
 ```php
 <?php
@@ -123,6 +123,21 @@ $config->setCacheFile(null);
 return $config;
 ```
 
+## Custom Reporters
+
+By default, the output of the tool is rendered in one the following formats:
+`text`, `checkstyle`, `github`, `junit`, `null`. If you want to use a custom
+format for reporting, you can configure it in your config file:
+
+```php
+<?php
+
+$config = new TwigCsFixer\Config\Config();
+$config->addCustomReporter(new App\Twig\CustomReporter());
+
+return $config;
+```
+
 ## Token parser, Twig Extension & Node Visitors
 
 If you're using custom token parsers or binary/unary operators, they can be added in your config:

src/Config/Config.php

@@ -10,6 +10,7 @@
 use Twig\TokenParser\TokenParserInterface;
 use TwigCsFixer\Cache\Manager\CacheManagerInterface;
 use TwigCsFixer\File\Finder as TwigCsFinder;
+use TwigCsFixer\Report\Reporter\ReporterInterface;
 use TwigCsFixer\Ruleset\Ruleset;
 use TwigCsFixer\Standard\TwigCsFixer;
 
@@ -30,6 +31,11 @@ final class Config
 
     private ?CacheManagerInterface $cacheManager = null;
 
+    /**
+     * @var list<ReporterInterface>
+     */
+    private array $customReporters = [];
+
     /**
      * @var list<ExtensionInterface>
      */
@@ -109,13 +115,31 @@ public function getCacheFile(): ?string
         return $this->cacheFile;
     }
 
+    /**
+     * @return $this
+     */
     public function setCacheFile(?string $cacheFile): self
     {
         $this->cacheFile = $cacheFile;
 
         return $this;
     }
 
+    public function addCustomReporter(ReporterInterface $reporter): self
+    {
+        $this->customReporters[] = $reporter;
+
+        return $this;
+    }
+
+    /**
+     * @return list<ReporterInterface>
+     */
+    public function getCustomReporters(): array
+    {
+        return $this->customReporters;
+    }
+
     /**
      * @return $this
      */

src/Console/Command/TwigCsFixerCommand.php

@@ -141,7 +141,7 @@ private function runLinter(Config $config, InputInterface $input, OutputInterfac
             $input->getOption('fix') ? new Fixer($tokenizer) : null,
         );
 
-        $reporterFactory = new ReporterFactory();
+        $reporterFactory = new ReporterFactory($config->getCustomReporters());
         $reporter = $reporterFactory->getReporter($input->getOption('report'));
         $reporter->display($output, $report, $input->getOption('level'), $input->getOption('debug'));
 

src/Report/Reporter/CheckstyleReporter.php

@@ -12,6 +12,11 @@ final class CheckstyleReporter implements ReporterInterface
 {
     public const NAME = 'checkstyle';
 
+    public function getName(): string
+    {
+        return self::NAME;
+    }
+
     public function display(
         OutputInterface $output,
         Report $report,

src/Report/Reporter/GithubReporter.php

@@ -17,6 +17,11 @@ final class GithubReporter implements ReporterInterface
 {
     public const NAME = 'github';
 
+    public function getName(): string
+    {
+        return self::NAME;
+    }
+
     public function display(
         OutputInterface $output,
         Report $report,

src/Report/Reporter/JUnitReporter.php

@@ -12,6 +12,11 @@ final class JUnitReporter implements ReporterInterface
 {
     public const NAME = 'junit';
 
+    public function getName(): string
+    {
+        return self::NAME;
+    }
+
     public function display(
         OutputInterface $output,
         Report $report,

src/Report/Reporter/NullReporter.php

@@ -14,6 +14,11 @@ final class NullReporter implements ReporterInterface
 {
     public const NAME = 'null';
 
+    public function getName(): string
+    {
+        return self::NAME;
+    }
+
     public function display(
         OutputInterface $output,
         Report $report,

src/Report/Reporter/ReporterInterface.php

@@ -15,4 +15,6 @@ public function display(
         ?string $level,
         bool $debug
     ): void;
+
+    public function getName(): string;
 }

src/Report/Reporter/TextReporter.php

@@ -23,6 +23,11 @@ final class TextReporter implements ReporterInterface
     private const ERROR_LINE_FORMAT = '%-5s| %s';
     private const ERROR_LINE_WIDTH = 120;
 
+    public function getName(): string
+    {
+        return self::NAME;
+    }
+
     public function display(
         OutputInterface $output,
         Report $report,

src/Report/ReporterFactory.php

@@ -13,8 +13,22 @@
 
 final class ReporterFactory
 {
+    /**
+     * @param list<ReporterInterface> $customReporters
+     */
+    public function __construct(
+        private array $customReporters = []
+    ) {
+    }
+
     public function getReporter(string $format = TextReporter::NAME): ReporterInterface
     {
+        foreach ($this->customReporters as $reporter) {
+            if ($format === $reporter->getName()) {
+                return $reporter;
+            }
+        }
+
         return match ($format) {
             NullReporter::NAME => new NullReporter(),
             TextReporter::NAME => new TextReporter(),

tests/Config/ConfigTest.php

@@ -14,6 +14,7 @@
 use TwigCsFixer\Cache\Manager\NullCacheManager;
 use TwigCsFixer\Config\Config;
 use TwigCsFixer\File\Finder as TwigCsFinder;
+use TwigCsFixer\Report\Reporter\NullReporter;
 use TwigCsFixer\Ruleset\Ruleset;
 use TwigCsFixer\Standard\TwigCsFixer;
 
@@ -73,6 +74,15 @@ public function testConfigCacheFile(): void
         static::assertNull($config->getCacheFile());
     }
 
+    public function testConfigCustomReporters(): void
+    {
+        $config = new Config();
+        static::assertCount(0, $config->getCustomReporters());
+
+        $config->addCustomReporter(new NullReporter());
+        static::assertCount(1, $config->getCustomReporters());
+    }
+
     public function testConfigTokenParsers(): void
     {
         $config = new Config();

tests/Report/Reporter/CheckstyleReporterTest.php

@@ -15,6 +15,11 @@
 
 final class CheckstyleReporterTest extends TestCase
 {
+    public function testGetName(): void
+    {
+        static::assertSame(CheckstyleReporter::NAME, (new CheckstyleReporter())->getName());
+    }
+
     /**
      * @dataProvider displayDataProvider
      */

tests/Report/Reporter/GithubReporterTest.php

@@ -15,6 +15,11 @@
 
 final class GithubReporterTest extends TestCase
 {
+    public function testGetName(): void
+    {
+        static::assertSame(GithubReporter::NAME, (new GithubReporter())->getName());
+    }
+
     /**
      * @dataProvider displayDataProvider
      */

tests/Report/Reporter/JUnitReporterTest.php

@@ -15,6 +15,11 @@
 
 final class JUnitReporterTest extends TestCase
 {
+    public function testGetName(): void
+    {
+        static::assertSame(JUnitReporter::NAME, (new JUnitReporter())->getName());
+    }
+
     /**
      * @dataProvider displayDataProvider
      */

tests/Report/Reporter/NullReporterTest.php

@@ -14,6 +14,11 @@
 
 final class NullReporterTest extends TestCase
 {
+    public function testGetName(): void
+    {
+        static::assertSame(NullReporter::NAME, (new NullReporter())->getName());
+    }
+
     /**
      * @dataProvider displayDataProvider
      */

tests/Report/Reporter/TextReporterTest.php

@@ -15,6 +15,11 @@
 
 final class TextReporterTest extends TestCase
 {
+    public function testGetName(): void
+    {
+        static::assertSame(TextReporter::NAME, (new TextReporter())->getName());
+    }
+
     /**
      * @dataProvider displayDataProvider
      */

tests/Report/ReporterFactoryTest.php

@@ -5,10 +5,13 @@
 namespace TwigCsFixer\Tests\Report;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Output\OutputInterface;
+use TwigCsFixer\Report\Report;
 use TwigCsFixer\Report\Reporter\CheckstyleReporter;
 use TwigCsFixer\Report\Reporter\GithubReporter;
 use TwigCsFixer\Report\Reporter\JUnitReporter;
 use TwigCsFixer\Report\Reporter\NullReporter;
+use TwigCsFixer\Report\Reporter\ReporterInterface;
 use TwigCsFixer\Report\Reporter\TextReporter;
 use TwigCsFixer\Report\ReporterFactory;
 
@@ -26,11 +29,33 @@ public function testGetReporter(): void
         static::assertInstanceOf(GithubReporter::class, $reporterFactory->getReporter(GithubReporter::NAME));
     }
 
-    public function testGetMessageForAnotherFile(): void
+    public function testGetUnsupporterReporter(): void
     {
         $reporterFactory = new ReporterFactory();
 
         $this->expectExceptionMessage('No reporter supports the format "foo".');
         $reporterFactory->getReporter('foo');
     }
+
+    public function testGetCustomReporter(): void
+    {
+        $fooReporter = new class() implements ReporterInterface {
+            public function getName(): string
+            {
+                return 'foo';
+            }
+
+            public function display(
+                OutputInterface $output,
+                Report $report,
+                ?string $level,
+                bool $debug
+            ): void {
+            }
+        };
+
+        $reporterFactory = new ReporterFactory([$fooReporter]);
+
+        static::assertSame($fooReporter, $reporterFactory->getReporter('foo'));
+    }
 }