CI and Code Quality Tools Setup (#1)

Author: floriankraemer

.github/workflows/ci.yml

@@ -2,9 +2,9 @@ name: CI
 
 on:
   push:
-    branches: [ main, develop ]
+    branches: [ master, main, develop ]
   pull_request:
-    branches: [ main, develop ]
+    branches: [ master, main, develop ]
 
 jobs:
   test:
@@ -56,7 +56,7 @@ jobs:
           composer install --no-interaction --prefer-dist
 
       - name: Run PHPUnit
-        run: vendor/bin/phpunit
+        run: composer test
 
   code-quality:
     name: Code Quality
@@ -89,8 +89,7 @@ jobs:
         run: composer install --no-interaction --prefer-dist
 
       - name: Run PHPStan
-        run: vendor/bin/phpstan analyse --level=8 src
+        run: composer analyse
 
       - name: Run PHPCS
-        run: vendor/bin/phpcs
-
+        run: composer cs-check

.gitignore

@@ -1,3 +1,4 @@
+/bin/
 /vendor/
 /.phpunit.cache/
 composer.lock

README.md

@@ -111,4 +111,3 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 ## Copyright
 
 Copyright (c) Florian Krämer (https://florian-kraemer.net)
-

composer.json

@@ -37,15 +37,16 @@
     },
     "config": {
         "sort-packages": true,
+        "bin-dir": "./bin",
         "allow-plugins": {
             "phpstan/extension-installer": true
         }
     },
     "scripts": {
-        "cs-check": "phpcs --standard=PSR12 src tests",
-        "cs-fix": "phpcbf --standard=PSR12 src tests",
-        "test": "phpunit",
-        "analyse": "phpstan analyse --level=8 src",
+        "cs-check": "./bin/phpcs",
+        "cs-fix": "./bin/phpcbf",
+        "test": "./bin/phpunit",
+        "analyse": "./bin/phpstan analyse",
         "quality": [
             "@cs-check",
             "@analyse",

phpstan.neon.dist

@@ -0,0 +1,5 @@
+parameters:
+    level: 8
+    paths:
+        - src
+        - tests

tests/Unit/ExecutionTimeReportPrinterTest.php

@@ -27,7 +27,7 @@ public function testPrintWithEmptyTestTimes(): void
 
         ob_start();
         $printer->print();
-        $output = ob_get_clean();
+        $output = ob_get_clean() ?: '';
 
         $this->assertEmpty($output);
     }
@@ -41,7 +41,7 @@ public function testPrintWithZeroTopN(): void
 
         ob_start();
         $printer->print();
-        $output = ob_get_clean();
+        $output = ob_get_clean() ?: '';
 
         $this->assertEmpty($output);
     }
@@ -55,7 +55,7 @@ public function testPrintWithSingleTest(): void
 
         ob_start();
         $printer->print();
-        $output = ob_get_clean();
+        $output = ob_get_clean() ?: '';
 
         $this->assertStringContainsString('Top 1 slowest tests:', $output);
         $this->assertStringContainsString('Test1', $output);
@@ -74,7 +74,7 @@ public function testPrintSortsTestsByTimeDescending(): void
 
         ob_start();
         $printer->print();
-        $output = ob_get_clean();
+        $output = ob_get_clean() ?: '';
 
         $slowPos = strpos($output, 'SlowTest');
         $mediumPos = strpos($output, 'MediumTest');
@@ -98,7 +98,7 @@ public function testPrintRespectsTopNParameter(): void
 
         ob_start();
         $printer->print();
-        $output = ob_get_clean();
+        $output = ob_get_clean() ?: '';
 
         $this->assertStringContainsString('Top 2 slowest tests:', $output);
         $this->assertStringContainsString('Test1', $output);
@@ -116,7 +116,7 @@ public function testPrintAlignsColumns(): void
 
         ob_start();
         $printer->print();
-        $output = ob_get_clean();
+        $output = ob_get_clean() ?: '';
 
         $lines = explode("\n", $output);
         $testLines = array_filter($lines, static fn(string $line): bool => str_contains($line, '.'));
@@ -146,7 +146,7 @@ public function testPrintFormatsTimeCorrectly(): void
 
         ob_start();
         $printer->print();
-        $output = ob_get_clean();
+        $output = ob_get_clean() ?: '';
 
         $this->assertStringContainsString('123.00 ms', $output);
         $this->assertStringContainsString('0.123 s', $output);