Add the total error count in the loader (#38)

Author: Ph0tonic

src/BaselinePerIdentifierFormatter.php

@@ -70,6 +70,7 @@ public function formatErrors(
         ksort($fileErrors, SORT_STRING);
 
         $includes = [];
+        $totalErrorsCount = 0;
 
         foreach ($fileErrors as $identifier => $errors) {
             $errorsToOutput = [];
@@ -102,6 +103,7 @@ public function formatErrors(
             $includes[] = $identifier . '.neon';
             $baselineFilePath = $this->baselinesDir . '/' . $identifier . '.neon';
 
+            $totalErrorsCount += $errorsCount;
             $output->writeLineFormatted(sprintf('Writing baseline file %s with %d errors', $baselineFilePath, $errorsCount));
 
             $plurality = $errorsCount === 1 ? '' : 's';
@@ -114,7 +116,9 @@ public function formatErrors(
             }
         }
 
-        $writtenLoader = file_put_contents($this->baselinesDir . '/loader.neon', NeonHelper::encode(['includes' => $includes], $this->indent));
+        $plurality = $totalErrorsCount === 1 ? '' : 's';
+        $prefix = "# total $totalErrorsCount error$plurality\n";
+        $writtenLoader = file_put_contents($this->baselinesDir . '/loader.neon', $prefix . NeonHelper::encode(['includes' => $includes], $this->indent));
 
         if ($writtenLoader === false) {
             throw new LogicException('Error while writing to ' . $this->baselinesDir . '/loader.neon');

src/BaselineSplitter.php

@@ -58,11 +58,13 @@ public function split(string $loaderFilePath): array
 
         $outputInfo = [];
         $baselineFiles = [];
+        $totalErrorCount = 0;
 
         foreach ($groupedErrors as $identifier => $errors) {
             $fileName = $identifier . '.' . $extension;
             $filePath = $folder . '/' . $fileName;
             $errorsCount = array_reduce($errors, static fn(int $carry, array $item): int => $carry + $item['count'], 0);
+            $totalErrorCount += $errorsCount;
 
             $outputInfo[$filePath] = $errorsCount;
             $baselineFiles[] = $fileName;
@@ -74,7 +76,9 @@ public function split(string $loaderFilePath): array
             $this->writeFile($filePath, $encodedData);
         }
 
-        $baselineLoaderData = $handler->encodeBaselineLoader($baselineFiles, $this->indent);
+        $plural = $totalErrorCount === 1 ? '' : 's';
+        $prefix = "total $totalErrorCount error$plural";
+        $baselineLoaderData = $handler->encodeBaselineLoader($prefix, $baselineFiles, $this->indent);
         $this->writeFile($realPath, $baselineLoaderData);
 
         $outputInfo[$realPath] = null;

src/Handler/BaselineHandler.php

@@ -21,6 +21,6 @@ public function encodeBaseline(string $comment, array $errors, string $indent):
     /**
      * @param list<string> $filePaths
      */
-    public function encodeBaselineLoader(array $filePaths, string $indent): string;
+    public function encodeBaselineLoader(string $comment, array $filePaths, string $indent): string;
 
 }

src/Handler/NeonBaselineHandler.php

@@ -35,9 +35,10 @@ public function encodeBaseline(string $comment, array $errors, string $indent):
         return $prefix . NeonHelper::encode(['parameters' => ['ignoreErrors' => $errors]], $indent);
     }
 
-    public function encodeBaselineLoader(array $filePaths, string $indent): string
+    public function encodeBaselineLoader(string $comment, array $filePaths, string $indent): string
     {
-        return NeonHelper::encode(['includes' => $filePaths], $indent);
+        $prefix = "# $comment\n";
+        return $prefix . NeonHelper::encode(['includes' => $filePaths], $indent);
     }
 
 }

src/Handler/PhpBaselineHandler.php

@@ -52,9 +52,10 @@ public function encodeBaseline(string $comment, array $errors, string $indent):
         return $php;
     }
 
-    public function encodeBaselineLoader(array $filePaths, string $indent): string
+    public function encodeBaselineLoader(string $comment, array $filePaths, string $indent): string
     {
         $php = "<?php declare(strict_types = 1);\n\n";
+        $php .= "// $comment\n";
         $php .= "return ['includes' => [\n";
 
         foreach ($filePaths as $filePath) {

tests/Rule/data/baselines-neon/loader.neon

@@ -1,3 +1,4 @@
+# total 4 errors
 includes:
     - another.identifier.neon
     - missing-identifier.neon

tests/Rule/data/baselines-php/loader.php

@@ -1,5 +1,6 @@
 <?php declare(strict_types = 1);
 
+// total 4 errors
 return ['includes' => [
     __DIR__ . '/another.identifier.php',
     __DIR__ . '/missing-identifier.php',