Merge pull request #10254 from tuqqu/never-function-return-error-message

Fix error message for implicitly returning functions with `never` return type
vimeo · Oct 9, 2023 · 3f7306d · 3f7306d
2 parents cad10a1 + 2bc3309
commit 3f7306d
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 1 deletion.
diff --git a/src/Psalm/Internal/Analyzer/FunctionLike/ReturnTypeAnalyzer.php b/src/Psalm/Internal/Analyzer/FunctionLike/ReturnTypeAnalyzer.php
@@ -197,6 +197,7 @@ public static function verifyReturnType(
                 )
             )
             && !$return_type->isVoid()
+            && !$return_type->isNever()
             && !$inferred_yield_types
             && (!$function_like_storage || !$function_like_storage->has_yield)
             && $function_returns_implicitly
@@ -222,7 +223,7 @@ public static function verifyReturnType(
         ) {
             if (IssueBuffer::accepts(
                 new InvalidReturnType(
-                    $cased_method_id . ' is not expected to return any values but it does, '
+                    $cased_method_id . ' is not expected to return, but it does, '
                         . 'either implicitly or explicitly',
                     $return_type_location,
                 ),

diff --git a/tests/ReturnTypeTest.php b/tests/ReturnTypeTest.php
@@ -1279,6 +1279,26 @@ function aggregate($type) {
                         return $t;
                     }',
             ],
+            'neverReturnType' => [
+                'code' => '<?php
+                    function exitProgram(bool $die): never
+                    {
+                        if ($die) {
+                            die;
+                        }
+
+                        exit;
+                    }
+
+                    function throwError(): never
+                    {
+                        throw new Exception();
+                    }
+                ',
+                'assertions' => [],
+                'ignored_issues' => [],
+                'php_version' => '8.1',
+            ],
         ];
     }
 
@@ -1807,6 +1827,36 @@ public function process(): mixed
                 'ignored_issues' => [],
                 'php_version' => '8.0',
             ],
+            'implicitReturnFromFunctionWithNeverReturnType' => [
+                'code' => <<<'PHP'
+                    <?php
+                    function foo(): never
+                    {
+                        if (rand(0, 1)) {
+                            exit();
+                        }
+                    }
+                    PHP,
+                'error_message' => 'InvalidReturnType',
+                'ignored_issues' => [],
+                'php_version' => '8.1',
+            ],
+            'implicitReturnFromFunctionWithNeverReturnType2' => [
+                'code' => <<<'PHP'
+                    <?php
+                    function foo(bool $x): never
+                    {
+                        while (true) {
+                            if ($x) {
+                                break;
+                            }
+                        }
+                    }
+                    PHP,
+                'error_message' => 'InvalidReturnType',
+                'ignored_issues' => [],
+                'php_version' => '8.1',
+            ],
         ];
     }
 }