Add PHPStan\dumpPhpDocType() function

Author: zonuexe

conf/config.neon

@@ -282,6 +282,7 @@ extensions:
 
 rules:
 	- PHPStan\Rules\Debug\DebugScopeRule
+	- PHPStan\Rules\Debug\DumpPhpDocTypeRule
 	- PHPStan\Rules\Debug\DumpTypeRule
 	- PHPStan\Rules\Debug\FileAssertRule
 

src/Rules/Debug/DumpPhpDocTypeRule.php

@@ -0,0 +1,58 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Debug;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use function count;
+use function sprintf;
+use function strtolower;
+
+/**
+ * @implements Rule<Node\Expr\FuncCall>
+ */
+final class DumpPhpDocTypeRule implements Rule
+{
+
+	public function __construct(private ReflectionProvider $reflectionProvider)
+	{
+	}
+
+	public function getNodeType(): string
+	{
+		return Node\Expr\FuncCall::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		if (!$node->name instanceof Node\Name) {
+			return [];
+		}
+
+		$functionName = $this->reflectionProvider->resolveFunctionName($node->name, $scope);
+		if ($functionName === null) {
+			return [];
+		}
+
+		if (strtolower($functionName) !== 'phpstan\dumpphpdoctype') {
+			return [];
+		}
+
+		if (count($node->getArgs()) === 0) {
+			return [];
+		}
+
+		return [
+			RuleErrorBuilder::message(
+				sprintf(
+					'Dumped type: %s',
+					$scope->getType($node->getArgs()[0]->value)->toPhpDocNode(),
+				),
+			)->nonIgnorable()->identifier('phpstan.dumpPhpDocType')->build(),
+		];
+	}
+
+}

src/Rules/Functions/CallToFunctionStatementWithoutSideEffectsRule.php

@@ -29,6 +29,7 @@ final class CallToFunctionStatementWithoutSideEffectsRule implements Rule
 
 	public const PHPSTAN_TESTING_FUNCTIONS = [
 		'PHPStan\\dumpType',
+		'PHPStan\\dumpPhpDocType',
 		'PHPStan\\debugScope',
 		'PHPStan\\Testing\\assertType',
 		'PHPStan\\Testing\\assertNativeType',

src/dumpType.php

@@ -13,3 +13,15 @@ function dumpType($value) // phpcs:ignore Squiz.Functions.GlobalFunction.Found
 {
 	return null;
 }
+
+/**
+ * @phpstan-pure
+ * @param mixed $value
+ * @return mixed
+ *
+ * @throws void
+ */
+function dumpPhpDocType($value) // phpcs:ignore Squiz.Functions.GlobalFunction.Found
+{
+	return null;
+}

tests/PHPStan/Rules/Debug/DumpPhpDocTypeRuleTest.php

@@ -0,0 +1,89 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Debug;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<DumpPhpDocTypeRule>
+ */
+class DumpPhpDocTypeRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new DumpPhpDocTypeRule($this->createReflectionProvider());
+	}
+
+	public function testRuleSymbols(): void
+	{
+		$this->analyse([__DIR__ . '/data/dump-phpdoc-type.php'], [
+			[
+				"Dumped type: array{'': ''}",
+				5,
+			],
+			[
+				"Dumped type: array{'\0': 'NUL', NUL: '\0'}",
+				6,
+			],
+			[
+				"Dumped type: array{' ': 'SP', SP: ' '}",
+				9,
+			],
+			[
+				"Dumped type: array{'foo ': 'ends with SP', ' foo': 'starts with SP', ' foo ': 'surrounded by SP', foo: 'no SP'}",
+				10,
+			],
+			[
+				"Dumped type: array{'foo?': 'foo?'}",
+				13,
+			],
+			[
+				"Dumped type: array{shallwedance: 'yes'}",
+				14,
+			],
+			[
+				"Dumped type: array{'shallwedance?': 'yes'}",
+				15,
+			],
+			[
+				"Dumped type: array{'Shall we dance': 'yes'}",
+				16,
+			],
+			[
+				"Dumped type: array{'Shall we dance?': 'yes'}",
+				17,
+			],
+			[
+				"Dumped type: array{shall_we_dance: 'yes'}",
+				18,
+			],
+			[
+				"Dumped type: array{'shall_we_dance?': 'yes'}",
+				19,
+			],
+			[
+				"Dumped type: array{shall-we-dance: 'yes'}",
+				20,
+			],
+			[
+				"Dumped type: array{'shall-we-dance?': 'yes'}",
+				21,
+			],
+			[
+				"Dumped type: array{'Let\'s go': 'Let\'s go'}",
+				22,
+			],
+			[
+				"Dumped type: array{Foo\\Bar: 'Foo\\\\Bar'}",
+				23,
+			],
+			[
+				"Dumped type: T",
+				32,
+			],
+		]);
+	}
+
+}

tests/PHPStan/Rules/Debug/data/dump-phpdoc-type.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace PHPStan;
+
+dumpPhpDocType(['' => '']);
+dumpPhpDocType(["\0" => 'NUL', 'NUL' => "\0"]);
+
+// Space
+dumpPhpDocType([" " => 'SP', 'SP' => ' ']);
+dumpPhpDocType(["foo " => 'ends with SP', " foo" => 'starts with SP', " foo " => 'surrounded by SP', 'foo' => 'no SP']);
+
+// Punctuation marks
+dumpPhpDocType(["foo?" => 'foo?']);
+dumpPhpDocType(["shallwedance" => 'yes']);
+dumpPhpDocType(["shallwedance?" => 'yes']);
+dumpPhpDocType(["Shall we dance" => 'yes']);
+dumpPhpDocType(["Shall we dance?" => 'yes']);
+dumpPhpDocType(["shall_we_dance" => 'yes']);
+dumpPhpDocType(["shall_we_dance?" => 'yes']);
+dumpPhpDocType(["shall-we-dance" => 'yes']);
+dumpPhpDocType(["shall-we-dance?" => 'yes']);
+dumpPhpDocType(['Let\'s go' => "Let's go"]);
+dumpPhpDocType(['Foo\\Bar' => 'Foo\\Bar']);
+
+/**
+ * @template T
+ * @param T $value
+ * @return T
+ */
+function id(mixed $value): mixed
+{
+	dumpPhpDocType($value);
+
+	return $value;
+}