Add type declarations

Author: sebastianbergmann

src/CodeCoverage.php

@@ -47,21 +47,15 @@ final class CodeCoverage
 
     private Filter $filter;
 
-    /**
-     * @var Wizard
-     */
-    private $wizard;
+    private Wizard $wizard;
 
     private bool $checkForUnintentionallyCoveredCode = false;
 
     private bool $includeUncoveredFiles = true;
 
     private bool $ignoreDeprecatedCode = false;
 
-    /**
-     * @var PhptTestCase|string|TestCase
-     */
-    private $currentId;
+    private PhptTestCase|string|TestCase|null $currentId;
 
     private ProcessedCodeCoverageData $data;
 
@@ -150,12 +144,7 @@ public function setTests(array $tests): void
         $this->tests = $tests;
     }
 
-    /**
-     * Start collection of code coverage information.
-     *
-     * @param PhptTestCase|string|TestCase $id
-     */
-    public function start($id, bool $clear = false): void
+    public function start(PhptTestCase|string|TestCase $id, bool $clear = false): void
     {
         if ($clear) {
             $this->clear();
@@ -166,12 +155,7 @@ public function start($id, bool $clear = false): void
         $this->driver->start();
     }
 
-    /**
-     * Stop collection of code coverage information.
-     *
-     * @param array|false $linesToBeCovered
-     */
-    public function stop(bool $append = true, $linesToBeCovered = [], array $linesToBeUsed = []): RawCodeCoverageData
+    public function stop(bool $append = true, array|false $linesToBeCovered = [], array $linesToBeUsed = []): RawCodeCoverageData
     {
         if (!is_array($linesToBeCovered) && $linesToBeCovered !== false) {
             throw new InvalidArgumentException(
@@ -188,16 +172,11 @@ public function stop(bool $append = true, $linesToBeCovered = [], array $linesTo
     }
 
     /**
-     * Appends code coverage data.
-     *
-     * @param PhptTestCase|string|TestCase $id
-     * @param array|false                  $linesToBeCovered
-     *
      * @throws ReflectionException
      * @throws TestIdMissingException
      * @throws UnintentionallyCoveredCodeException
      */
-    public function append(RawCodeCoverageData $rawData, $id = null, bool $append = true, $linesToBeCovered = [], array $linesToBeUsed = []): void
+    public function append(RawCodeCoverageData $rawData, PhptTestCase|string|TestCase|null $id = null, bool $append = true, array|false $linesToBeCovered = [], array $linesToBeUsed = []): void
     {
         if ($id === null) {
             $id = $this->currentId;
@@ -367,14 +346,10 @@ public function detectsDeadCode(): bool
     }
 
     /**
-     * Applies the @covers annotation filtering.
-     *
-     * @param array|false $linesToBeCovered
-     *
      * @throws ReflectionException
      * @throws UnintentionallyCoveredCodeException
      */
-    private function applyCoversAnnotationFilter(RawCodeCoverageData $rawData, $linesToBeCovered, array $linesToBeUsed): void
+    private function applyCoversAnnotationFilter(RawCodeCoverageData $rawData, array|false $linesToBeCovered, array $linesToBeUsed): void
     {
         if ($linesToBeCovered === false) {
             $rawData->clear();

src/Report/Text.php

@@ -317,10 +317,7 @@ private function printCoverageCounts(int $numberOfCoveredElements, int $totalNum
         sprintf($format, $totalNumberOfElements) . ')';
     }
 
-    /**
-     * @param false|string $string
-     */
-    private function format(string $color, int $padding, $string): string
+    private function format(string $color, int $padding, string|false $string): string
     {
         $reset = $color ? self::COLOR_RESET : '';
 

src/StaticAnalysis/Cache.php

@@ -50,10 +50,8 @@ protected function has(string $filename, string $key): bool
 
     /**
      * @psalm-param list<class-string> $allowedClasses
-     *
-     * @return mixed
      */
-    protected function read(string $filename, string $key, array $allowedClasses = [])
+    protected function read(string $filename, string $key, array $allowedClasses = []): mixed
     {
         $options = ['allowed_classes' => false];
 
@@ -69,10 +67,7 @@ protected function read(string $filename, string $key, array $allowedClasses = [
         );
     }
 
-    /**
-     * @param mixed $data
-     */
-    protected function write(string $filename, string $key, $data): void
+    protected function write(string $filename, string $key, mixed $data): void
     {
         file_put_contents(
             $this->cacheFile($filename, $key),

tests/tests/CodeCoverageTest.php

@@ -39,20 +39,6 @@ protected function setUp(): void
         );
     }
 
-    public function testCannotStopWithInvalidSecondArgument(): void
-    {
-        $this->expectException(Exception::class);
-
-        $this->coverage->stop(true, null);
-    }
-
-    public function testCannotAppendWithInvalidArgument(): void
-    {
-        $this->expectException(Exception::class);
-
-        $this->coverage->append(RawCodeCoverageData::fromXdebugWithoutPathCoverage([]), null);
-    }
-
     public function testCollect(): void
     {
         $coverage = $this->getLineCoverageForBankAccount();