Local type aliases

Author: ondrejmirtes

build.xml

@@ -221,7 +221,7 @@
 			checkreturn="true"
 		>
 			<arg value="-d"/>
-			<arg value="memory_limit=768M"/>
+			<arg value="memory_limit=864M"/>
 			<arg path="${phpunit.executable}"/>
 			<arg value="-c"/>
 			<arg value="tests/phpunit.xml"/>

build/baseline-7.4.neon

@@ -93,6 +93,6 @@ parameters:
 			count: 1
 			path: ../src/Reflection/ReflectionProvider/SetterReflectionProviderProvider.php
 		-
-			message: "#^Class class@anonymous/src/Testing/TestCase\\.php\\:267 has an uninitialized property \\$reflectionProvider\\. Give it default value or assign it in the constructor\\.$#"
+			message: "#^Class class@anonymous/src/Testing/TestCase\\.php\\:270 has an uninitialized property \\$reflectionProvider\\. Give it default value or assign it in the constructor\\.$#"
 			count: 1
 			path: ../src/Testing/TestCase.php

conf/config.level0.neon

@@ -200,3 +200,10 @@ services:
 
 	-
 		class: PHPStan\Rules\Whitespace\FileWhitespaceRule
+
+	-
+		class: PHPStan\Rules\Classes\LocalTypeAliasesRule
+		arguments:
+			globalTypeAliases: %typeAliases%
+		tags:
+			- phpstan.rules.rule

conf/config.neon

@@ -366,13 +366,6 @@ services:
 	-
 		class: PHPStan\PhpDoc\ConstExprNodeResolver
 
-	-
-		class: PHPStan\PhpDoc\TypeAlias\TypeAliasesTypeNodeResolverExtension
-		arguments:
-			aliases: %typeAliases%
-		tags:
-			- phpstan.phpDoc.typeNodeResolverExtension
-
 	-
 		class: PHPStan\PhpDoc\TypeNodeResolver
 
@@ -747,7 +740,6 @@ services:
 		class: PHPStan\Rules\Generics\TemplateTypeCheck
 		arguments:
 			checkClassCaseSensitivity: %checkClassCaseSensitivity%
-			typeAliases: %typeAliases%
 
 	-
 		class: PHPStan\Rules\Generics\VarianceCheck
@@ -802,6 +794,11 @@ services:
 	-
 		class: PHPStan\Type\FileTypeMapper
 
+	-
+		class: PHPStan\Type\TypeAliasResolver
+		arguments:
+			globalTypeAliases: %typeAliases%
+
 	-
 		class: PHPStan\Type\Php\ArgumentBasedFunctionReturnTypeExtension
 		tags:

src/Analyser/NameScope.php

@@ -20,18 +20,21 @@ class NameScope
 
 	private TemplateTypeMap $templateTypeMap;
 
+	private bool $bypassTypeAliases;
+
 	/**
 	 * @param string|null $namespace
 	 * @param array<string, string> $uses alias(string) => fullName(string)
 	 * @param string|null $className
 	 */
-	public function __construct(?string $namespace, array $uses, ?string $className = null, ?string $functionName = null, ?TemplateTypeMap $templateTypeMap = null)
+	public function __construct(?string $namespace, array $uses, ?string $className = null, ?string $functionName = null, ?TemplateTypeMap $templateTypeMap = null, bool $bypassTypeAliases = false)
 	{
 		$this->namespace = $namespace;
 		$this->uses = $uses;
 		$this->className = $className;
 		$this->functionName = $functionName;
 		$this->templateTypeMap = $templateTypeMap ?? TemplateTypeMap::createEmpty();
+		$this->bypassTypeAliases = $bypassTypeAliases;
 	}
 
 	public function getNamespace(): ?string
@@ -137,6 +140,16 @@ public function unsetTemplateType(string $name): self
 		);
 	}
 
