Update to PHPStan 2.0

carlos-granados · carlos-granados · commit 4b575a58f7f7 · 2024-12-24T07:02:15.000+01:00
diff --git a/.github/workflows/all_tests.yml b/.github/workflows/all_tests.yml
@@ -14,10 +14,10 @@ jobs:
             fail-fast: false
             matrix:
                 php-version:
-                    - "8.0"
                     - "8.1"
                     - "8.2"
                     - "8.3"
+                    - "8.4"
 
         steps:
             - name: "Checkout"
diff --git a/composer.json b/composer.json
@@ -17,17 +17,17 @@
     "minimum-stability": "dev",
     "prefer-stable": true,
     "require": {
-        "php": ">=8.0"
+        "php": ">=8.1"
     },
     "require-dev": {
-        "php-static-analysis/node-visitor": "dev-main",
-        "php-static-analysis/phpstan-extension": "dev-main",
-        "php-static-analysis/psalm-plugin": "dev-main",
+        "php-static-analysis/node-visitor": "^0.4.0 || dev-main",
+        "php-static-analysis/phpstan-extension": "^0.4.0 || dev-main",
+        "php-static-analysis/psalm-plugin": "^0.4.0 || dev-main",
         "phpstan/extension-installer": "^1.3",
-        "phpstan/phpstan": "^1.8",
+        "phpstan/phpstan": "^2.0",
         "phpunit/phpunit": "^9.0",
         "symplify/easy-coding-standard": "^12.1",
-        "vimeo/psalm": "^5"
+        "vimeo/psalm": "dev-master"
     },
     "scripts": {
         "phpstan": "phpstan analyse",
@@ -45,7 +45,8 @@
     },
     "config": {
         "allow-plugins": {
-            "phpstan/extension-installer": true
+            "phpstan/extension-installer": true,
+            "php-static-analysis/psalm-plugin": true
         },
         "sort-packages": true
     },
diff --git a/phpstan.neon b/phpstan.neon
@@ -3,15 +3,61 @@ parameters:
     paths:
     - src
     - tests
-    featureToggles:
-        readOnlyByPhpDoc: true
 
     ignoreErrors:
