Playground: Implement PhpdocCommentRule

Author: staabm

issue-bot/playground.neon

@@ -3,6 +3,7 @@ rules:
 	- PHPStan\Rules\Playground\MethodNeverRule
 	- PHPStan\Rules\Playground\NotAnalysedTraitRule
 	- PHPStan\Rules\Playground\NoPhpCodeRule
+	- PHPStan\Rules\Playground\PhpdocCommentRule
 
 conditionalTags:
 	PHPStan\Rules\Playground\StaticVarWithoutTypeRule:

src/Rules/Playground/PhpdocCommentRule.php

@@ -0,0 +1,52 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Playground;
+
+use Nette\Utils\Strings;
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\VirtualNode;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use function str_starts_with;
+
+/**
+ * @implements Rule<Node\Stmt>
+ */
+final class PhpdocCommentRule implements Rule
+{
+
+	public function getNodeType(): string
+	{
+		return Node\Stmt::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		if ($node instanceof VirtualNode) {
+			return [];
+		}
+
+		$comments = $node->getComments();
+
+		$errors = [];
+		foreach ($comments as $comment) {
+			foreach (['/**', '//', '#'] as $startTag) {
+				if (str_starts_with($comment->getText(), $startTag)) {
+					continue 2;
+				}
+			}
+
+			if (Strings::match($comment->getText(), '{(\s|^)@\w+(\s|$)}') === null) {
+				continue;
+			}
+
+			$errors[] =	RuleErrorBuilder::message('Comment contains PHPDoc tag but does not start with /** prefix.')
+				->identifier('phpstanPlayground.phpDoc')
+				->build();
+		}
+
+		return $errors;
+	}
+
+}

tests/PHPStan/Rules/Playground/PhpdocCommentRuleTest.php

@@ -0,0 +1,33 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Playground;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<PhpdocCommentRule>
+ */
+class PhpdocCommentRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new PhpdocCommentRule();
+	}
+
+	public function testRule(): void
+	{
+		$this->analyse([__DIR__ . '/data/comments.php'], [
+			[
+				'Comment contains PHPDoc tag but does not start with /** prefix.',
+				13,
+			],
+			[
+				'Comment contains PHPDoc tag but does not start with /** prefix.',
+				23,
+			],
+		]);
+	}
+
+}

tests/PHPStan/Rules/Playground/data/comments.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace CommentTypes;
+
+/**
+ * @template T of FooInterface
+ */
+class Bar
+{
+	/*
+	 * @var T $foo
+	 */
+	protected FooInterface $foo;
+
+	/**
+	 * @param T $foo
+	 */
+	public function __construct(FooInterface $foo) { $this->foo = $foo; }
+
+	/*
+	 * @return T
+	 */
+	public function getFoo(): FooInterface
+	{
+		return $this->foo;
+	}
+
+	/*
+	 * some method
+	 */
+	public function getBar(): FooInterface
+	{
+		return $this->foo;
+	}
+
+	// this should not error: @var
+	# this should not error: @var
+
+	/*
+	 * comments which look like phpdoc should be ignored
+	 *
+	 * x@x.cz
+	 * 10 amps @ 1 volt
+	 */
+	public function ignoreComments(): FooInterface
+	{
+		return $this->foo;
+	}
+}