Auto-fix Magento2.Whitespace.MultipleEmptyLines

Magento2/Sniffs/Whitespace/MultipleEmptyLinesSniff.php

@@ -1,8 +1,10 @@
 <?php
+
 /**
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento2\Sniffs\Whitespace;
 
 use PHP_CodeSniffer\Files\File;
@@ -53,12 +55,25 @@ public function process(File $phpcsFile, $stackPtr)
                 $next = $phpcsFile->findNext(T_WHITESPACE, $stackPtr, null, true);
                 $lines = $tokens[$next]['line'] - $tokens[$stackPtr]['line'];
                 if ($lines > 1) {
-                    $phpcsFile->addWarning(
+                    $fix = $phpcsFile->addFixableWarning(
                         $this->warningMessage,
                         $stackPtr,
                         $this->warningCode,
                         [$lines]
                     );
+
+                    if ($fix) {
+                        // $stackPtr + 1 to keep one empty line.
+                        // $next - 1 to keep the indentation
+                        for ($i = $stackPtr + 1; $i < $next - 1; $i++) {
+                            $phpcsFile->fixer->replaceToken($i, '');
+                        }
+
+                        // Handle case where the next line isn't indented
+                        if ($tokens[$next - 1]['content'] === PHP_EOL) {
+                            $phpcsFile->fixer->replaceToken($next - 1, '');
+                        }
+                    }
                 }
             }
         }

Magento2/Tests/Whitespace/MultipleEmptyLinesUnitTest.inc

@@ -11,6 +11,70 @@ class Foo
         $someValue = 1;
 
 
+        $someValue = 2;
+
+
+
+        $someValue = 3;
+
+
+
+        $someValue = 40;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+        $someValue = 'newlines and spaces and tabs';
+
+
+
+
+
+
+
+
+
+
+
+$someValue = 'no indentation';
+
+
+
         return $someValue;
     }
 }

Magento2/Tests/Whitespace/MultipleEmptyLinesUnitTest.inc.fixed

@@ -0,0 +1,24 @@
+<?php
+class Foo
+{
+    private $foo;
+    private $bar;
+
+    private $baz;
+    public function test()
+    {
+        $someValue = 1;
+
+        $someValue = 2;
+
+        $someValue = 3;
+
+        $someValue = 40;
+
+        $someValue = 'newlines and spaces and tabs';
+
+$someValue = 'no indentation';
+
+        return $someValue;
+    }
+}

Magento2/Tests/Whitespace/MultipleEmptyLinesUnitTest.php

@@ -1,8 +1,10 @@
 <?php
+
 /**
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento2\Tests\Whitespace;
 
 use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
@@ -25,6 +27,11 @@ public function getWarningList()
         return [
             6 => 1,
             12 => 1,
+            15 => 1,
+            19 => 1,
+            23 => 1,
+            63 => 1,
+            75 => 1,
         ];
     }
 }