fix: ensure issues are reported always in the same order

peckphp · Dec 27, 2024 · fdc4aa1 · fdc4aa1
1 parent 4d6d232
commit fdc4aa1
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 25 deletions.
diff --git a/src/Checkers/FileSystemChecker.php b/src/Checkers/FileSystemChecker.php
@@ -60,6 +60,8 @@ public function check(array $parameters): array
             ];
         }
 
-        return $issues;
+        usort($issues, fn (Issue $a, Issue $b): int => $a->file <=> $b->file);
+
+        return array_values($issues);
     }
 }
diff --git a/tests/Unit/Checkers/FileSystemCheckerTest.php b/tests/Unit/Checkers/FileSystemCheckerTest.php
@@ -37,30 +37,30 @@
             'typo\'s',
             'types',
             'type\'s',
-        ])->and($issues[1]->file)->toEndWith('tests/Fixtures/FolderWithTypoos/FolderThatShouldBeIgnored/FileThatShoudBeIgnoredBecauseItsInsideWhitelistedFolder.php')
+        ])->and($issues[1]->file)->toEndWith('tests/Fixtures/FolderWithTypoos/FileThatShouldBeIgnroed.php')
         ->and($issues[1]->line)->toBe(0)
-        ->and($issues[1]->misspelling->word)->toBe('shoud')
+        ->and($issues[1]->misspelling->word)->toBe('ignroed')
         ->and($issues[1]->misspelling->suggestions)->toBe([
-            'should',
-            'shroud',
-            'shod',
-            'shout',
-        ])->and($issues[2]->file)->toEndWith('tests/Fixtures/FolderWithTypoos/FileThatShouldBeIgnroed.php')
-        ->and($issues[2]->line)->toBe(0)
-        ->and($issues[2]->misspelling->word)->toBe('ignroed')
-        ->and($issues[2]->misspelling->suggestions)->toBe([
             'ignored',
             'ignores',
             'ignore',
             'inroad',
-        ])->and($issues[3]->file)->toEndWith('tests/Fixtures/FolderWithTypoos/FileWithTppyo.php')
-        ->and($issues[3]->line)->toBe(0)
-        ->and($issues[3]->misspelling->word)->toBe('tppyo')
-        ->and($issues[3]->misspelling->suggestions)->toBe([
+        ])->and($issues[2]->file)->toEndWith('tests/Fixtures/FolderWithTypoos/FileWithTppyo.php')
+        ->and($issues[2]->line)->toBe(0)
+        ->and($issues[2]->misspelling->word)->toBe('tppyo')
+        ->and($issues[2]->misspelling->suggestions)->toBe([
             'typo',
             'Tokyo',
             'typos',
             'topi',
+        ])->and($issues[3]->file)->toEndWith('tests/Fixtures/FolderWithTypoos/FolderThatShouldBeIgnored/FileThatShoudBeIgnoredBecauseItsInsideWhitelistedFolder.php')
+        ->and($issues[3]->line)->toBe(0)
+        ->and($issues[3]->misspelling->word)->toBe('shoud')
+        ->and($issues[3]->misspelling->suggestions)->toBe([
+            'should',
+            'shroud',
+            'shod',
+            'shout',
         ]);
 });
 
@@ -90,22 +90,23 @@
             'typo\'s',
             'types',
             'type\'s',
-        ])->and($issues[1]->file)->toEndWith('tests/Fixtures/FolderWithTypoos/FolderThatShouldBeIgnored/FileThatShoudBeIgnoredBecauseItsInsideWhitelistedFolder.php')
+        ])->and($issues[1]->file)->toEndWith('tests/Fixtures/FolderWithTypoos/FileWithTppyo.php')
         ->and($issues[1]->line)->toBe(0)
-        ->and($issues[1]->misspelling->word)->toBe('shoud')
+        ->and($issues[1]->misspelling->word)->toBe('tppyo')
         ->and($issues[1]->misspelling->suggestions)->toBe([
-            'should',
-            'shroud',
-            'shod',
-            'shout',
-        ])->and($issues[2]->file)->toEndWith('tests/Fixtures/FolderWithTypoos/FileWithTppyo.php')
-        ->and($issues[2]->line)->toBe(0)
-        ->and($issues[2]->misspelling->word)->toBe('tppyo')
-        ->and($issues[2]->misspelling->suggestions)->toBe([
             'typo',
             'Tokyo',
             'typos',
             'topi',
+        ])
+        ->and($issues[2]->file)->toEndWith('tests/Fixtures/FolderWithTypoos/FolderThatShouldBeIgnored/FileThatShoudBeIgnoredBecauseItsInsideWhitelistedFolder.php')
+        ->and($issues[2]->line)->toBe(0)
+        ->and($issues[2]->misspelling->word)->toBe('shoud')
+        ->and($issues[2]->misspelling->suggestions)->toBe([
+            'should',
+            'shroud',
+            'shod',
+            'shout',
         ]);
 });