Merge pull request #98 from VincentLanglet/fixRuleset

Fix ruleset

Author: VincentLanglet

SymfonyCustom/Sniffs/NamingConventions/ValidTypeHintSniff.php

@@ -14,11 +14,11 @@
  */
 class ValidTypeHintSniff implements Sniff
 {
-    private const TEXT = '\\\\a-z0-9';
-    private const OPENER = '\<\[\{\(';
-    private const CLOSER = '\>\]\}\)';
-    private const MIDDLE = '\,\:';
-    private const SEPARATOR = '\&\|';
+    private const TEXT = '[\\\\a-z0-9]';
+    private const OPENER = '\<|\[|\{|\(';
+    private const MIDDLE = '\,|\:|\=\>';
+    private const CLOSER = '\>|\]|\}|\)';
+    private const SEPARATOR = '\&|\|';
 
     /**
      * @return array
@@ -39,10 +39,12 @@ public function process(File $phpcsFile, $stackPtr): void
         if (in_array($tokens[$stackPtr]['content'], SniffHelper::TAGS_WITH_TYPE)) {
             preg_match(
                 '`^((?:'
-                    .'['.self::OPENER.self::MIDDLE.self::SEPARATOR.']\s*'
-                    .'|(?:['.self::TEXT.self::CLOSER.']\s+)'
-                        .'(?=[\|'.self::OPENER.self::MIDDLE.self::CLOSER.self::SEPARATOR.'])'
-                    .'|['.self::TEXT.self::CLOSER.']'
+                    .'(?:'.self::OPENER.'|'.self::MIDDLE.'|'.self::SEPARATOR.')\s+'
+                        .'(?='.self::TEXT.'|'.self::OPENER.'|'.self::MIDDLE.'|'.self::CLOSER.'|'.self::SEPARATOR.')'
+                    .'|'.self::OPENER.'|'.self::MIDDLE.'|'.self::SEPARATOR
+                    .'|(?:'.self::TEXT.'|'.self::CLOSER.')\s+'
+                        .'(?='.self::OPENER.'|'.self::MIDDLE.'|'.self::CLOSER.'|'.self::SEPARATOR.')'
+                    .'|'.self::TEXT.'|'.self::CLOSER.''
                 .')+)(.*)?`i',
                 $tokens[($stackPtr + 2)]['content'],
                 $match
@@ -52,7 +54,6 @@ public function process(File $phpcsFile, $stackPtr): void
                 return;
             }
 
-            // Check type (can be multiple, separated by '|').
             $type = $match[1];
             $suggestedType = $this->getValidTypeName($type);
             if ($type !== $suggestedType) {
@@ -84,7 +85,7 @@ private function getValidTypeName(string $typeName): string
     {
         $typeNameWithoutSpace = str_replace(' ', '', $typeName);
         $parts = preg_split(
-            '/([\|'.self::OPENER.self::MIDDLE.self::CLOSER.self::SEPARATOR.'])/',
+            '/('.self::OPENER.'|'.self::MIDDLE.'|'.self::CLOSER.'|'.self::SEPARATOR.')/',
             $typeNameWithoutSpace,
             -1,
             PREG_SPLIT_DELIM_CAPTURE
@@ -93,9 +94,15 @@ private function getValidTypeName(string $typeName): string
 
         $validType = '';
         for ($i = 0; $i < $partsNumber; $i += 2) {
-            $validType .= $this->suggestType($parts[$i]).$parts[$i + 1];
+            $validType .= $this->suggestType($parts[$i]);
 
-            if (preg_match('/['.self::MIDDLE.']/', $parts[$i + 1])) {
+            if ('=>' === $parts[$i + 1]) {
+                $validType .= ' ';
+            }
+
+            $validType .= $parts[$i + 1];
+
+            if (preg_match('/'.self::MIDDLE.'/', $parts[$i + 1])) {
                 $validType .= ' ';
             }
         }

SymfonyCustom/Tests/NamingConventions/ValidTypeHintUnitTest.inc

@@ -46,6 +46,7 @@ echo ( float ) $a;
 /** @method array<integer,boolean>|integer[]|array<integer> truc */
 /** @method array<integer, boolean>| integer[] |string|(integer|boolean)[] truc */
 /** @method array{scheme:string,host:string} truc */
+/** @method array(int=>string) truc */
 
 /**
  * Avoid weird bug
@@ -56,3 +57,5 @@ echo ( float ) $a;
  * @method array<integer,
  * @method array|
  */
+/** @method array<integer, */
+/** @method array<integer, $truc */

SymfonyCustom/Tests/NamingConventions/ValidTypeHintUnitTest.inc.fixed

@@ -46,6 +46,7 @@ echo ( float ) $a;
 /** @method array<int, bool>|int[]|array<int> truc */
 /** @method array<int, bool>|int[]|string|(int|bool)[] truc */
 /** @method array{scheme: string, host: string} truc */
+/** @method array(int => string) truc */
 
 /**
  * Avoid weird bug
@@ -56,3 +57,5 @@ echo ( float ) $a;
  * @method array<int,
  * @method array|
  */
+/** @method array<int, */
+/** @method array<int, $truc */

SymfonyCustom/Tests/NamingConventions/ValidTypeHintUnitTest.php

@@ -38,8 +38,11 @@ protected function getErrorList(): array
             46 => 1,
             47 => 1,
             48 => 1,
-            54 => 1,
-            56 => 1,
+            49 => 1,
+            55 => 1,
+            57 => 1,
+            60 => 1,
+            61 => 1,
         ];
     }
 

SymfonyCustom/ruleset.xml

@@ -13,12 +13,20 @@
     <!-- Include the PSR-12 (so PSR-1) standard without the file length limit -->
     <rule ref="PSR12">
         <exclude name="Generic.Files.LineLength"/>
-
-        <!-- TODO -->
         <exclude name="PSR12.ControlStructures.ControlStructureSpacing"/>
         <exclude name="PSR12.Operators.OperatorSpacing"/>
-        <exclude name="Squiz.ControlStructures.ControlSignature"/>
     </rule>
+    <!-- Instead of PSR12.ControlStructures.ControlStructureSpacing -->
+    <rule ref="PSR2.ControlStructures.ControlStructureSpacing"/>
+    <!-- Instead of PSR12.Operators.OperatorSpacing-->
+    <rule ref="Squiz.WhiteSpace.OperatorSpacing">
+        <properties>
+            <property name="ignoreNewlines" value="true"/>
+        </properties>
+    </rule>
+    <rule ref="Squiz.WhiteSpace.LogicalOperatorSpacing"/>
+
+    <!-- Change warning to error -->
     <rule ref="PSR2.ControlStructures.ElseIfDeclaration.NotAllowed">
         <type>error</type>
     </rule>
@@ -65,17 +73,11 @@
             <property name="spacingAfterLast" value="0"/>
         </properties>
     </rule>
-    <rule ref="Squiz.WhiteSpace.LogicalOperatorSpacing"/>
     <rule ref="Squiz.WhiteSpace.MemberVarSpacing">
         <properties>
             <property name="spacingBeforeFirst" value="0"/>
         </properties>
     </rule>
-    <rule ref="Squiz.WhiteSpace.OperatorSpacing">
-        <properties>
-            <property name="ignoreNewlines" value="true"/>
-        </properties>
-    </rule>
     <rule ref="Squiz.WhiteSpace.ObjectOperatorSpacing">
         <properties>
             <property name="ignoreNewlines" value="true"/>