MissingReturnRule - special message for @return never case

ondrejmirtes · ondrejmirtes · commit cc91080c2fbd · 2020-11-04T18:09:32.000+01:00
diff --git a/src/Rules/Missing/MissingReturnRule.php b/src/Rules/Missing/MissingReturnRule.php
@@ -12,6 +12,7 @@
 use PHPStan\Type\Generic\TemplateMixedType;
 use PHPStan\Type\GenericTypeVariableResolver;
 use PHPStan\Type\MixedType;
+use PHPStan\Type\NeverType;
 use PHPStan\Type\TypeWithClassName;
 use PHPStan\Type\VerbosityLevel;
 use PHPStan\Type\VoidType;
@@ -96,6 +97,12 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
+		if ($returnType instanceof NeverType && $returnType->isExplicit()) {
+			return [
+				RuleErrorBuilder::message(sprintf('%s should always throw an exception or terminate script execution but doesn\'t do that.', $description))->line($node->getNode()->getStartLine())->build(),
+			];
+		}
+
 		if (
 			$returnType instanceof MixedType
 			&& !$returnType instanceof TemplateMixedType
diff --git a/tests/PHPStan/Rules/Missing/MissingReturnRuleTest.php b/tests/PHPStan/Rules/Missing/MissingReturnRuleTest.php
@@ -96,6 +96,10 @@ public function testRule(): void
 				'Method MissingReturn\MissingReturnGenerators::bodySpecifiedTReturn() should return string but return statement is missing.',
 				370,
 			],
+			[
+				'Method MissingReturn\NeverReturn::doBaz() should always throw an exception or terminate script execution but doesn\'t do that.',
+				473,
+			],
 		]);
 	}
 
diff --git a/tests/PHPStan/Rules/Missing/data/missing-return.php b/tests/PHPStan/Rules/Missing/data/missing-return.php
@@ -447,3 +447,32 @@ public function doFoo()
 	}
 
 }
+
+class NeverReturn
+{
+
+	/**
+	 * @return never
+	 */
+	public function doFoo()
+	{
+		throw new \Exception();
+	}
+
+	/**
+	 * @return never
+	 */
+	public function doBar()
+	{
+		die;
+	}
+
+	/**
+	 * @return never
+	 */
+	public function doBaz()
+	{
+
+	}
+
+}