+	public function bypassTypeAliases(): self
+	{
+		return new self($this->namespace, $this->uses, $this->className, $this->functionName, $this->templateTypeMap, true);
+	}
+
+	public function shouldBypassTypeAliases(): bool
+	{
+		return $this->bypassTypeAliases;
+	}
+
 	/**
 	 * @param mixed[] $properties
 	 * @return self

src/PhpDoc/PhpDocNodeResolver.php

@@ -14,6 +14,8 @@
 use PHPStan\PhpDoc\Tag\ReturnTag;
 use PHPStan\PhpDoc\Tag\TemplateTag;
 use PHPStan\PhpDoc\Tag\ThrowsTag;
+use PHPStan\PhpDoc\Tag\TypeAliasImportTag;
+use PHPStan\PhpDoc\Tag\TypeAliasTag;
 use PHPStan\PhpDoc\Tag\UsesTag;
 use PHPStan\PhpDoc\Tag\VarTag;
 use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprNullNode;
@@ -365,6 +367,43 @@ public function resolveMixinTags(PhpDocNode $phpDocNode, NameScope $nameScope):
 		}, $phpDocNode->getMixinTagValues());
 	}
 
+	/**
+	 * @return array<string, TypeAliasTag>
+	 */
+	public function resolveTypeAliasTags(PhpDocNode $phpDocNode, NameScope $nameScope): array
+	{
+		$resolved = [];
+
+		foreach (['@psalm-type', '@phpstan-type'] as $tagName) {
+			foreach ($phpDocNode->getTypeAliasTagValues($tagName) as $typeAliasTagValue) {
+				$alias = $typeAliasTagValue->alias;
+				$typeNode = $typeAliasTagValue->type;
+				$resolved[$alias] = new TypeAliasTag($alias, $typeNode, $nameScope);
+			}
+		}
+
+		return $resolved;
+	}
+
+	/**
+	 * @return array<string, TypeAliasImportTag>
+	 */
+	public function resolveTypeAliasImportTags(PhpDocNode $phpDocNode, NameScope $nameScope): array
+	{
+		$resolved = [];
+
+		foreach (['@psalm-import-type', '@phpstan-import-type'] as $tagName) {
+			foreach ($phpDocNode->getTypeAliasImportTagValues($tagName) as $typeAliasImportTagValue) {
+				$importedAlias = $typeAliasImportTagValue->importedAlias;
+				$importedFrom = $nameScope->resolveStringName($typeAliasImportTagValue->importedFrom->name);
+				$importedAs = $typeAliasImportTagValue->importedAs;
+				$resolved[$importedAs ?? $importedAlias] = new TypeAliasImportTag($importedAlias, $importedFrom, $importedAs);
+			}
+		}
+
+		return $resolved;
+	}
+
 	public function resolveDeprecatedTag(PhpDocNode $phpDocNode, NameScope $nameScope): ?\PHPStan\PhpDoc\Tag\DeprecatedTag
 	{
 		foreach ($phpDocNode->getDeprecatedTagValues() as $deprecatedTagValue) {

src/PhpDoc/ResolvedPhpDocBlock.php

@@ -7,6 +7,8 @@
 use PHPStan\PhpDoc\Tag\ParamTag;
 use PHPStan\PhpDoc\Tag\ReturnTag;
 use PHPStan\PhpDoc\Tag\ThrowsTag;
+use PHPStan\PhpDoc\Tag\TypeAliasImportTag;
+use PHPStan\PhpDoc\Tag\TypeAliasTag;
 use PHPStan\PhpDoc\Tag\TypedTag;
 use PHPStan\PhpDoc\Tag\VarTag;
 use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocNode;
@@ -64,6 +66,12 @@ class ResolvedPhpDocBlock
 	/** @var array<MixinTag>|false */
 	private $mixinTags = false;
 
+	/** @var array<TypeAliasTag>|false */
+	private $typeAliasTags = false;
+
+	/** @var array<TypeAliasImportTag>|false */
+	private $typeAliasImportTags = false;
+
 	/** @var \PHPStan\PhpDoc\Tag\DeprecatedTag|false|null */
 	private $deprecatedTag = false;
 
@@ -133,6 +141,8 @@ public static function createEmpty(): self
 		$self->returnTag = null;
 		$self->throwsTag = null;
 		$self->mixinTags = [];
+		$self->typeAliasTags = [];
+		$self->typeAliasImportTags = [];
 		$self->deprecatedTag = null;
 		$self->isDeprecated = false;
 		$self->isInternal = false;
@@ -176,6 +186,8 @@ public function merge(array $parents, array $parentPhpDocBlocks): self
 		$result->returnTag = self::mergeReturnTags($this->getReturnTag(), $parents, $parentPhpDocBlocks);
 		$result->throwsTag = self::mergeThrowsTags($this->getThrowsTag(), $parents);
 		$result->mixinTags = $this->getMixinTags();
+		$result->typeAliasTags = $this->getTypeAliasTags();
+		$result->typeAliasImportTags = $this->getTypeAliasImportTags();
 		$result->deprecatedTag = $this->getDeprecatedTag();
 		$result->isDeprecated = $result->deprecatedTag !== null;
 		$result->isInternal = $this->isInternal();
@@ -219,6 +231,9 @@ public function changeParameterNamesByMapping(array $parameterNameMapping): self
 		$self->paramTags = $newParamTags;
 		$self->returnTag = $this->returnTag;
 		$self->throwsTag = $this->throwsTag;
+		$self->mixinTags = $this->mixinTags;
+		$self->typeAliasTags = $this->typeAliasTags;
+		$self->typeAliasImportTags = $this->typeAliasImportTags;
 		$self->deprecatedTag = $this->deprecatedTag;
 		$self->isDeprecated = $this->isDeprecated;
 		$self->isInternal = $this->isInternal;
@@ -399,6 +414,36 @@ public function getMixinTags(): array
 		return $this->mixinTags;
 	}
 
+	/**
+	 * @return array<TypeAliasTag>
+	 */
+	public function getTypeAliasTags(): array
+	{
+		if ($this->typeAliasTags === false) {
+			$this->typeAliasTags = $this->phpDocNodeResolver->resolveTypeAliasTags(
+				$this->phpDocNode,
+				$this->getNameScope()
+			);
+		}
+
+		return $this->typeAliasTags;
+	}
+
+	/**
+	 * @return array<TypeAliasImportTag>
+	 */
+	public function getTypeAliasImportTags(): array
+	{
+		if ($this->typeAliasImportTags === false) {
+			$this->typeAliasImportTags = $this->phpDocNodeResolver->resolveTypeAliasImportTags(
+				$this->phpDocNode,
+				$this->getNameScope()
+			);
+		}
+
+		return $this->typeAliasImportTags;
+	}
+
 	public function getDeprecatedTag(): ?\PHPStan\PhpDoc\Tag\DeprecatedTag
 	{
 		if ($this->deprecatedTag === false) {

src/PhpDoc/Tag/TypeAliasImportTag.php

@@ -0,0 +1,36 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\PhpDoc\Tag;
+
+final class TypeAliasImportTag
+{
+
+	private string $importedAlias;
+
+	private string $importedFrom;
+
+	private ?string $importedAs;
+
+	public function __construct(string $importedAlias, string $importedFrom, ?string $importedAs)
+	{
+		$this->importedAlias = $importedAlias;
+		$this->importedFrom = $importedFrom;
+		$this->importedAs = $importedAs;
+	}
+
+	public function getImportedAlias(): string
+	{
+		return $this->importedAlias;
+	}
+
+	public function getImportedFrom(): string
+	{
+		return $this->importedFrom;
+	}
+
+	public function getImportedAs(): ?string
+	{
+		return $this->importedAs;
+	}
+
+}

src/PhpDoc/Tag/TypeAliasTag.php

@@ -0,0 +1,41 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\PhpDoc\Tag;
+
+use PHPStan\Analyser\NameScope;
+use PHPStan\PhpDocParser\Ast\Type\TypeNode;
+
+class TypeAliasTag
+{
+
+	private string $aliasName;
+
+	private TypeNode $typeNode;
+
+	private NameScope $nameScope;
+
+	public function __construct(
+		string $aliasName,
+		TypeNode $typeNode,
+		NameScope $nameScope
+	)
+	{
+		$this->aliasName = $aliasName;
+		$this->typeNode = $typeNode;
+		$this->nameScope = $nameScope;
+	}
+
+	public function getAliasName(): string
+	{
+		return $this->aliasName;
+	}
+
+	public function getTypeAlias(): \PHPStan\Type\TypeAlias
+	{
+		return new \PHPStan\Type\TypeAlias(
+			$this->typeNode,
+			$this->nameScope
+		);
+	}
+
+}