Merge pull request #49 from PHPCSStandards/php-8.2/account-for-true-type

PHP 8.2 | Tokenizer, File, sniffs: account for new `true` type

Author: jrfnl

CHANGELOG.md

@@ -29,6 +29,13 @@ The file documents changes to the PHP_CodeSniffer project.
     - Squiz.Commenting.FileComment
     - Squiz.Commenting.InlineComment
     - Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
+- Added support for `true` as a stand-alone type declaration
+    - The `File::getMethodProperties()`, `File::getMethodParameters()` and `File::getMemberProperties()` methods now all support the `true` type.
+    - Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
+- Added support for `true` as a stand-alone type to a number of sniffs
+    - Generic.PHP.LowerCaseType
+    - PSr12.Functions.NullableTypeDeclaration
+    - Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
 - Squiz.Commenting.FunctionComment: new ParamNameUnexpectedAmpersandPrefix error for parameters annotated as passed by reference while the parameter is not passed by reference
     - Thanks to Dan Wallis (@fredden) for the patch
 - Documentation has been added for the following sniffs:
@@ -39,6 +46,7 @@ The file documents changes to the PHP_CodeSniffer project.
 - Support for PHPUnit 8 and 9 to the test suite.
     - Test suites for external standards which run via the PHPCS native test suite can now run on PHPUnit 4-9 (was 4-7).
     - If any of these tests use the PHPUnit `setUp()`/`tearDown()` methods or overload the `setUp()` in the `AbstractSniffUnitTest` test case, they will need to be adjusted. See the [PR details for further information](https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/59/commits/26384ebfcc0b1c1651b0e1e40c9b6c8c22881832).
+    - Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
 
 ### Changed
 - Changes have been made to the way PHPCS handles invalid sniff properties being set in a custom ruleset
@@ -69,6 +77,7 @@ The file documents changes to the PHP_CodeSniffer project.
 - Squiz.PHP.InnerFunctions sniff no longer reports on OO methods for OO structures declared within a function or closure
     - Thanks to @Daimona for the patch
 - Runtime performance improvement for PHPCS CLI users. The improvement should be most noticeable for users on Windows.
+    - Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
 
 ### Removed
 - Removed support for installing via PEAR

src/Files/File.php

@@ -1479,6 +1479,7 @@ public function getMethodParameters($stackPtr)
             case T_TYPE_UNION:
             case T_TYPE_INTERSECTION:
             case T_FALSE:
+            case T_TRUE:
             case T_NULL:
                 // Part of a type hint or default value.
                 if ($defaultStart === null) {
@@ -1705,6 +1706,7 @@ public function getMethodProperties($stackPtr)
                 T_PARENT            => T_PARENT,
                 T_STATIC            => T_STATIC,
                 T_FALSE             => T_FALSE,
+                T_TRUE              => T_TRUE,
                 T_NULL              => T_NULL,
                 T_NAMESPACE         => T_NAMESPACE,
                 T_NS_SEPARATOR      => T_NS_SEPARATOR,
@@ -1906,6 +1908,7 @@ public function getMemberProperties($stackPtr)
                 T_SELF              => T_SELF,
                 T_PARENT            => T_PARENT,
                 T_FALSE             => T_FALSE,
+                T_TRUE              => T_TRUE,
                 T_NULL              => T_NULL,
                 T_NAMESPACE         => T_NAMESPACE,
                 T_NS_SEPARATOR      => T_NS_SEPARATOR,

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

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

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

@@ -92,3 +92,5 @@ function intersectionReturnTypes ($var): \Package\ClassName&\Package\Other_Class
 
 $arrow = fn (int $a, string $b, bool $c, array $d, Foo\Bar $e) : int => $a * $b;
 $arrow = fn (Int $a, String $b, BOOL $c, Array $d, Foo\Bar $e) : Float => $a * $b;
+
+$cl = function (False $a, TRUE $b, Null $c): ?True {}

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

@@ -92,3 +92,5 @@ function intersectionReturnTypes ($var): \Package\ClassName&\Package\Other_Class
 
 $arrow = fn (int $a, string $b, bool $c, array $d, Foo\Bar $e) : int => $a * $b;
 $arrow = fn (int $a, string $b, bool $c, array $d, Foo\Bar $e) : float => $a * $b;
+
+$cl = function (false $a, true $b, null $c): ?true {}

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

@@ -67,6 +67,7 @@ public function getErrorList()
             82 => 2,
             85 => 1,
             94 => 5,
+            96 => 4,
         ];
 
     }//end getErrorList()

src/Standards/PSR12/Sniffs/Functions/NullableTypeDeclarationSniff.php

@@ -27,6 +27,9 @@ class NullableTypeDeclarationSniff implements Sniff
         T_SELF         => true,
         T_PARENT       => true,
         T_STATIC       => true,
+        T_NULL         => true,
+        T_FALSE        => true,
+        T_TRUE         => true,
     ];
 
 

src/Standards/PSR12/Tests/Functions/NullableTypeDeclarationUnitTest.inc

@@ -85,3 +85,11 @@ class testInstanceOf() {
 
 // PHP 8.0: static return type.
 function testStatic() : ? static {}
+
+// PHP 8.2: nullable true/false.
+function fooG(): ? true {}
+function fooH(): ?
+     false {}
+
+// Fatal error: null cannot be marked as nullable, but that's not the concern of this sniff.
+function fooI(): ? null {}

src/Standards/PSR12/Tests/Functions/NullableTypeDeclarationUnitTest.inc.fixed

@@ -83,3 +83,10 @@ class testInstanceOf() {
 
 // PHP 8.0: static return type.
 function testStatic() : ?static {}
+
+// PHP 8.2: nullable true/false.
+function fooG(): ?true {}
+function fooH(): ?false {}
+
+// Fatal error: null cannot be marked as nullable, but that's not the concern of this sniff.
+function fooI(): ?null {}

src/Standards/PSR12/Tests/Functions/NullableTypeDeclarationUnitTest.php

@@ -41,6 +41,9 @@ protected function getErrorList()
             58 => 2,
             59 => 2,
             87 => 1,
+            90 => 1,
+            91 => 1,
+            95 => 1,
         ];
 
     }//end getErrorList()