Allo functions with nullable return type to return just null

Author: gmazzap

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## NOT RELEASED
+- Fix function with nullable type return and returning null (and nothing else) considered invalid.
+
 ## 0.13.3
 - Fixed false positive "missing argument type declaration" when param are passed by-reference.
 - Make `ReturnTypeDeclarationSniff` compatible with PHPCS 3.3

Inpsyde/Sniffs/CodeQuality/ReturnTypeDeclarationSniff.php

@@ -92,13 +92,13 @@ public function process(File $file, $position)
             return;
         }
 
-        $hasNullableReturn or $voidReturnCount += $nullReturnCount;
-
         $this->maybeErrors(
             $hasNonVoidReturnType,
             $hasVoidReturnType,
             $hasNoReturnType,
+            $hasNullableReturn,
             $nonVoidReturnCount,
+            $nullReturnCount,
             $voidReturnCount,
             $file,
             $position
@@ -108,22 +108,31 @@ public function process(File $file, $position)
     /**
      * @param bool $hasNonVoidReturnType
      * @param bool $hasVoidReturnType
+     * @param bool $hasNullableReturn
      * @param bool $hasNoReturnType
      * @param int $nonVoidReturnCount
      * @param int $voidReturnCount
+     * @param int $nullReturnCount
      * @param File $file
      * @param int $position
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException
      */
     private function maybeErrors(
         bool $hasNonVoidReturnType,
         bool $hasVoidReturnType,
         bool $hasNoReturnType,
+        bool $hasNullableReturn,
         int $nonVoidReturnCount,
+        int $nullReturnCount,
         int $voidReturnCount,
         File $file,
         int $position
     ) {
 
+        $hasNullableReturn
+            ? $nonVoidReturnCount += $nullReturnCount
+            : $voidReturnCount += $nullReturnCount;
+
         if ($hasNonVoidReturnType && ($nonVoidReturnCount === 0 || $voidReturnCount > 0)) {
             $msg = 'Return type with';
             $file->addError(

tests/fixtures/return-type-declaration.php

@@ -1,6 +1,17 @@
 <?php
 // @phpcsSniff CodeQuality.ReturnTypeDeclaration
 
+public function hooks(): ?array
+{
+    return null;
+}
+
+// @phpcsWarningCodeOnNextLine NoReturnType
+function a()
+{
+    return 'x';
+}
+
 // @phpcsErrorCodeOnNextLine IncorrectVoidReturn
 function iReturnWrongNull(): \ArrayAccess
 {
@@ -17,12 +28,6 @@ function c(): void
     return true;
 }
 
-// @phpcsWarningCodeOnNextLine NoReturnType
-function a()
-{
-    return 'x';
-}
-
 function aa($foo)
 {
     return;