Playground rule - StaticVarWithoutTypeRule

Author: ondrejmirtes

issue-bot/playground.neon

@@ -3,3 +3,11 @@ rules:
 	- PHPStan\Rules\Playground\MethodNeverRule
 	- PHPStan\Rules\Playground\NotAnalysedTraitRule
 	- PHPStan\Rules\Playground\NoPhpCodeRule
+
+conditionalTags:
+	PHPStan\Rules\Playground\StaticVarWithoutTypeRule:
+		phpstan.rules.rule: %checkImplicitMixed%
+
+services:
+	-
+		class: PHPStan\Rules\Playground\StaticVarWithoutTypeRule

src/Rules/Playground/StaticVarWithoutTypeRule.php

@@ -0,0 +1,81 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Playground;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\ShouldNotHappenException;
+use PHPStan\Type\FileTypeMapper;
+use function count;
+use function is_string;
+
+/**
+ * @implements Rule<Node\Stmt\Static_>
+ */
+final class StaticVarWithoutTypeRule implements Rule
+{
+
+	public function __construct(
+		private FileTypeMapper $fileTypeMapper,
+	)
+	{
+	}
+
+	public function getNodeType(): string
+	{
+		return Node\Stmt\Static_::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		$docComment = $node->getDocComment();
+		$ruleError = RuleErrorBuilder::message('Static variable needs to be typed with PHPDoc @var tag.')
+			->identifier('phpstanPlayground.staticWithoutType')
+			->build();
+		if ($docComment === null) {
+			return [$ruleError];
+		}
+		$variableNames = [];
+		foreach ($node->vars as $var) {
+			if (!is_string($var->var->name)) {
+				throw new ShouldNotHappenException();
+			}
+
+			$variableNames[] = $var->var->name;
+		}
+
+		$function = $scope->getFunction();
+		$resolvedPhpDoc = $this->fileTypeMapper->getResolvedPhpDoc(
+			$scope->getFile(),
+			$scope->isInClass() ? $scope->getClassReflection()->getName() : null,
+			$scope->isInTrait() ? $scope->getTraitReflection()->getName() : null,
+			$function !== null ? $function->getName() : null,
+			$docComment->getText(),
+		);
+		$varTags = [];
+		foreach ($resolvedPhpDoc->getVarTags() as $key => $varTag) {
+			$varTags[$key] = $varTag;
+		}
+
+		if (count($varTags) === 0) {
+			return [$ruleError];
+		}
+
+		if (count($variableNames) === 1 && count($varTags) === 1 && isset($varTags[0])) {
+			return [];
+		}
+
+		foreach ($variableNames as $variableName) {
+			if (isset($varTags[$variableName])) {
+				continue;
+			}
+
+			return [$ruleError];
+		}
+
+		return [];
+	}
+
+}

tests/PHPStan/Rules/Playground/StaticVarWithoutTypeRuleTest.php

@@ -0,0 +1,34 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Playground;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use PHPStan\Type\FileTypeMapper;
+
+/**
+ * @extends RuleTestCase<StaticVarWithoutTypeRule>
+ */
+class StaticVarWithoutTypeRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new StaticVarWithoutTypeRule(self::getContainer()->getByType(FileTypeMapper::class));
+	}
+
+	public function testRule(): void
+	{
+		$this->analyse([__DIR__ . '/data/static-var-without-type.php'], [
+			[
+				'Static variable needs to be typed with PHPDoc @var tag.',
+				23,
+			],
+			[
+				'Static variable needs to be typed with PHPDoc @var tag.',
+				28,
+			],
+		]);
+	}
+
+}

tests/PHPStan/Rules/Playground/data/static-var-without-type.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace StaticVarWithoutType;
+
+class Foo
+{
+
+	public function doFoo(): void
+	{
+		/** @var int */
+		static $i = 0;
+	}
+
+	public function doBar(): void
+	{
+		/** @var int $i */
+		static $i = 0;
+	}
+
+	public function doBaz(): void
+	{
+		/** @var int $j */
+		static $i = 0;
+	}
+
+	public function doLorem(): void
+	{
+		static $i = 0;
+	}
+
+}