✨ More case for valid scalar

Author: VincentLanglet

SymfonyCustom/Sniffs/NamingConventions/ValidScalarTypeNameSniff.php

@@ -7,14 +7,18 @@
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Util\Common;
-use PHP_CodeSniffer\Util\Tokens;
 use SymfonyCustom\Helpers\SniffHelper;
 
 /**
  * Throws errors if scalar type name are not valid.
  */
 class ValidScalarTypeNameSniff implements Sniff
 {
+    private const TYPING = '\\\\a-z0-9';
+    private const OPENER = '\<\[\{\(';
+    private const CLOSER = '\>\]\}\)';
+    private const MIDDLE = '\,\:\&\|';
+
     /**
      * @return array
      */
@@ -33,7 +37,11 @@ public function process(File $phpcsFile, $stackPtr): void
 
         if (in_array($tokens[$stackPtr]['content'], SniffHelper::TAGS_WITH_TYPE)) {
             preg_match(
-                '`^((?:\|?(?:array\([^\)]*\)|[\\\\a-z0-9\[\<\,\>\]]+))*)( .*)?`i',
+                '`^((?:'
+                    .'['.self::OPENER.self::MIDDLE.']\s*'
+                    .'|(?:['.self::TYPING.self::CLOSER.']\s+)(?=[\|'.self::OPENER.self::MIDDLE.self::CLOSER.'])'
+                    .'|['.self::TYPING.self::CLOSER.']'
+                .')+)(.*)?`i',
                 $tokens[($stackPtr + 2)]['content'],
                 $match
             );
@@ -44,17 +52,7 @@ public function process(File $phpcsFile, $stackPtr): void
 
             // Check type (can be multiple, separated by '|').
             $type = $match[1];
-            $typeNames = explode('|', $type);
-            $suggestedNames = [];
-            foreach ($typeNames as $i => $typeName) {
-                $suggestedName = $this->getValidTypeName($typeName);
-
-                if (in_array($suggestedName, $suggestedNames, true) === false) {
-                    $suggestedNames[] = $suggestedName;
-                }
-            }
-
-            $suggestedType = implode('|', $suggestedNames);
+            $suggestedType = $this->getValidTypeName($type);
             if ($type !== $suggestedType) {
                 $fix = $phpcsFile->addFixableError(
                     'For type-hinting in PHPDocs, use %s instead of %s',
@@ -82,7 +80,13 @@ public function process(File $phpcsFile, $stackPtr): void
      */
     private function getValidTypeName(string $typeName): string
     {
-        $parts = preg_split('/([\<\,\>])/', $typeName, -1, PREG_SPLIT_DELIM_CAPTURE);
+        $typeNameWithoutSpace = str_replace(' ', '', $typeName);
+        $parts = preg_split(
+            '/([\|'.self::OPENER.self::MIDDLE.self::CLOSER.'])/',
+            $typeNameWithoutSpace,
+            -1,
+            PREG_SPLIT_DELIM_CAPTURE
+        );
         $partsNumber = count($parts) - 1;
 
         $validType = '';
@@ -104,10 +108,6 @@ private function getValidTypeName(string $typeName): string
      */
     private function suggestType(string $typeName): string
     {
-        if ('[]' === substr($typeName, -2)) {
-            return $this->suggestType(substr($typeName, 0, -2)).'[]';
-        }
-
         $lowerType = strtolower($typeName);
         switch ($lowerType) {
             case 'bool':

SymfonyCustom/Tests/NamingConventions/ValidScalarTypeNameUnitTest.inc

@@ -43,4 +43,5 @@ echo ( float ) $a;
 /** @var real $c */
 
 /** @method integer|string  */
-/** @method array<integer,boolean>|integer[]|string  */
+/** @method array<integer,boolean>|integer[]|array<integer> truc */
+/** @method array<integer, boolean>| integer[] |string|(integer|boolean)[] truc */

SymfonyCustom/Tests/NamingConventions/ValidScalarTypeNameUnitTest.inc.fixed

@@ -43,4 +43,5 @@ echo ( float ) $a;
 /** @var float $c */
 
 /** @method int|string  */
-/** @method array<int,bool>|int[]|string  */
+/** @method array<int,bool>|int[]|array<int> truc */
+/** @method array<int,bool>|int[]|string|(int|bool)[] truc */

SymfonyCustom/Tests/NamingConventions/ValidScalarTypeNameUnitTest.php

@@ -36,6 +36,7 @@ protected function getErrorList(): array
             43 => 1,
             45 => 1,
             46 => 1,
+            47 => 1,
         ];
     }