UX: better gitlab reporting - add content field (#9152)

Author: keradus

src/Console/Report/FixReport/GitlabReporter.php

@@ -15,6 +15,9 @@
 namespace PhpCsFixer\Console\Report\FixReport;
 
 use PhpCsFixer\Console\Application;
+use PhpCsFixer\Documentation\DocumentationLocator;
+use PhpCsFixer\Fixer\FixerInterface;
+use PhpCsFixer\FixerFactory;
 use SebastianBergmann\Diff\Chunk;
 use SebastianBergmann\Diff\Diff;
 use SebastianBergmann\Diff\Line;
@@ -25,6 +28,7 @@
  * Generates a report according to gitlabs subset of codeclimate json files.
  *
  * @author Hans-Christian Otto <c.otto@suora.com>
+ * @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
  *
  * @see https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md#data-types
  *
@@ -37,10 +41,23 @@
 final class GitlabReporter implements ReporterInterface
 {
     private Parser $diffParser;
+    private DocumentationLocator $documentationLocator;
+    private FixerFactory $fixerFactory;
+
+    /**
+     * @var array<string, FixerInterface>
+     */
+    private array $fixers;
 
     public function __construct()
     {
         $this->diffParser = new Parser();
+        $this->documentationLocator = new DocumentationLocator();
+
+        $this->fixerFactory = new FixerFactory();
+        $this->fixerFactory->registerBuiltInFixers();
+
+        $this->fixers = $this->createFixers();
     }
 
     public function getFormat(): string
@@ -58,9 +75,23 @@ public function generate(ReportSummary $reportSummary): string
         $report = [];
         foreach ($reportSummary->getChanged() as $fileName => $change) {
             foreach ($change['appliedFixers'] as $fixerName) {
+                $fixer = $this->fixers[$fixerName] ?? null;
+
                 $report[] = [
                     'check_name' => 'PHP-CS-Fixer.'.$fixerName,
                     'description' => 'PHP-CS-Fixer.'.$fixerName.' by '.$about,
+                    'content' => [
+                        'body' => \sprintf(
+                            "%s\n%s",
+                            $about,
+                            null !== $fixer
+                                ? \sprintf(
+                                    'Check [docs](https://cs.symfony.com/doc/rules/%s.html) for more information.',
+                                    substr($this->documentationLocator->getFixerDocumentationFileRelativePath($fixer), 0, -4) // -4 to drop `.rst`
+                                )
+                                : 'Check performed with a custom rule.'
+                        ),
+                    ],
                     'categories' => ['Style'],
                     'fingerprint' => md5($fileName.$fixerName),
                     'severity' => 'minor',
@@ -122,4 +153,20 @@ private static function getBeginEndForDiffChunk(Chunk $chunk): array
             'end' => $start + $startRange,
         ];
     }
+
+    /**
+     * @return array<string, FixerInterface>
+     */
+    private function createFixers(): array
+    {
+        $fixers = [];
+
+        foreach ($this->fixerFactory->getFixers() as $fixer) {
+            $fixers[$fixer->getName()] = $fixer;
+        }
+
+        ksort($fixers);
+
+        return $fixers;
+    }
 }

tests/Console/Report/FixReport/GitlabReporterTest.php

@@ -56,6 +56,9 @@ protected static function createSimpleReport(): string
                             "categories": ["Style"],
                             "check_name": "PHP-CS-Fixer.some_fixer_name_here",
                             "description": "PHP-CS-Fixer.some_fixer_name_here by {$about}",
+                            "content": {
+                                "body": "{$about}\\nCheck performed with a custom rule."
+                            },
                             "fingerprint": "ad098ea6ea7a28dd85dfcdfc9e2bded0",
                             "severity": "minor",
                             "location": {
@@ -83,6 +86,9 @@ protected static function createWithAppliedFixersReport(): string
                             "categories": ["Style"],
                             "check_name": "PHP-CS-Fixer.some_fixer_name_here_1",
                             "description": "PHP-CS-Fixer.some_fixer_name_here_1 by {$about}",
+                            "content": {
+                                "body": "{$about}\\nCheck performed with a custom rule."
+                            },
                             "fingerprint": "b74e9385c8ae5b1f575c9c8226c7deff",
                             "severity": "minor",
                             "location": {
@@ -96,6 +102,9 @@ protected static function createWithAppliedFixersReport(): string
                             "categories": ["Style"],
                             "check_name": "PHP-CS-Fixer.some_fixer_name_here_2",
                             "description": "PHP-CS-Fixer.some_fixer_name_here_2 by {$about}",
+                            "content": {
+                                "body": "{$about}\\nCheck performed with a custom rule."
+                            },
                             "fingerprint": "acad4672140c737a83c18d1474d84074",
                             "severity": "minor",
                             "location": {
@@ -123,6 +132,9 @@ protected static function createComplexReport(): string
                             "categories": ["Style"],
                             "check_name": "PHP-CS-Fixer.some_fixer_name_here_1",
                             "description": "PHP-CS-Fixer.some_fixer_name_here_1 by {$about}",
+                            "content": {
+                                "body": "{$about}\\nCheck performed with a custom rule."
+                            },
                             "fingerprint": "b74e9385c8ae5b1f575c9c8226c7deff",
                             "severity": "minor",
                             "location": {
@@ -136,6 +148,9 @@ protected static function createComplexReport(): string
                             "categories": ["Style"],
                             "check_name": "PHP-CS-Fixer.some_fixer_name_here_2",
                             "description": "PHP-CS-Fixer.some_fixer_name_here_2 by {$about}",
+                            "content": {
+                                "body": "{$about}\\nCheck performed with a custom rule."
+                            },
                             "fingerprint": "acad4672140c737a83c18d1474d84074",
                             "severity": "minor",
                             "location": {
@@ -149,6 +164,9 @@ protected static function createComplexReport(): string
                             "categories": ["Style"],
                             "check_name": "PHP-CS-Fixer.another_fixer_name_here",
                             "description": "PHP-CS-Fixer.another_fixer_name_here by {$about}",
+                            "content": {
+                                "body": "{$about}\\nCheck performed with a custom rule."
+                            },
                             "fingerprint": "30e86e533dac0f1b93bbc3a55c6908f8",
                             "severity": "minor",
                             "location": {