✨ Process whitespace for function with no docblock

Author: Vincent Langlet

Symfony3Custom/Sniffs/Commenting/FunctionCommentSniff.php

@@ -99,11 +99,15 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
             // These checks need function comment
             $this->processParams($phpcsFile, $stackPtr, $commentStart);
             $this->processThrows($phpcsFile, $stackPtr, $commentStart);
-        } elseif (count($realParams) > 0) {
-            foreach ($realParams as $neededParam) {
-                $error = 'Doc comment for parameter "%s" missing';
-                $data  = array($neededParam['name']);
-                $phpcsFile->addError($error, $stackPtr, 'MissingParamTag', $data);
+        } else {
+            $this->processWhitespace($phpcsFile, $stackPtr, $stackPtr);
+
+            if (count($realParams) > 0) {
+                foreach ($realParams as $neededParam) {
+                    $error = 'Doc comment for parameter "%s" missing';
+                    $data  = array($neededParam['name']);
+                    $phpcsFile->addError($error, $stackPtr, 'MissingParamTag', $data);
+                }
             }
         }
     }
@@ -193,9 +197,17 @@ protected function processWhitespace(
                 $found = 0;
             }
 
-            $error = 'Expected 1 blank line before docblock; %s found';
+            if ($stackPtr === $commentStart) {
+                // There is no docblock
+                $error = 'Expected 1 blank line before function; %s found';
+                $rule = 'SpacingBeforeFunction';
+            } else {
+                $error = 'Expected 1 blank line before docblock; %s found';
+                $rule = 'SpacingBeforeDocblock';
+            }
+
             $data = array($found);
-            $fix = $phpcsFile->addFixableError($error, $commentStart, 'SpacingBeforeDocblock', $data);
+            $fix = $phpcsFile->addFixableError($error, $commentStart, $rule, $data);
 
             if ($fix === true) {
                 if ($found > 1) {

Symfony3Custom/Tests/Commenting/FunctionCommentUnitTest.inc

@@ -86,7 +86,11 @@ function testToNotIgnore2($test)
     return 42;
 }
 
-function testToIgnore()
+function testToIgnore1()
 {
-    $test = 2;
+    $test = 42;
+}
+function testToIgnore2()
+{
+    $test = 42;
 }

Symfony3Custom/Tests/Commenting/FunctionCommentUnitTest.inc.fixed

@@ -86,7 +86,12 @@ function testToNotIgnore2($test)
     return 42;
 }
 
-function testToIgnore()
+function testToIgnore1()
 {
-    $test = 2;
+    $test = 42;
+}
+
+function testToIgnore2()
+{
+    $test = 42;
 }

Symfony3Custom/Tests/Commenting/FunctionCommentUnitTest.php

@@ -27,6 +27,7 @@ public function getErrorList()
             57 => 1,
             76 => 2,
             83 => 1,
+            93 => 1,
         );
     }