-    - '#^Constructor of class PhpStaticAnalysis\\Attributes\\[a-zA-Z]+ has an unused parameter \$[a-zA-Z]+\.$#'
-    - '#^(Function|Method) [a-zA-Z\:]+\(\) return type has no value type specified in iterable type array.$#'
-    - '#^Parameter \#1 \.*\$[a-zA-Z]+ of attribute class PhpStaticAnalysis\\Attributes\\[a-zA-Z]+ constructor expects string, int given.$#'
-    - '#^PHPDoc tag @[a-z\-A-Z]+ has invalid value \(\): Unexpected token "\\n ", expected type at offset [0-9]+$#'
-    - '#^Attribute class PhpStaticAnalysis\\Attributes\\[a-zA-Z]+ constructor invoked with [0-9]+ parameter(s)?, [0-9]+ required.$#'
-    - '#^Attribute class PhpStaticAnalysis\\Attributes\\[a-zA-Z]+ is not repeatable but is already present above the (property|method).$#'
-    - '#^Method [a-zA-Z\:]+\(\) has parameter \$[a-zA-Z]+ with generic class [a-zA-Z]+ but does not specify its types: [a-zA-Z]+$#'
-    - '#^PHPDoc tag @phpstan-self-out contains generic type [a-zA-Z]+<[a-zA-Z]+> but class [a-zA-Z]+ is not generic.$#'
+        -
+            identifier: method.impossibleType
+            paths:
+                - tests/AssertIfFalseTest.php
+
+        -
+            identifier: function.impossibleType
+            paths:
+                - tests/AssertIfFalseTest.php
+
+        -
+            identifier: assert.alreadyNarrowedType
+            paths:
+                - tests/AssertIfFalseTest.php
+                - tests/AssertIfTrueTest.php
+                - tests/AssertTest.php
+
+        -
+            identifier: method.alreadyNarrowedType
+            paths:
+                - tests/AssertIfTrueTest.php
+
+        -
+            identifier: function.alreadyNarrowedType
+            paths:
+                - tests/AssertIfTrueTest.php
+
+        -
+            identifier: constructor.unusedParameter
+            paths:
+                - src/*
+
+        -
+            identifier: missingType.iterableValue
+            paths:
+                - tests/*
+
+        -
+            identifier: missingType.generics
+            paths:
+                - tests/*
+
+        -
+            identifier: phpDoc.parseError
+            paths:
+                - tests/*
+
+        -
+            identifier: possiblyImpure.methodCall
+            paths:
+                - tests/PureTest.php
+
+        -
+            identifier: possiblyImpure.new
+            paths:
+                - tests/PureTest.php
diff --git a/psalm.xml b/psalm.xml
@@ -10,9 +10,6 @@
 >
     <projectFiles>
         <directory name="src" />
-        <ignoreFiles>
-            <directory name="vendor" />
-        </ignoreFiles>
     </projectFiles>
     <plugins>
         <pluginClass class="PhpStaticAnalysis\PsalmPlugin\Plugin" />
diff --git a/src/Internal.php b/src/Internal.php
@@ -16,7 +16,7 @@
 final class Internal
 {
     public function __construct(
-        string $namespace = null
+        ?string $namespace = null
     ) {
     }
 }
diff --git a/tests/DeprecatedTest.php b/tests/DeprecatedTest.php
@@ -107,3 +107,8 @@ function functionDeprecated(): bool
     $reflection = new ReflectionFunction(__FUNCTION__);
     return DeprecatedTest::getDeprecatedFromReflection($reflection);
 }
+
+class DeprecatedClass
+{
+    use DeprecatedTestTrait;
+}
diff --git a/tests/ImmutableTest.php b/tests/ImmutableTest.php
@@ -51,3 +51,8 @@ trait ImmutableTestTrait
 interface ImmutableTestInterface
 {
 }
+
+class ImmutableClass
+{
+    use ImmutableTestTrait;
+}
diff --git a/tests/RequireExtendsTest.php b/tests/RequireExtendsTest.php
@@ -22,6 +22,7 @@ public static function getRequireExtendssFromReflection(
             if ($attribute->getName() === RequireExtends::class) {
                 $attribute->newInstance();
                 $extends = $attribute->getArguments()[0];
+                assert(is_string($extends));
             }
         }
 
diff --git a/tests/ReturnsTest.php b/tests/ReturnsTest.php
@@ -95,6 +95,7 @@ public static function getReturnsFromReflection(
             if ($attribute->getName() === Returns::class) {
                 $attribute->newInstance();
                 $returns = $attribute->getArguments()[0];
+                assert(is_string($returns));
             }
         }
 
diff --git a/tests/SelfOutTest.php b/tests/SelfOutTest.php
@@ -3,8 +3,10 @@
 declare(strict_types=1);
 
 use PhpStaticAnalysis\Attributes\SelfOut;
+use PhpStaticAnalysis\Attributes\Template;
 use PHPUnit\Framework\TestCase;
 
+#[Template('T')]
 class SelfOutTest extends TestCase
 {
     public function testMethodSelfOut(): void
@@ -84,6 +86,7 @@ private function getSelfOut(string $methodName): string
             if ($attribute->getName() === SelfOut::class) {
                 $attribute->newInstance();
                 $selfOut = $attribute->getArguments()[0];
+                assert(is_string($selfOut));
             }
         }
 
diff --git a/tests/TemplateContravariantTest.php b/tests/TemplateContravariantTest.php
@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use PhpStaticAnalysis\Attributes\TemplateContravariant;
+use PhpStaticAnalysis\Attributes\TemplateUse;
 use PHPUnit\Framework\TestCase;
 
 #[TemplateContravariant('TClass', Exception::class)]
@@ -36,8 +37,11 @@ public static function getTemplateContravariantsFromReflection(
                 $attribute->newInstance();
                 $templateData = $attribute->getArguments();
                 $templateValue = $templateData[0];
-                if (isset($templateData[1]) && $templateData[1] !== null) {
-                    $templateValue .= ' of ' . $templateData[1];
+                assert(is_string($templateValue));
+                if (isset($templateData[1])) {
+                    $className = $templateData[1];
+                    assert(is_string($className));
+                    $templateValue .= ' of ' . $className;
                 }
                 $templates[] = $templateValue;
             }
@@ -56,3 +60,9 @@ trait TemplateContravariantTestTrait
 interface TemplateContravariantTestInterface
 {
 }
+
+#[TemplateUse('TemplateContravariantTestTrait<string>')]
+class ContravariantClass
+{
+    use TemplateContravariantTestTrait;
+}
diff --git a/tests/TemplateCovariantTest.php b/tests/TemplateCovariantTest.php
@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use PhpStaticAnalysis\Attributes\TemplateCovariant;
+use PhpStaticAnalysis\Attributes\TemplateUse;
 use PHPUnit\Framework\TestCase;
 
 #[TemplateCovariant('TClass', Exception::class)]
@@ -36,8 +37,11 @@ public static function getTemplateCovariantsFromReflection(
                 $attribute->newInstance();
                 $templateData = $attribute->getArguments();
                 $templateValue = $templateData[0];
-                if (isset($templateData[1]) && $templateData[1] !== null) {
-                    $templateValue .= ' of ' . $templateData[1];
+                assert(is_string($templateValue));
+                if (isset($templateData[1])) {
+                    $className = $templateData[1];
+                    assert(is_string($className));
+                    $templateValue .= ' of ' . $className;
                 }
                 $templates[] = $templateValue;
             }
@@ -56,3 +60,9 @@ trait TemplateCovariantTestTrait
 interface TemplateCovariantTestInterface
 {
 }
+
+#[TemplateUse('TemplateCovariantTestTrait<string>')]
+class CovariantClass
+{
+    use TemplateCovariantTestTrait;
+}
diff --git a/tests/TemplateExtendsTest.php b/tests/TemplateExtendsTest.php
@@ -23,6 +23,7 @@ public static function getTemplateExtendssFromReflection(
             if ($attribute->getName() === TemplateExtends::class) {
                 $attribute->newInstance();
                 $extends = $attribute->getArguments()[0];
+                assert(is_string($extends));
             }
         }
 
diff --git a/tests/TemplateTest.php b/tests/TemplateTest.php
@@ -4,6 +4,7 @@
 
 use PhpStaticAnalysis\Attributes\Param;
 use PhpStaticAnalysis\Attributes\Template;
+use PhpStaticAnalysis\Attributes\TemplateUse;
 use PHPUnit\Framework\TestCase;
 
 #[Template('TClass')]
@@ -103,8 +104,11 @@ public static function getTemplatesFromReflection(
                 $attribute->newInstance();
                 $templateData = $attribute->getArguments();
                 $templateValue = $templateData[0];
-                if (isset($templateData[1]) && $templateData[1] !== null) {
-                    $templateValue .= ' of ' . $templateData[1];
+                assert(is_string($templateValue));
+                if (isset($templateData[1])) {
+                    $className = $templateData[1];
+                    assert(is_string($className));
+                    $templateValue .= ' of ' . $className;
                 }
                 $templates[] = $templateValue;
             }
@@ -124,6 +128,13 @@ interface TemplateTestInterface
 {
 }
 
+#[TemplateUse('TemplateTestTrait<string>')]
+class TemplateClass
+{
+    use TemplateTestTrait;
+}
+
+
 #[Template('TFunction')]
 #[Param(param: 'TFunction')]
 function functionTemplate($param): array
diff --git a/tests/TypeTest.php b/tests/TypeTest.php
@@ -138,6 +138,7 @@ public static function getTypeFromReflection(
             if ($attribute->getName() === Type::class) {
                 $attribute->newInstance();
                 $type = $attribute->getArguments()[0];
+                assert(is_string($type));
             }
         }
 

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`final class Internal`
`17`	`17`	`{`
`18`	`18`	`public function __construct(`
`19`		`- string $namespace = null`
	`19`	`+ ?string $namespace = null`
`20`	`20`	`) {`
`21`	`21`	`}`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -107,3 +107,8 @@ function functionDeprecated(): bool`
`107`	`107`	`$reflection = new ReflectionFunction(__FUNCTION__);`
`108`	`108`	`return DeprecatedTest::getDeprecatedFromReflection($reflection);`
`109`	`109`	`}`
	`110`	`+`
	`111`	`+class DeprecatedClass`
	`112`	`+{`
	`113`	`+ use DeprecatedTestTrait;`
	`114`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -51,3 +51,8 @@ trait ImmutableTestTrait`
`51`	`51`	`interface ImmutableTestInterface`
`52`	`52`	`{`
`53`	`53`	`}`
	`54`	`+`
	`55`	`+class ImmutableClass`
	`56`	`+{`
	`57`	`+ use ImmutableTestTrait;`
	`58`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ public static function getRequireExtendssFromReflection(`
`22`	`22`	`if ($attribute->getName() === RequireExtends::class) {`
`23`	`23`	`$attribute->newInstance();`
`24`	`24`	`$extends = $attribute->getArguments()[0];`
	`25`	`+ assert(is_string($extends));`
`25`	`26`	`}`
`26`	`27`	`}`
`27`	`28`
Original file line number	Diff line number	Diff line change
`@@ -95,6 +95,7 @@ public static function getReturnsFromReflection(`
`95`	`95`	`if ($attribute->getName() === Returns::class) {`
`96`	`96`	`$attribute->newInstance();`
`97`	`97`	`$returns = $attribute->getArguments()[0];`
	`98`	`+ assert(is_string($returns));`
`98`	`99`	`}`
`99`	`100`	`}`
`100`	`101`
Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,10 @@`
`3`	`3`	`declare(strict_types=1);`
`4`	`4`
`5`	`5`	`use PhpStaticAnalysis\Attributes\SelfOut;`
	`6`	`+use PhpStaticAnalysis\Attributes\Template;`
`6`	`7`	`use PHPUnit\Framework\TestCase;`
`7`	`8`
	`9`	`+#[Template('T')]`
`8`	`10`	`class SelfOutTest extends TestCase`
`9`	`11`	`{`
`10`	`12`	`public function testMethodSelfOut(): void`
`@@ -84,6 +86,7 @@ private function getSelfOut(string $methodName): string`
`84`	`86`	`if ($attribute->getName() === SelfOut::class) {`
`85`	`87`	`$attribute->newInstance();`
`86`	`88`	`$selfOut = $attribute->getArguments()[0];`
	`89`	`+ assert(is_string($selfOut));`
`87`	`90`	`}`
`88`	`91`	`}`
`89`	`92`