Add CLI option to remove error counts from baselines (#39)

maxime-vf · web-flow · commit 84ee6e3655e1 · 2025-04-10T16:18:16.000+02:00
* feat: add option to remove error counts from baselines

* test: Add tests for new option
diff --git a/README.md b/README.md
@@ -102,6 +102,7 @@ Prepare composer script to simplify generation:
 
 ## Cli options
 - ``--tabs`` to use tabs as indents in generated neon files
+- ``--no-error-count`` to remove errors count in generated files
 
 ## PHP Baseline
 - If the loader file extension is php, the generated files will be php files as well
diff --git a/bin/split-phpstan-baseline b/bin/split-phpstan-baseline
@@ -27,13 +27,14 @@ function error(string $message): void
 }
 
 /** @var int $restIndex */
-$providedOptions = getopt('', ['tabs'], $restIndex);
+$providedOptions = getopt('', ['tabs', 'no-error-count'], $restIndex);
 $args = array_slice($argv, $restIndex);
 
 $loaderFile = $args[0] ?? null;
 $indent = isset($providedOptions['tabs']) || in_array('--tabs', $args, true)
     ? "\t"
     : '    ';
+$includeCount = !(isset($providedOptions['no-error-count']) || in_array('--no-error-count', $args, true));
 
 if ($loaderFile === null) {
     error(
@@ -47,7 +48,7 @@ if (!is_file($loaderFile)) {
 }
 
 try {
-    $splitter = new BaselineSplitter($indent);
+    $splitter = new BaselineSplitter($indent, $includeCount);
     $writtenBaselines = $splitter->split($loaderFile);
 
     foreach ($writtenBaselines as $writtenBaseline => $errorsCount) {
diff --git a/src/BaselineSplitter.php b/src/BaselineSplitter.php
@@ -20,9 +20,12 @@ class BaselineSplitter
 
     private string $indent;
 
-    public function __construct(string $indent)
+    private bool $includeCount;
+
+    public function __construct(string $indent, bool $includeCount)
     {
         $this->indent = $indent;
+        $this->includeCount = $includeCount;
     }
 
     /**
@@ -70,14 +73,14 @@ public function split(string $loaderFilePath): array
             $baselineFiles[] = $fileName;
 
             $plural = $errorsCount === 1 ? '' : 's';
-            $prefix = "total $errorsCount error$plural";
+            $prefix = $this->includeCount ? "total $errorsCount error$plural" : null;
 
             $encodedData = $handler->encodeBaseline($prefix, $errors, $this->indent);
             $this->writeFile($filePath, $encodedData);
         }
 
         $plural = $totalErrorCount === 1 ? '' : 's';
-        $prefix = "total $totalErrorCount error$plural";
+        $prefix = $this->includeCount ? "total $totalErrorCount error$plural" : null;
         $baselineLoaderData = $handler->encodeBaselineLoader($prefix, $baselineFiles, $this->indent);
         $this->writeFile($realPath, $baselineLoaderData);
 
diff --git a/src/Handler/BaselineHandler.php b/src/Handler/BaselineHandler.php
@@ -16,11 +16,11 @@ public function decodeBaseline(string $filepath): array;
     /**
      * @param list<array{message: string, count: int, path: string}> $errors
      */
-    public function encodeBaseline(string $comment, array $errors, string $indent): string;
+    public function encodeBaseline(?string $comment, array $errors, string $indent): string;
 
     /**
      * @param list<string> $filePaths
      */
-    public function encodeBaselineLoader(string $comment, array $filePaths, string $indent): string;
+    public function encodeBaselineLoader(?string $comment, array $filePaths, string $indent): string;
 
 }
diff --git a/src/Handler/NeonBaselineHandler.php b/src/Handler/NeonBaselineHandler.php
@@ -29,15 +29,15 @@ public function decodeBaseline(string $filepath): array
         }
     }
 
-    public function encodeBaseline(string $comment, array $errors, string $indent): string
+    public function encodeBaseline(?string $comment, array $errors, string $indent): string
     {
-        $prefix = "# $comment\n\n";
+        $prefix = $comment !== null ? "# $comment\n\n" : '';
         return $prefix . NeonHelper::encode(['parameters' => ['ignoreErrors' => $errors]], $indent);
     }
 
-    public function encodeBaselineLoader(string $comment, array $filePaths, string $indent): string
+    public function encodeBaselineLoader(?string $comment, array $filePaths, string $indent): string
     {
-        $prefix = "# $comment\n";
+        $prefix = $comment !== null ? "# $comment\n" : '';
         return $prefix . NeonHelper::encode(['includes' => $filePaths], $indent);
     }
 
diff --git a/src/Handler/PhpBaselineHandler.php b/src/Handler/PhpBaselineHandler.php
@@ -28,11 +28,15 @@ public function decodeBaseline(string $filepath): array
         }
     }
 
