Squiz SuperfluousWhitespaceSniff now has an option to ignore blank lines. PSR2 makes use of this new feature.

Author: gsherwood

CodeSniffer/Standards/PSR2/ruleset.xml

@@ -35,6 +35,11 @@
  </rule>
 
  <!-- There MUST NOT be trailing whitespace at the end of non-blank lines. -->
+ <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace">
+  <properties>
+   <property name="ignoreBlankLines" value="true"/>
+   </properties>
+ </rule>
  <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace.StartFile">
   <severity>0</severity>
  </rule>

CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/SuperfluousWhitespaceSniff.php

@@ -43,6 +43,16 @@ class Squiz_Sniffs_WhiteSpace_SuperfluousWhitespaceSniff implements PHP_CodeSnif
                                    'CSS',
                                   );
 
+    /**
+     * If TRUE, whitespace rules are not checked for blank lines.
+     *
+     * Blank lines are those that contain only whitespace.
+     *
+     * @var boolean
+     */
+    public $ignoreBlankLines = false;
+
+
     /**
      * Returns an array of tokens this test wants to listen for.
      *
@@ -164,10 +174,18 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
                 Check for end of line whitespace.
             */
 
+            // Ignore whitespace that is not at the end of a line.
             if (strpos($tokens[$stackPtr]['content'], $phpcsFile->eolChar) === false) {
                 return;
             }
 
+            // Ignore blank lines if required.
+            if ($this->ignoreBlankLines === true
+                && $tokens[($stackPtr - 1)]['line'] !== $tokens[$stackPtr]['line']
+            ) {
+                return;
+            }
+
             $tokenContent = rtrim($tokens[$stackPtr]['content'], $phpcsFile->eolChar);
             if (empty($tokenContent) === false) {
                 if (preg_match('|^.*\s+$|', $tokenContent) !== 0) {

CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.css

@@ -8,7 +8,18 @@
 .HelpWidgetType-new-bug-title	{   
     float: left;   
 }
+    
 .HelpWidgetType-new-bug-title{
     float: left;
 }
 
+/* @codingStandardsChangeSetting Squiz.WhiteSpace.SuperfluousWhitespace ignoreBlankLines true */
+.HelpWidgetType-new-bug-title{
+    float: left;
+}
+    
+.HelpWidgetType-new-bug-title{
+    float: left;
+}
+/* @codingStandardsChangeSetting Squiz.WhiteSpace.SuperfluousWhitespace ignoreBlankLines false */
+

CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.inc

@@ -33,5 +33,17 @@ function myFunction2()
 
 }
 
+// @codingStandardsChangeSetting Squiz.WhiteSpace.SuperfluousWhitespace ignoreBlankLines true
+
+function myFunction2()
+{
+    echo 'code here';
+    
+    echo 'code here';
+    
+}
+
+// @codingStandardsChangeSetting Squiz.WhiteSpace.SuperfluousWhitespace ignoreBlankLines false
+
 ?>
 

CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.js

@@ -32,4 +32,16 @@ function myFunction2()
 
 }
 
+// @codingStandardsChangeSetting Squiz.WhiteSpace.SuperfluousWhitespace ignoreBlankLines true
+
+function myFunction2()
+{
+    alert('code here');
+    
+    alert('code here');
+    
+}
+
+// @codingStandardsChangeSetting Squiz.WhiteSpace.SuperfluousWhitespace ignoreBlankLines false
+
 

CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.php

@@ -55,7 +55,7 @@ public function getErrorList($testFile='SuperfluousWhitespaceUnitTest.inc')
                     16 => 1,
                     23 => 1,
                     30 => 1,
-                    36 => 1,
+                    48 => 1,
                    );
             break;
         case 'SuperfluousWhitespaceUnitTest.js':
@@ -68,15 +68,16 @@ public function getErrorList($testFile='SuperfluousWhitespaceUnitTest.inc')
                     15 => 1,
                     22 => 1,
                     29 => 1,
-                    35 => 1,
+                    47 => 1,
                    );
             break;
         case 'SuperfluousWhitespaceUnitTest.css':
             return array(
                     1  => 1,
                     8  => 1,
                     9  => 1,
-                    14 => 1,
+                    11 => 1,
+                    25 => 1,
                    );
             break;
         default:

package.xml

@@ -34,6 +34,10 @@ http://pear.php.net/dtd/package-2.0.xsd">
     -- Thanks to Andy Grunwald for the patch
   - Squiz FileCommentSniff now uses tags names inside the error codes for many messages
     -- This allows you to exclude specific missing, out of order etc., tags
+  - Squiz SuperfluousWhitespaceSniff now has an option to ignore blank lines
+    -- This will stop errors being reported for lines that contain only whitespace
+    -- Set the ignoreBlankLines property to true in your ruleset.xml file to enable this
+  - PSR2 no longer reports errors for whitespace at the end of blank lines
   - Fixed gitblame report not working on Windows
     -- Thanks to Rogerio Prado de Jesus
   - Fixed an incorrect error in Squiz OperatorSpacingSniff for default values inside a closure definition