PhpdocNoIncorrectVarAnnotationFixer - fix for typed properties (#652)

Author: kubawerlos

README.md

@@ -3,7 +3,7 @@
 [![Latest stable version](https://img.shields.io/packagist/v/kubawerlos/php-cs-fixer-custom-fixers.svg?label=current%20version)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 [![PHP version](https://img.shields.io/packagist/php-v/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://php.net)
 [![License](https://img.shields.io/github/license/kubawerlos/php-cs-fixer-custom-fixers.svg)](LICENSE)
-![Tests](https://img.shields.io/badge/tests-3030-brightgreen.svg)
+![Tests](https://img.shields.io/badge/tests-3033-brightgreen.svg)
 [![Downloads](https://img.shields.io/packagist/dt/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 
 [![CI Status](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/workflows/CI/badge.svg?branch=main&event=push)](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/actions)

src/Fixer/PhpdocNoIncorrectVarAnnotationFixer.php

@@ -18,6 +18,7 @@
 use PhpCsFixer\FixerDefinition\FixerDefinition;
 use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
 use PhpCsFixer\Preg;
+use PhpCsFixer\Tokenizer\CT;
 use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
 use PhpCsFixerCustomFixers\TokenRemover;
@@ -71,7 +72,7 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
             }
 
             if ($tokens[$nextIndex]->isGivenKind([\T_PRIVATE, \T_PROTECTED, \T_PUBLIC, \T_VAR, \T_STATIC])) {
-                $this->removeForClassElement($tokens, $index);
+                $this->removeForClassElement($tokens, $index, $nextIndex);
                 continue;
             }
 
@@ -94,20 +95,27 @@ private function isTokenCandidate(Token $token): bool
         return $token->isGivenKind(\T_DOC_COMMENT) && \stripos($token->getContent(), '@var') !== false;
     }
 
-    private function removeForClassElement(Tokens $tokens, int $index): void
+    private function removeForClassElement(Tokens $tokens, int $index, int $propertyStartIndex): void
     {
-        /** @var int $nextIndex */
-        $nextIndex = $tokens->getTokenNotOfKindsSibling($index, 1, [\T_PRIVATE, \T_PROTECTED, \T_PUBLIC, \T_VAR, \T_STATIC, \T_WHITESPACE]);
+        $tokenKinds = [\T_NS_SEPARATOR, \T_STATIC, \T_STRING, \T_WHITESPACE, CT::T_ARRAY_TYPEHINT, CT::T_NULLABLE_TYPE, CT::T_TYPE_ALTERNATION];
 
-        if ($tokens[$nextIndex]->isGivenKind(\T_VARIABLE)) {
-            if (Preg::match('/@var\h+(.+\h+)?\$[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*/', $tokens[$index]->getContent()) === 1) {
-                $this->removeVarAnnotation($tokens, $index, [$tokens[$nextIndex]->getContent()]);
-            }
+        if (\defined('T_READONLY')) {
+            $tokenKinds[] = CT::T_TYPE_INTERSECTION;
+            $tokenKinds[] = \T_READONLY;
+        }
+
+        /** @var int $variableIndex */
+        $variableIndex = $tokens->getTokenNotOfKindsSibling($propertyStartIndex, 1, $tokenKinds);
+
+        if (!$tokens[$variableIndex]->isGivenKind(\T_VARIABLE)) {
+            $this->removeVarAnnotationNotMatchingPattern($tokens, $index, null);
 
             return;
         }
 
-        $this->removeVarAnnotationNotMatchingPattern($tokens, $index, null);
+        if (Preg::match('/@var\h+(.+\h+)?\$[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*/', $tokens[$index]->getContent()) === 1) {
+            $this->removeVarAnnotation($tokens, $index, [$tokens[$variableIndex]->getContent()]);
+        }
     }
 
     /**

tests/Fixer/PhpdocNoIncorrectVarAnnotationFixerTest.php

@@ -230,10 +230,60 @@ class Foo
 	 * @var int
 	 */
 	private $f;
+
+    /**
+     * @var int
+     */
+    private static $g;
 }
 ',
         ];
 
+        if (\PHP_VERSION_ID >= 70400) {
+            yield 'keep correct PHPDoc for class properties, PHP 7.4' => [
+                '<?php class Foo
+                {
+                    /** @var array */
+                    private array $array;
+
+                    /** @var bool */
+                    private bool $boolean;
+
+                    /** @var null|string */
+                    private ?string $nullableString;
+
+                    /** @var Bar */
+                    private Bar $bar;
+
+                    /** @var Vendor\\Baz */
+                    private Vendor\\Baz $baz;
+                }',
+            ];
+        }
+
+        if (\PHP_VERSION_ID >= 80000) {
+            yield 'keep correct PHPDoc for class properties, PHP 8.0' => [
+                '<?php class Foo
+                {
+                    /** @var int|string */
+                    private int|string $intOrString;
+                }',
+            ];
+        }
+
+        if (\PHP_VERSION_ID >= 80100) {
+            yield 'keep correct PHPDoc for class properties, PHP 8.1' => [
+                '<?php class Foo
+                {
+                    /** @var string */
+                    private readonly string $readonlyString;
+
+                    /** @var Bar&Vendor\\Baz */
+                    private Bar&Vendor\\Baz $barAndBaz;
+                }',
+            ];
+        }
+
         yield 'remove PHPDoc for class properties' => [
             '<?php
 class Foo

tests/Readme/ReadmeCommandTest.php

@@ -22,7 +22,7 @@
  *
  * @covers \PhpCsFixerCustomFixersDev\Readme\ReadmeCommand
  *
- * @requires PHP >=8.0
+ * @requires PHP >=8.1
  */
 final class ReadmeCommandTest extends TestCase
 {