🐛 Fix MultiLineArrayCommaSniff for empty array

Author: Vincent Langlet

Symfony3Custom/Sniffs/Arrays/MultiLineArrayCommaSniff.php

@@ -50,20 +50,35 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
         }
 
         if ($open['line'] <> $tokens[$closePtr]['line']) {
-            $lastComma = $phpcsFile->findPrevious(T_COMMA, $closePtr);
+            $arrayIsNotEmpty = $phpcsFile->findPrevious(
+                array(
+                    T_WHITESPACE,
+                    T_COMMENT,
+                    T_ARRAY,
+                    T_OPEN_PARENTHESIS,
+                    T_OPEN_SHORT_ARRAY,
+                ),
+                $closePtr - 1,
+                $stackPtr,
+                true
+            );
 
-            while ($lastComma < $closePtr -1) {
-                $lastComma++;
+            if ($arrayIsNotEmpty !== false) {
+                $lastComma = $phpcsFile->findPrevious(T_COMMA, $closePtr);
 
-                if ($tokens[$lastComma]['code'] !== T_WHITESPACE
-                    && $tokens[$lastComma]['code'] !== T_COMMENT
-                ) {
-                    $phpcsFile->addError(
-                        'Add a comma after each item in a multi-line array',
-                        $stackPtr,
-                        'Invalid'
-                    );
-                    break;
+                while ($lastComma < $closePtr - 1) {
+                    $lastComma++;
+
+                    if ($tokens[$lastComma]['code'] !== T_WHITESPACE
+                        && $tokens[$lastComma]['code'] !== T_COMMENT
+                    ) {
+                        $phpcsFile->addError(
+                            'Add a comma after each item in a multi-line array',
+                            $stackPtr,
+                            'Invalid'
+                        );
+                        break;
+                    }
                 }
             }
         }

Symfony3Custom/Tests/Arrays/MultiLineArrayCommaUnitTest.inc

@@ -13,6 +13,9 @@ $arr = array(
         'bar'
 );
 
+$arr = array(
+);
+
 // short array syntax
 $arr = ['foo', 'bar'];
 
@@ -26,6 +29,9 @@ $arr = [
         'bar'
 ];
 
+$arr = [
+];
+
 // classic array syntax with comments
 $arr = array('foo', 'bar' /* baz */);
 
@@ -49,6 +55,10 @@ $arr = array(
         'bar' /* baz */
 );
 
+$arr = array(
+    // foo => bar
+);
+
 // short array syntax with comments
 $arr = ['foo', 'bar' /* baz */];
 
@@ -71,3 +81,7 @@ $arr = [
         'foo'
         'bar' /* baz */
 ];
+
+$arr = [
+    // foo => bar
+];

Symfony3Custom/Tests/Arrays/MultiLineArrayCommaUnitTest.php

@@ -21,11 +21,11 @@ public function getErrorList()
     {
         return array(
             11  => 1,
-            24 => 1,
-            37 => 1,
-            47 => 1,
-            60 => 1,
+            27 => 1,
+            43 => 1,
+            53 => 1,
             70 => 1,
+            80 => 1,
         );
     }