Narrow types

Author: sebastianbergmann

src/Report/Xml/Facade.php

@@ -32,12 +32,19 @@
 use SebastianBergmann\CodeCoverage\Driver\WriteOperationFailedException;
 use SebastianBergmann\CodeCoverage\Node\AbstractNode;
 use SebastianBergmann\CodeCoverage\Node\Directory as DirectoryNode;
+use SebastianBergmann\CodeCoverage\Node\File;
 use SebastianBergmann\CodeCoverage\Node\File as FileNode;
 use SebastianBergmann\CodeCoverage\Util\Filesystem as DirectoryUtil;
 use SebastianBergmann\CodeCoverage\Version;
 use SebastianBergmann\CodeCoverage\XmlException;
 use SebastianBergmann\Environment\Runtime;
 
+/**
+ * @phpstan-import-type ProcessedClassType from File
+ * @phpstan-import-type ProcessedTraitType from File
+ * @phpstan-import-type ProcessedFunctionType from File
+ * @phpstan-import-type TestType from CodeCoverage
+ */
 final class Facade
 {
     private string $target;
@@ -175,6 +182,9 @@ private function processFile(FileNode $file, Directory $context): void
         $this->saveDocument($fileReport->asDom(), $file->id());
     }
 
+    /**
+     * @param ProcessedClassType|ProcessedTraitType $unit
+     */
     private function processUnit(array $unit, Report $report): void
     {
         if (isset($unit['className'])) {
@@ -205,6 +215,9 @@ private function processUnit(array $unit, Report $report): void
         }
     }
 
+    /**
+     * @param ProcessedFunctionType $function
+     */
     private function processFunction(array $function, Report $report): void
     {
         $functionObject = $report->functionObject($function['functionName']);
@@ -215,6 +228,9 @@ private function processFunction(array $function, Report $report): void
         $functionObject->setTotals((string) $function['executableLines'], (string) $function['executedLines'], (string) $function['coverage']);
     }
 
+    /**
+     * @param array<string, TestType> $tests
+     */
     private function processTests(array $tests): void
     {
         $testsObject = $this->project->tests();

src/Report/Xml/Report.php

@@ -40,7 +40,7 @@ public function asDom(): DOMDocument
         return $this->dom();
     }
 
-    public function functionObject($name): Method
+    public function functionObject(string $name): Method
     {
         $node = $this->contextNode()->appendChild(
             $this->dom()->createElementNS(
@@ -54,12 +54,12 @@ public function functionObject($name): Method
         return new Method($node, $name);
     }
 
-    public function classObject($name): Unit
+    public function classObject(string $name): Unit
     {
         return $this->unitObject('class', $name);
     }
 
-    public function traitObject($name): Unit
+    public function traitObject(string $name): Unit
     {
         return $this->unitObject('trait', $name);
     }
@@ -91,7 +91,7 @@ private function setName(string $name): void
         $this->contextNode()->setAttribute('path', dirname($name));
     }
 
-    private function unitObject(string $tagName, $name): Unit
+    private function unitObject(string $tagName, string $name): Unit
     {
         $node = $this->contextNode()->appendChild(
             $this->dom()->createElementNS(

src/StaticAnalysis/CachingFileAnalyser.php

@@ -23,6 +23,16 @@
 /**
  * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
  *
+ * @phpstan-type CachedDataForFile array{
+ *   interfacesIn: array<string, Interface_>,
+ *   classesIn: array<string, Class_>,
+ *   traitsIn: array<string, Trait_>,
+ *   functionsIn: array<string, Function_>,
+ *   linesOfCodeFor: LinesOfCode,
+ *   ignoredLinesFor: LinesType,
+ *   executableLinesIn: LinesType
+ * }
+ *
  * @phpstan-import-type LinesType from FileAnalyser
  */
 final class CachingFileAnalyser implements FileAnalyser
@@ -32,6 +42,10 @@ final class CachingFileAnalyser implements FileAnalyser
     private readonly FileAnalyser $analyser;
     private readonly bool $useAnnotationsForIgnoringCode;
     private readonly bool $ignoreDeprecatedCode;
+
+    /**
+     * @var array<non-empty-string, CachedDataForFile>
+     */
     private array $cache = [];
 
     public function __construct(string $directory, FileAnalyser $analyser, bool $useAnnotationsForIgnoringCode, bool $ignoreDeprecatedCode)
@@ -148,6 +162,9 @@ public function process(string $filename): void
         $this->write($filename, $this->cache[$filename]);
     }
 
+    /**
+     * @return CachedDataForFile|false
+     */
     private function read(string $filename): array|false
     {
         $cacheFile = $this->cacheFile($filename);
@@ -171,6 +188,9 @@ private function read(string $filename): array|false
         );
     }
 
+    /**
+     * @param CachedDataForFile $data
+     */
     private function write(string $filename, array $data): void
     {
         file_put_contents(

src/Target/MapBuilder.php

@@ -19,6 +19,7 @@
 
 /**
  * @phpstan-import-type TargetMap from Mapper
+ * @phpstan-import-type TargetMapPart from Mapper
  *
  * @immutable
  *
@@ -157,12 +158,13 @@ public function build(Filter $filter, FileAnalyser $analyser): array
     }
 
     /**
-     * @param-out array $data
-     *
+     * @param TargetMapPart    $data
      * @param non-empty-string $unit
      * @param non-empty-string $file
      * @param positive-int     $startLine
      * @param positive-int     $endLine
+     *
+     * @param-out TargetMapPart $data
      */
     private function process(array &$data, string $unit, string $file, int $startLine, int $endLine): void
     {