RemovePropertyVariableNameDescriptionFixer: Support prefixed @var (#70)

* RemovePropertyVariableNameDescriptionFixer: Support prefixed `@var`

* Update RemovePropertyVariableNameDescriptionFixer.php

---------

Co-authored-by: Markus Staab <[email protected]>

Author: clxmstaab

src/Fixer/Annotation/RemovePropertyVariableNameDescriptionFixer.php

@@ -24,6 +24,12 @@ final class RemovePropertyVariableNameDescriptionFixer extends AbstractSymplifyF
      */
     private const ERROR_MESSAGE = 'Remove useless "$variable" from @var tag';
 
+    /**
+     * @var string
+     * @see https://regex101.com/r/2PxeKF/1
+     */
+    private const VAR_REGEX = '#@(?:psalm-|phpstan-)?var#';
+
     private readonly PropertyNameResolver $propertyNameResolver;
 
     public function __construct(
@@ -73,11 +79,11 @@ public function fix(SplFileInfo $fileInfo, Tokens $tokens): void
 
             $docblockLines = explode("\n", $originalDocContent);
             foreach ($docblockLines as $key => $docblockLine) {
-                if (! str_contains($docblockLine, '@var')) {
+                if (! str_ends_with($docblockLine, ' ' . $propertyName)) {
                     continue;
                 }
 
-                if (! str_ends_with($docblockLine, ' ' . $propertyName)) {
+                if (! preg_match(self::VAR_REGEX, $docblockLine)) {
                     continue;
                 }
 

tests/Fixer/Annotation/RemovePropertyVariableNameDescriptionFixer/Fixture/phpstan_annotation.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Symplify\CodingStandard\Tests\Fixer\Annotation\RemovePropertyVariableNameDescriptionFixer\Fixture;
+
+final class PhpstanAnnotation
+{
+    /**
+     * @phpstan-var string $name
+     */
+    public $name;
+}
+
+?>
+-----
+<?php
+
+namespace Symplify\CodingStandard\Tests\Fixer\Annotation\RemovePropertyVariableNameDescriptionFixer\Fixture;
+
+final class PhpstanAnnotation
+{
+    /**
+     * @phpstan-var string
+     */
+    public $name;
+}
+
+?>

tests/Fixer/Annotation/RemovePropertyVariableNameDescriptionFixer/Fixture/psalm_annotation.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Symplify\CodingStandard\Tests\Fixer\Annotation\RemovePropertyVariableNameDescriptionFixer\Fixture;
+
+final class PsalmAnnotation
+{
+    /**
+     * @psalm-var string $name
+     */
+    public $name;
+}
+
+?>
+-----
+<?php
+
+namespace Symplify\CodingStandard\Tests\Fixer\Annotation\RemovePropertyVariableNameDescriptionFixer\Fixture;
+
+final class PsalmAnnotation
+{
+    /**
+     * @psalm-var string
+     */
+    public $name;
+}
+
+?>