Unify array shape description with PHPDoc type syntax

phpstan · Oct 13, 2021 · 51d7431 · 51d7431
1 parent 2b3ee60
commit 51d7431
Show file tree

Hide file tree

Showing 78 changed files with 443 additions and 401 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -235,7 +235,7 @@ parameters:
 			path: src/Rules/Api/ApiTraitUseRule.php
 
 		-
-			message: "#^Binary operation \"\\+\" between array\\(class\\-string\\<TNodeType of PhpParser\\\\Node\\>\\) and array\\<string, class\\-string\\>\\|false results in an error\\.$#"
+			message: "#^Binary operation \"\\+\" between array{class\\-string\\<TNodeType of PhpParser\\\\Node\\>} and array\\<string, class\\-string\\>\\|false results in an error\\.$#"
 			count: 1
 			path: src/Rules/Registry.php
 

diff --git a/src/Type/Constant/ConstantArrayType.php b/src/Type/Constant/ConstantArrayType.php
@@ -728,7 +728,16 @@ public function describe(VerbosityLevel $level): string
 					$exportValuesOnly = false;
 				}
 
-				$items[] = sprintf('%s%s => %s', $isOptional ? '?' : '', var_export($keyType->getValue(), true), $valueType->describe($level));
+				$keyDescription = $keyType->getValue();
+				if (is_string($keyDescription)) {
+					if (strpos($keyDescription, '"') !== false) {
+						$keyDescription = sprintf('\'%s\'', $keyDescription);
+					} elseif (strpos($keyDescription, '\'') !== false) {
+						$keyDescription = sprintf('"%s"', $keyDescription);
+					}
+				}
+
+				$items[] = sprintf('%s%s: %s', $keyDescription, $isOptional ? '?' : '', $valueType->describe($level));
 				$values[] = $valueType->describe($level);
 			}
 
@@ -740,7 +749,7 @@ public function describe(VerbosityLevel $level): string
 			}
 
 			return sprintf(
-				'array(%s%s)',
+				'array{%s%s}',
 				implode(', ', $exportValuesOnly ? $values : $items),
 				$append
 			);