Considr comments when checking func return

Author: gmazzap

Inpsyde/PhpcsHelpers.php

@@ -465,8 +465,11 @@ public static function countReturns(File $file, int $functionPosition): array
             }
 
             if ($tokens[$i]['code'] === T_RETURN && !$scopeClosers->count()) {
-                PhpcsHelpers::isVoidReturn($file, $i) ? $voidReturnCount++ : $nonVoidReturnCount++;
-                PhpcsHelpers::isNullReturn($file, $i) and $nullReturnCount++;
+                $void = PhpcsHelpers::isVoidReturn($file, $i);
+                $null = PhpcsHelpers::isNullReturn($file, $i);
+                $void and $voidReturnCount++;
+                $null and $nullReturnCount++;
+                (!$void && !$null) and $nonVoidReturnCount++;
             }
         }
 
@@ -476,9 +479,10 @@ public static function countReturns(File $file, int $functionPosition): array
     /**
      * @param File $file
      * @param int $returnPosition
+     * @param bool $includeNull
      * @return bool
      */
-    public static function isVoidReturn(File $file, int $returnPosition): bool
+    public static function isVoidReturn(File $file, int $returnPosition, $includeNull = false): bool
     {
         $tokens = $file->getTokens();
 
@@ -487,21 +491,12 @@ public static function isVoidReturn(File $file, int $returnPosition): bool
         }
 
         $returnPosition++;
-        $nextToReturn = $file->findNext([T_WHITESPACE], $returnPosition, null, true, null, true);
-        $nextToReturnType = $tokens[$nextToReturn]['code'] ?? '';
-
-        if ($nextToReturnType === T_SEMICOLON) {
-            return true;
-        }
-
-        if ($nextToReturnType !== T_NULL) {
-            return false;
-        }
+        $exclude = Tokens::$emptyTokens;
+        $includeNull and $exclude[] = T_NULL;
 
-        $returnPosition = $nextToReturn + 1;
-        $followedBySemicolon = ($tokens[$returnPosition]['code'] ?? '') === T_SEMICOLON;
+        $nextToReturn = $file->findNext($exclude, $returnPosition, null, true, null, true);
 
-        return $followedBySemicolon;
+        return ($tokens[$nextToReturn]['code'] ?? '') === T_SEMICOLON;
     }
 
     /**
@@ -511,16 +506,9 @@ public static function isVoidReturn(File $file, int $returnPosition): bool
      */
     public static function isNullReturn(File $file, int $returnPosition): bool
     {
-        $tokens = $file->getTokens();
-
-        if (($tokens[$returnPosition]['code'] ?? '') !== T_RETURN) {
-            return false;
-        }
-
-        $returnPosition++;
-        $nextToReturn = $file->findNext([T_WHITESPACE, T_NULL], $returnPosition, null, true, null, true);
-
-        return ($tokens[$nextToReturn]['code'] ?? '') === T_SEMICOLON;
+        return
+            !self::isVoidReturn($file, $returnPosition, false)
+            && self::isVoidReturn($file, $returnPosition, true);
     }
 
     /**

Inpsyde/Sniffs/CodeQuality/ReturnTypeDeclarationSniff.php

@@ -79,9 +79,7 @@ public function process(File $file, $position)
             return;
         }
 
-        if ($hasNullableReturn) {
-            $voidReturnCount -= $nullReturnCount;
-        }
+        $hasNullableReturn or $voidReturnCount += $nullReturnCount;
 
         $this->maybeErrors(
             $hasNonVoidReturnType,

tests/fixtures/return-type-declaration.php

@@ -1,6 +1,16 @@
 <?php
 // @phpcsSniff CodeQuality.ReturnTypeDeclaration
 
+// @phpcsErrorCodeOnNextLine IncorrectVoidReturn
+function iReturnWrongNull(): \ArrayAccess
+{
+    if (rand(1, 4) > 2) {
+        return null;
+    }
+
+    return new \ArrayObject();
+}
+
 // @phpcsErrorCodeOnNextLine IncorrectVoidReturnType
 function c(): void
 {
@@ -67,6 +77,10 @@ function hh(): void {
     return null;
 }
 
+function hhComment(): void {
+    return /* I return void */ ;
+}
+
 function gen(string $content): \Generator
 {
     $line = strtok($content, "\n");