Nicer type descriptions usable in PHPDocs

phpstan · Oct 12, 2021 · 03341cc · 03341cc · staabm · Oct 12, 2021
1 parent f7d232a
commit 03341cc
Show file tree

Hide file tree

Showing 52 changed files with 333 additions and 284 deletions.
diff --git a/build/baseline-8.0.neon b/build/baseline-8.0.neon
@@ -11,7 +11,7 @@ parameters:
 			path: ../src/Type/Php/MbFunctionsReturnTypeExtension.php
 
 		-
-			message: "#^Strict comparison using \\=\\=\\= between array<int, string>&nonEmpty and false will always evaluate to false\\.$#"
+			message: "#^Strict comparison using \\=\\=\\= between non-empty-array<int, string> and false will always evaluate to false\\.$#"
 			count: 1
 			path: ../src/Type/Php/StrSplitFunctionReturnTypeExtension.php
 

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -259,6 +259,11 @@ parameters:
 			count: 1
 			path: src/Testing/PHPStanTestCase.php
 
+		-
+			message: "#^Call to function in_array\\(\\) with arguments 'array', array\\<int, 'array'\\|'string'\\> and true will always evaluate to true\\.$#"
+			count: 1
+			path: src/Type/IntersectionType.php
+
 		-
 			message:
 				"""

diff --git a/src/Type/Accessory/AccessoryNumericStringType.php b/src/Type/Accessory/AccessoryNumericStringType.php
@@ -84,7 +84,7 @@ public function equals(Type $type): bool
 
 	public function describe(\PHPStan\Type\VerbosityLevel $level): string
 	{
-		return 'numeric';
+		return 'numeric-string';
 	}
 
 	public function isOffsetAccessible(): TrinaryLogic

diff --git a/src/Type/Accessory/NonEmptyArrayType.php b/src/Type/Accessory/NonEmptyArrayType.php
@@ -83,7 +83,7 @@ public function equals(Type $type): bool
 
 	public function describe(\PHPStan\Type\VerbosityLevel $level): string
 	{
-		return 'nonEmpty';
+		return 'non-empty-array';
 	}
 
 	public function isOffsetAccessible(): TrinaryLogic

diff --git a/src/Type/IntersectionType.php b/src/Type/IntersectionType.php
@@ -149,45 +149,75 @@ function () use ($level): string {
 				return implode('&', $typeNames);
 			},
 			function () use ($level): string {
-				$typeNames = [];
-				$accessoryTypes = [];
-				foreach ($this->types as $type) {
-					if ($type instanceof AccessoryNonEmptyStringType || $type instanceof AccessoryLiteralStringType) {
-						$accessoryTypes[] = $type;
-					}
-					if ($type instanceof AccessoryType && !$type instanceof AccessoryNumericStringType && !$type instanceof NonEmptyArrayType && !$type instanceof AccessoryNonEmptyStringType) {
-						continue;
-					}
-					$typeNames[] = $type->describe($level);
-				}
-
-				if (count($accessoryTypes) > 0) {
-					return implode('&', array_map(static function (Type $type) use ($level): string {
-						return $type->describe($level);
-					}, $accessoryTypes));
-				}
-
-				return implode('&', $typeNames);
+				return $this->describeItself($level, true);
 			},
 			function () use ($level): string {
-				$typeNames = [];
-				$accessoryTypes = [];
-				foreach ($this->types as $type) {
-					if ($type instanceof AccessoryNonEmptyStringType || $type instanceof AccessoryLiteralStringType) {
-						$accessoryTypes[] = $type;
+				return $this->describeItself($level, false);
+			}
+		);
+	}
+
+	private function describeItself(VerbosityLevel $level, bool $skipAccessoryTypes): string
+	{
+		$typesToDescribe = [];
+		$skipTypeNames = [];
+		foreach ($this->types as $type) {
+			if ($type instanceof AccessoryNonEmptyStringType || $type instanceof AccessoryLiteralStringType || $type instanceof AccessoryNumericStringType) {
+				$typesToDescribe[] = $type;
+				$skipTypeNames[] = 'string';
+				continue;
+			}
+			if ($type instanceof NonEmptyArrayType) {
+				$typesToDescribe[] = $type;
+				$skipTypeNames[] = 'array';
+				continue;
+			}
+
+			if ($skipAccessoryTypes) {
+				continue;
+			}
+
+			if (!$type instanceof AccessoryType) {
+				continue;
+			}
+
+			$typesToDescribe[] = $type;
+		}
+
+		$describedTypes = [];
+		foreach ($this->types as $type) {
+			if ($type instanceof AccessoryType) {
+				continue;
+			}
+			$typeDescription = $type->describe($level);
+			if (
+				substr($typeDescription, 0, strlen('array<')) === 'array<'
+				&& in_array('array', $skipTypeNames, true)
+			) {
+				foreach ($typesToDescribe as $j => $typeToDescribe) {
+					if (!$typeToDescribe instanceof NonEmptyArrayType) {
+						continue;
 					}
-					$typeNames[] = $type->describe($level);
-				}
 
-				if (count($accessoryTypes) > 0) {
-					return implode('&', array_map(static function (Type $type) use ($level): string {
-						return $type->describe($level);
-					}, $accessoryTypes));
+					unset($typesToDescribe[$j]);
 				}
 
-				return implode('&', $typeNames);
+				$describedTypes[] = 'non-empty-array<' . substr($typeDescription, strlen('array<'));
+				continue;
 			}
-		);
+
+			if (in_array($typeDescription, $skipTypeNames, true)) {
+				continue;
+			}
+
+			$describedTypes[] = $type->describe($level);
+		}
+
+		foreach ($typesToDescribe as $typeToDescribe) {
+			$describedTypes[] = $typeToDescribe->describe($level);
+		}
+
+		return implode('&', $describedTypes);
 	}
 
 	public function canAccessProperties(): TrinaryLogic

diff --git a/src/Type/VerbosityLevel.php b/src/Type/VerbosityLevel.php
@@ -69,11 +69,13 @@ public static function getRecommendedLevelByType(Type $acceptingType, ?Type $acc
 				$moreVerbose = true;
 				return $type;
 			}
-			if ($type instanceof AccessoryNumericStringType || $type instanceof AccessoryNonEmptyStringType || $type instanceof AccessoryLiteralStringType) {
-				$moreVerbose = true;
-				return $type;
-			}
-			if ($type instanceof NonEmptyArrayType) {
+			if (
+				// synced with IntersectionType::describe()
+				$type instanceof AccessoryNonEmptyStringType
+				|| $type instanceof AccessoryLiteralStringType
+				|| $type instanceof AccessoryNumericStringType
+				|| $type instanceof NonEmptyArrayType
+			) {
 				$moreVerbose = true;
 				return $type;
 			}