Extract CollectorData virtual type

janedbal · janedbal · commit 02fb800db9a3 · 2025-03-18T15:15:52.000+01:00
diff --git a/src/Analyser/Analyser.php b/src/Analyser/Analyser.php
@@ -3,8 +3,7 @@
 namespace PHPStan\Analyser;
 
 use Closure;
-use PhpParser\Node;
-use PHPStan\Collectors\Collector;
+use PHPStan\Collectors\CollectedData;
 use PHPStan\Collectors\Registry as CollectorRegistry;
 use PHPStan\Rules\Registry as RuleRegistry;
 use Throwable;
@@ -13,6 +12,9 @@
 use function count;
 use function memory_get_peak_usage;
 
+/**
+ * @phpstan-import-type CollectorData from CollectedData
+ */
 final class Analyser
 {
 
@@ -60,7 +62,7 @@ public function analyse(
 		$linesToIgnore = [];
 		$unmatchedLineIgnores = [];
 
-		/** @var array<string, array<class-string<Collector<Node, mixed>>, list<mixed>>> $collectedData */
+		/** @var CollectorData $collectedData */
 		$collectedData = [];
 
 		$internalErrorsCount = 0;
diff --git a/src/Analyser/AnalyserResult.php b/src/Analyser/AnalyserResult.php
@@ -2,13 +2,13 @@
 
 namespace PHPStan\Analyser;
 
-use PhpParser\Node;
-use PHPStan\Collectors\Collector;
+use PHPStan\Collectors\CollectedData;
 use PHPStan\Dependency\RootExportedNode;
 use function usort;
 
 /**
  * @phpstan-import-type LinesToIgnore from FileAnalyserResult
+ * @phpstan-import-type CollectorData from CollectedData
  */
 final class AnalyserResult
 {
@@ -23,7 +23,7 @@ final class AnalyserResult
 	 * @param list<Error> $locallyIgnoredErrors
 	 * @param array<string, LinesToIgnore> $linesToIgnore
 	 * @param array<string, LinesToIgnore> $unmatchedLineIgnores
-	 * @param array<string, array<class-string<Collector<Node, mixed>>, list<mixed>>> $collectedData
+	 * @param CollectorData $collectedData
 	 * @param list<InternalError> $internalErrors
 	 * @param array<string, array<string>>|null $dependencies
 	 * @param array<string, array<RootExportedNode>> $exportedNodes
@@ -126,7 +126,7 @@ public function getInternalErrors(): array
 	}
 
 	/**
-	 * @return array<string, array<class-string<Collector<Node, mixed>>, list<mixed>>>
+	 * @return CollectorData
 	 */
 	public function getCollectedData(): array
 	{
diff --git a/src/Analyser/FileAnalyser.php b/src/Analyser/FileAnalyser.php
@@ -7,7 +7,7 @@
 use PHPStan\BetterReflection\NodeCompiler\Exception\UnableToCompileNode;
 use PHPStan\BetterReflection\Reflection\Exception\CircularReference;
 use PHPStan\BetterReflection\Reflector\Exception\IdentifierNotFound;
-use PHPStan\Collectors\Collector;
+use PHPStan\Collectors\CollectedData;
 use PHPStan\Collectors\Registry as CollectorRegistry;
 use PHPStan\Dependency\DependencyResolver;
 use PHPStan\Node\FileNode;
@@ -37,6 +37,9 @@
 use const E_USER_WARNING;
 use const E_WARNING;
 
+/**
+ * @phpstan-import-type CollectorData from CollectedData
+ */
 final class FileAnalyser
 {
 
@@ -76,7 +79,7 @@ public function analyseFile(
 		/** @var list<Error> $locallyIgnoredErrors */
 		$locallyIgnoredErrors = [];
 
-		/** @var array<string, array<class-string<Collector<Node, mixed>>, list<mixed>>> $fileCollectedData */
+		/** @var CollectorData $fileCollectedData */
 		$fileCollectedData = [];
 
 		$fileDependencies = [];
diff --git a/src/Analyser/FileAnalyserResult.php b/src/Analyser/FileAnalyserResult.php
@@ -2,12 +2,12 @@
 
 namespace PHPStan\Analyser;
 
-use PhpParser\Node;
-use PHPStan\Collectors\Collector;
+use PHPStan\Collectors\CollectedData;
 use PHPStan\Dependency\RootExportedNode;
 
 /**
  * @phpstan-type LinesToIgnore = array<string, array<int, non-empty-list<string>|null>>
+ * @phpstan-import-type CollectorData from CollectedData
  */
 final class FileAnalyserResult
 {
@@ -17,7 +17,7 @@ final class FileAnalyserResult
 	 * @param list<Error> $filteredPhpErrors
 	 * @param list<Error> $allPhpErrors
 	 * @param list<Error> $locallyIgnoredErrors
-	 * @param array<string, array<class-string<Collector<Node, mixed>>, list<mixed>>> $collectedData
+	 * @param CollectorData $collectedData
 	 * @param list<string> $dependencies
 	 * @param list<RootExportedNode> $exportedNodes
 	 * @param LinesToIgnore $linesToIgnore
@@ -70,7 +70,7 @@ public function getLocallyIgnoredErrors(): array
 	}
 
 	/**
-	 * @return array<string, array<class-string<Collector<Node, mixed>>, list<mixed>>>
+	 * @return CollectorData
 	 */
 	public function getCollectedData(): array
 	{
diff --git a/src/Analyser/ResultCache/ResultCache.php b/src/Analyser/ResultCache/ResultCache.php
@@ -2,14 +2,14 @@
 
 namespace PHPStan\Analyser\ResultCache;
 
-use PhpParser\Node;
 use PHPStan\Analyser\Error;
 use PHPStan\Analyser\FileAnalyserResult;
-use PHPStan\Collectors\Collector;
+use PHPStan\Collectors\CollectedData;
 use PHPStan\Dependency\RootExportedNode;
 
 /**
  * @phpstan-import-type LinesToIgnore from FileAnalyserResult
+ * @phpstan-import-type CollectorData from CollectedData
  */
 final class ResultCache
 {
@@ -21,7 +21,7 @@ final class ResultCache
 	 * @param array<string, list<Error>> $locallyIgnoredErrors
 	 * @param array<string, LinesToIgnore> $linesToIgnore
 	 * @param array<string, LinesToIgnore> $unmatchedLineIgnores
-	 * @param array<string, array<class-string<Collector<Node, mixed>>, list<mixed>>> $collectedData
+	 * @param CollectorData $collectedData
 	 * @param array<string, array<string>> $dependencies
 	 * @param array<string, array<RootExportedNode>> $exportedNodes
 	 * @param array<string, array{string, bool, string}> $projectExtensionFiles
@@ -102,7 +102,7 @@ public function getUnmatchedLineIgnores(): array
 	}
 
 	/**
-	 * @return array<string, array<class-string<Collector<Node, mixed>>, list<mixed>>>
+	 * @return CollectorData
 	 */
 	public function getCollectedData(): array
 	{
diff --git a/src/Analyser/ResultCache/ResultCacheManager.php b/src/Analyser/ResultCache/ResultCacheManager.php
@@ -3,12 +3,10 @@
 namespace PHPStan\Analyser\ResultCache;
 
 use Nette\Neon\Neon;
-use PhpParser\Node;
 use PHPStan\Analyser\AnalyserResult;
 use PHPStan\Analyser\Error;
 use PHPStan\Analyser\FileAnalyserResult;
 use PHPStan\Collectors\CollectedData;
-use PHPStan\Collectors\Collector;
 use PHPStan\Command\Output;
 use PHPStan\Dependency\ExportedNodeFetcher;
 use PHPStan\Dependency\RootExportedNode;
@@ -51,6 +49,7 @@
 
 /**
  * @phpstan-import-type LinesToIgnore from FileAnalyserResult
+ * @phpstan-import-type CollectorData from CollectedData
  */
 final class ResultCacheManager
 {
@@ -576,8 +575,8 @@ private function mergeLocallyIgnoredErrors(ResultCache $resultCache, array $fres
 	}
 
 	/**
-	 * @param array<string, array<class-string<Collector<Node, mixed>>, list<mixed>>> $freshCollectedDataByFile
-	 * @return array<string, array<class-string<Collector<Node, mixed>>, list<mixed>>>
+	 * @param CollectorData $freshCollectedDataByFile
+	 * @return CollectorData
 	 */
 	private function mergeCollectedData(ResultCache $resultCache, array $freshCollectedDataByFile): array
 	{
diff --git a/src/Collectors/CollectedData.php b/src/Collectors/CollectedData.php
@@ -8,6 +8,8 @@
 
 /**
  * @api
+ *
+ * @phpstan-type CollectorData = array<string, array<class-string<Collector<Node, mixed>>, list<mixed>>>
  */
 final class CollectedData implements JsonSerializable
 {
diff --git a/src/Command/AnalyseApplication.php b/src/Command/AnalyseApplication.php
@@ -2,13 +2,11 @@
 
 namespace PHPStan\Command;
 
-use PhpParser\Node;
 use PHPStan\Analyser\AnalyserResult;
 use PHPStan\Analyser\AnalyserResultFinalizer;
 use PHPStan\Analyser\Ignore\IgnoredErrorHelper;
 use PHPStan\Analyser\ResultCache\ResultCacheManagerFactory;
 use PHPStan\Collectors\CollectedData;
-use PHPStan\Collectors\Collector;
 use PHPStan\Internal\BytesHelper;
 use PHPStan\PhpDoc\StubFilesProvider;
 use PHPStan\PhpDoc\StubValidator;
@@ -22,6 +20,9 @@
 use function sha1_file;
 use function sprintf;
 
+/**
+ * @phpstan-import-type CollectorData from CollectedData
+ */
 final class AnalyseApplication
 {
 
@@ -164,7 +165,7 @@ public function analyse(
 	}
 
 	/**
-	 * @param array<string, array<class-string<Collector<Node, mixed>>, list<mixed>>> $collectedData
+	 * @param CollectorData $collectedData
 	 *
 	 * @return list<CollectedData>
 	 */
diff --git a/src/Node/CollectedDataNode.php b/src/Node/CollectedDataNode.php
@@ -4,16 +4,18 @@
 
 use PhpParser\Node;
 use PhpParser\NodeAbstract;
+use PHPStan\Collectors\CollectedData;
 use PHPStan\Collectors\Collector;
 
 /**
  * @api
+ * @phpstan-import-type CollectorData from CollectedData
  */
 final class CollectedDataNode extends NodeAbstract implements VirtualNode
 {
 
 	/**
-	 * @param array<string, array<class-string<Collector<Node, mixed>>, list<mixed>>> $collectedData
+	 * @param CollectorData $collectedData
 	 */
 	public function __construct(private array $collectedData, private bool $onlyFiles)
 	{

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,8 @@`
`8`	`8`
`9`	`9`	`/**`
`10`	`10`	`* @api`
	`11`	`+ *`
	`12`	`+ * @phpstan-type CollectorData = array<string, array<class-string<Collector<Node, mixed>>, list<mixed>>>`
`11`	`13`	`*/`
`12`	`14`	`final class CollectedData implements JsonSerializable`
`13`	`15`	`{`