-    public function encodeBaseline(string $comment, array $errors, string $indent): string
+    public function encodeBaseline(?string $comment, array $errors, string $indent): string
     {
         $php = '<?php declare(strict_types = 1);';
-        $php .= "\n\n";
-        $php .= "// $comment";
+
+        if ($comment !== null) {
+            $php .= "\n\n";
+            $php .= "// $comment";
+        }
+
         $php .= "\n\n";
         $php .= "\$ignoreErrors = [];\n";
 
@@ -52,10 +56,14 @@ public function encodeBaseline(string $comment, array $errors, string $indent):
         return $php;
     }
 
-    public function encodeBaselineLoader(string $comment, 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";
+
+        if ($comment !== null) {
+            $php .= "// $comment\n";
+        }
+
         $php .= "return ['includes' => [\n";
 
         foreach ($filePaths as $filePath) {
diff --git a/tests/Rule/data/baselines-neon-no-error-count/another.identifier.neon b/tests/Rule/data/baselines-neon-no-error-count/another.identifier.neon
@@ -0,0 +1,6 @@
+parameters:
+    ignoreErrors:
+        -
+            message: '#^Error to escape ''\#$#'
+            count: 1
+            path: ../app/config.php
diff --git a/tests/Rule/data/baselines-neon-no-error-count/loader.neon b/tests/Rule/data/baselines-neon-no-error-count/loader.neon
@@ -0,0 +1,4 @@
+includes:
+    - another.identifier.neon
+    - missing-identifier.neon
+    - sample.identifier.neon
diff --git a/tests/Rule/data/baselines-neon-no-error-count/missing-identifier.neon b/tests/Rule/data/baselines-neon-no-error-count/missing-identifier.neon
@@ -0,0 +1,6 @@
+parameters:
+    ignoreErrors:
+        -
+            message: '#^Error 3$#'
+            count: 1
+            path: ../app/index.php
diff --git a/tests/Rule/data/baselines-neon-no-error-count/sample.identifier.neon b/tests/Rule/data/baselines-neon-no-error-count/sample.identifier.neon
@@ -0,0 +1,6 @@
+parameters:
+    ignoreErrors:
+        -
+            message: '#^Error simple$#'
+            count: 2
+            path: ../app/file.php
diff --git a/tests/Rule/data/baselines-php-no-error-count/another.identifier.php b/tests/Rule/data/baselines-php-no-error-count/another.identifier.php
@@ -0,0 +1,10 @@
+<?php declare(strict_types = 1);
+
+$ignoreErrors = [];
+$ignoreErrors[] = [
+    'message' => '#^Error to escape \'\\#$#',
+    'count' => 1,
+    'path' => __DIR__ . '/../app/config.php',
+];
+
+return ['parameters' => ['ignoreErrors' => $ignoreErrors]];
diff --git a/tests/Rule/data/baselines-php-no-error-count/loader.php b/tests/Rule/data/baselines-php-no-error-count/loader.php
@@ -0,0 +1,7 @@
+<?php declare(strict_types = 1);
+
+return ['includes' => [
+    __DIR__ . '/another.identifier.php',
+    __DIR__ . '/missing-identifier.php',
+    __DIR__ . '/sample.identifier.php',
+]];
diff --git a/tests/Rule/data/baselines-php-no-error-count/missing-identifier.php b/tests/Rule/data/baselines-php-no-error-count/missing-identifier.php
@@ -0,0 +1,10 @@
+<?php declare(strict_types = 1);
+
+$ignoreErrors = [];
+$ignoreErrors[] = [
+    'message' => '#^Error 3$#',
+    'count' => 1,
+    'path' => __DIR__ . '/../app/index.php',
+];
+
+return ['parameters' => ['ignoreErrors' => $ignoreErrors]];
diff --git a/tests/Rule/data/baselines-php-no-error-count/sample.identifier.php b/tests/Rule/data/baselines-php-no-error-count/sample.identifier.php
@@ -0,0 +1,10 @@
+<?php declare(strict_types = 1);
+
+$ignoreErrors = [];
+$ignoreErrors[] = [
+    'message' => '#^Error simple$#',
+    'count' => 2,
+    'path' => __DIR__ . '/../app/file.php',
+];
+
+return ['parameters' => ['ignoreErrors' => $ignoreErrors]];
diff --git a/tests/SplitterTest.php b/tests/SplitterTest.php
@@ -42,6 +42,36 @@ public function testBinaryWithPhp(): void
         self::assertFileEquals(__DIR__ . '/Rule/data/baselines-php/missing-identifier.php', $fakeRoot . '/baselines/missing-identifier.php');
     }
 
+    public function testBinaryWithNeonNoErrorCount(): void
+    {
+        $fakeRoot = $this->prepareSampleFolder();
+        $squashed = $this->getSampleErrors();
+
+        file_put_contents($fakeRoot . '/baselines/loader.neon', Neon::encode($squashed));
+
+        $this->runCommand('php bin/split-phpstan-baseline ' . $fakeRoot . '/baselines/loader.neon --no-error-count', __DIR__ . '/..', 0);
+
+        self::assertFileEquals(__DIR__ . '/Rule/data/baselines-neon-no-error-count/loader.neon', $fakeRoot . '/baselines/loader.neon');
+        self::assertFileEquals(__DIR__ . '/Rule/data/baselines-neon-no-error-count/sample.identifier.neon', $fakeRoot . '/baselines/sample.identifier.neon');
+        self::assertFileEquals(__DIR__ . '/Rule/data/baselines-neon-no-error-count/another.identifier.neon', $fakeRoot . '/baselines/another.identifier.neon');
+        self::assertFileEquals(__DIR__ . '/Rule/data/baselines-neon-no-error-count/missing-identifier.neon', $fakeRoot . '/baselines/missing-identifier.neon');
+    }
+
+    public function testBinaryWithPhpNoErrorCount(): void
+    {
+        $fakeRoot = $this->prepareSampleFolder();
+        $squashed = $this->getSampleErrors();
+
+        file_put_contents($fakeRoot . '/baselines/loader.php', '<?php return ' . var_export($squashed, true) . ';');
+
+        $this->runCommand('php bin/split-phpstan-baseline ' . $fakeRoot . '/baselines/loader.php --no-error-count', __DIR__ . '/..', 0);
+
+        self::assertFileEquals(__DIR__ . '/Rule/data/baselines-php-no-error-count/loader.php', $fakeRoot . '/baselines/loader.php');
+        self::assertFileEquals(__DIR__ . '/Rule/data/baselines-php-no-error-count/sample.identifier.php', $fakeRoot . '/baselines/sample.identifier.php');
+        self::assertFileEquals(__DIR__ . '/Rule/data/baselines-php-no-error-count/another.identifier.php', $fakeRoot . '/baselines/another.identifier.php');
+        self::assertFileEquals(__DIR__ . '/Rule/data/baselines-php-no-error-count/missing-identifier.php', $fakeRoot . '/baselines/missing-identifier.php');
+    }
+
     public function testSplitter(): void
     {
         $folder = $this->prepareSampleFolder();
@@ -50,7 +80,7 @@ public function testSplitter(): void
         $loaderPath = $folder . '/baselines/loader.neon';
         file_put_contents($loaderPath, Neon::encode($squashed));
 
-        $splitter = new BaselineSplitter("\t");
+        $splitter = new BaselineSplitter("\t", true);
         $written = $splitter->split($loaderPath);
 
         self::assertSame([

Original file line number	Diff line number	Diff line change
`@@ -29,15 +29,15 @@ public function decodeBaseline(string $filepath): array`
`29`	`29`	`}`
`30`	`30`	`}`
`31`	`31`
`32`		`- public function encodeBaseline(string $comment, array $errors, string $indent): string`
	`32`	`+ public function encodeBaseline(?string $comment, array $errors, string $indent): string`
`33`	`33`	`{`
`34`		`- $prefix = "# $comment\n\n";`
	`34`	`+ $prefix = $comment !== null ? "# $comment\n\n" : '';`
`35`	`35`	`return $prefix . NeonHelper::encode(['parameters' => ['ignoreErrors' => $errors]], $indent);`
`36`	`36`	`}`
`37`	`37`
`38`		`- public function encodeBaselineLoader(string $comment, array $filePaths, string $indent): string`
	`38`	`+ public function encodeBaselineLoader(?string $comment, array $filePaths, string $indent): string`
`39`	`39`	`{`
`40`		`- $prefix = "# $comment\n";`
	`40`	`+ $prefix = $comment !== null ? "# $comment\n" : '';`
`41`	`41`	`return $prefix . NeonHelper::encode(['includes' => $filePaths], $indent);`
`42`	`42`	`}`
`43`	`43`