PhpdocNoIncorrectVarAnnotationFixer - support promoted properties (#922)

kubawerlos · Nov 19, 2023 · bbfb4ff · bbfb4ff
1 parent d753404
commit bbfb4ff
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # CHANGELOG for PHP CS Fixer: custom fixers
 
+## v3.17.0
+- PhpdocNoIncorrectVarAnnotationFixer - support promoted properties
+
 ## v3.16.0
 - Deprecate DataProviderReturnTypeFixer - use "php_unit_data_provider_return_type"
 - Update minimum PHP CS Fixer version to 3.22.0

diff --git a/README.md b/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-3454-brightgreen.svg)
+![Tests](https://img.shields.io/badge/tests-3455-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)](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/actions)

diff --git a/src/Fixer/PhpdocNoIncorrectVarAnnotationFixer.php b/src/Fixer/PhpdocNoIncorrectVarAnnotationFixer.php
@@ -70,7 +70,7 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
                 continue;
             }
 
-            if ($tokens[$nextIndex]->isGivenKind([\T_PRIVATE, \T_PROTECTED, \T_PUBLIC, \T_VAR, \T_STATIC])) {
+            if ($tokens[$nextIndex]->isGivenKind([\T_PRIVATE, \T_PROTECTED, \T_PUBLIC, \T_VAR, \T_STATIC, CT::T_CONSTRUCTOR_PROPERTY_PROMOTION_PUBLIC, CT::T_CONSTRUCTOR_PROPERTY_PROMOTION_PROTECTED, CT::T_CONSTRUCTOR_PROPERTY_PROMOTION_PRIVATE])) {
                 $this->removeForClassElement($tokens, $index, $nextIndex);
                 continue;
             }

diff --git a/tests/Fixer/PhpdocNoIncorrectVarAnnotationFixerTest.php b/tests/Fixer/PhpdocNoIncorrectVarAnnotationFixerTest.php
@@ -267,6 +267,22 @@ class Foo
                     private int|string $intOrString;
                 }',
             ];
+
+            yield 'keep correct PHPDoc for promoted properties, PHP 8.0' => [
+                '<?php class Foo
+                {
+                    public function __construct(
+                        /** @var array<Foo> */
+                        public array $a,
+                        /** @var array<Foo> */
+                        public array $b,
+                        /** @var array<Foo> */
+                        protected array $c,
+                        /** @var array<Foo> */
+                        private array $d,
+                    ) {}
+                }',
+            ];
         }
 
         if (\PHP_VERSION_ID >= 80100) {