✨ Add check for multiple blank line

Author: Vincent Langlet

Symfony3Custom/Sniffs/WhiteSpace/EmptyLinesSniff.php

@@ -0,0 +1,55 @@
+<?php
+
+/**
+ * Checks that there are not 2 empty lines following each other.
+ */
+class Symfony3Custom_Sniffs_WhiteSpace_EmptyLinesSniff implements PHP_CodeSniffer_Sniff
+{
+    /**
+     * A list of tokenizers this sniff supports.
+     *
+     * @var array
+     */
+    public $supportedTokenizers = array(
+        'PHP',
+        'JS',
+        'CSS',
+    );
+
+    /**
+     * Returns an array of tokens this test wants to listen for.
+     *
+     * @return array
+     */
+    public function register()
+    {
+        return array(T_WHITESPACE);
+    }
+
+    /**
+     * Processes this test, when one of its tokens is encountered.
+     *
+     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
+     * @param int                  $stackPtr  The position of the current token
+     *                                        in the stack passed in $tokens.
+     *
+     * @return void
+     */
+    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    {
+        $tokens = $phpcsFile->getTokens();
+        if ($tokens[$stackPtr]['content'] === $phpcsFile->eolChar
+            && isset($tokens[$stackPtr + 1]) === true
+            && $tokens[$stackPtr + 1]['content'] === $phpcsFile->eolChar
+            && isset($tokens[$stackPtr + 2]) === true
+            && $tokens[$stackPtr + 2]['content'] === $phpcsFile->eolChar
+        ) {
+            $error = 'More than 1 empty lines are not allowed';
+            $fix = $phpcsFile->addFixableError($error, $stackPtr + 2, 'EmptyLines');
+
+            if ($fix === true) {
+                $phpcsFile->fixer->replaceToken($stackPtr + 2, '');
+            }
+        }
+    }
+}

Symfony3Custom/Tests/WhiteSpace/EmptyLinesUnitTest.inc

@@ -0,0 +1,7 @@
+<?php
+
+$a = 2;
+
+
+
+$b = 3;

Symfony3Custom/Tests/WhiteSpace/EmptyLinesUnitTest.inc.fixed

@@ -0,0 +1,5 @@
+<?php
+
+$a = 2;
+
+$b = 3;

Symfony3Custom/Tests/WhiteSpace/EmptyLinesUnitTest.php

@@ -0,0 +1,39 @@
+<?php
+
+/**
+ * Unit test class for the EmptyLines sniff.
+ *
+ * A sniff unit test checks a .inc file for expected violations of a single
+ * coding standard. Expected errors and warnings are stored in this class.
+ */
+class Symfony3Custom_Tests_WhiteSpace_EmptyLinesUnitTest extends AbstractSniffUnitTest
+{
+    /**
+     * Returns the lines where errors should occur.
+     *
+     * The key of the array should represent the line number and the value
+     * should represent the number of errors that should occur on that line.
+     *
+     * @return array<int, int>
+     */
+    public function getErrorList()
+    {
+        return array(
+            5 => 1,
+            6 => 1,
+        );
+    }
+
+    /**
+     * Returns the lines where warnings should occur.
+     *
+     * The key of the array should represent the line number and the value
+     * should represent the number of warnings that should occur on that line.
+     *
+     * @return array(int => int)
+     */
+    protected function getWarningList()
+    {
+        return array();
+    }
+}