PHP 8.1: Support of "never" type

Author: kukulich

src/Standards/Generic/Sniffs/PHP/LowerCaseTypeSniff.php

@@ -38,6 +38,7 @@ class LowerCaseTypeSniff implements Sniff
         'static'   => true,
         'false'    => true,
         'null'     => true,
+        'never'    => true,
     ];
 
 

src/Standards/Generic/Tests/PHP/LowerCaseTypeUnitTest.inc

@@ -81,3 +81,7 @@ class ConstructorPropertyPromotionWithTypes {
 class ConstructorPropertyPromotionAndNormalParams {
     public function __construct(public Int $promotedProp, ?Int $normalArg) {}
 }
+
+function (): NeVeR {
+    exit;
+};

src/Standards/Generic/Tests/PHP/LowerCaseTypeUnitTest.inc.fixed

@@ -81,3 +81,7 @@ class ConstructorPropertyPromotionWithTypes {
 class ConstructorPropertyPromotionAndNormalParams {
     public function __construct(public int $promotedProp, ?int $normalArg) {}
 }
+
+function (): never {
+    exit;
+};

src/Standards/Generic/Tests/PHP/LowerCaseTypeUnitTest.php

@@ -65,6 +65,7 @@ public function getErrorList()
             74 => 3,
             78 => 3,
             82 => 2,
+            85 => 1,
         ];
 
     }//end getErrorList()

tests/Core/File/GetMethodPropertiesTest.inc

@@ -33,7 +33,7 @@ class MyClass {
 
     /* testMessyNullableReturnMethod */
     public function myFunction() /* comment
-        */ :  
+        */ :
         /* comment */ ? //comment
         array {}
 
@@ -126,3 +126,10 @@ interface FooBar {
 /* testPHP8DuplicateTypeInUnionWhitespaceAndComment */
 // Intentional fatal error - duplicate types are not allowed in union types, but that's not the concern of the method.
 function duplicateTypeInUnion(): int | /*comment*/ string | INT {}
+
+/* testPHP81NeverType */
+function never(): never {}
+
+/* testPHP81NullableNeverType */
+// Intentional fatal error - nullability is not allowed with never, but that's not the concern of the method.
+function nullableNever(): ?never {}

tests/Core/File/GetMethodPropertiesTest.php

@@ -728,6 +728,52 @@ public function testPHP8DuplicateTypeInUnionWhitespaceAndComment()
     }//end testPHP8DuplicateTypeInUnionWhitespaceAndComment()
 
 
+    /**
+     * Verify recognition of PHP8.1 type "never".
+     *
+     * @return void
+     */
+    public function testPHP81NeverType()
+    {
+        $expected = [
+            'scope'                => 'public',
+            'scope_specified'      => false,
+            'return_type'          => 'never',
+            'nullable_return_type' => false,
+            'is_abstract'          => false,
+            'is_final'             => false,
+            'is_static'            => false,
+            'has_body'             => true,
+        ];
+
+        $this->getMethodPropertiesTestHelper('/* '.__FUNCTION__.' */', $expected);
+
+    }//end testPHP81NeverType()
+
+
+    /**
+     * Verify recognition of PHP8.1 type "never"  with (illegal) nullability.
+     *
+     * @return void
+     */
+    public function testPHP81NullableNeverType()
+    {
+        $expected = [
+            'scope'                => 'public',
+            'scope_specified'      => false,
+            'return_type'          => '?never',
+            'nullable_return_type' => true,
+            'is_abstract'          => false,
+            'is_final'             => false,
+            'is_static'            => false,
+            'has_body'             => true,
+        ];
+
+        $this->getMethodPropertiesTestHelper('/* '.__FUNCTION__.' */', $expected);
+
+    }//end testPHP81NullableNeverType()
+
+
     /**
      * Test helper.
      *

tests/Core/Tokenizer/NamedFunctionCallArgumentsTest.inc

@@ -396,3 +396,6 @@ foobar(parent: $value, /* testReservedKeywordParent2 */ parent: $value);
 
 /* testReservedKeywordSelf1 */
 foobar(self: $value, /* testReservedKeywordSelf2 */ self: $value);
+
+/* testReservedKeywordNever1 */
+foobar(never: $value, /* testReservedKeywordNever2 */ never: $value);

tests/Core/Tokenizer/NamedFunctionCallArgumentsTest.php

@@ -831,6 +831,7 @@ public function dataReservedKeywordsAsName()
             'resource',
             'mixed',
             'numeric',
+            'never',
 
             // Not reserved keyword, but do have their own token in PHPCS.
             'parent',