Support PHPStan 2.0

.github/workflows/code_analysis.yaml

@@ -22,6 +22,7 @@ jobs:
 
                     -
                         name: 'Rector'
+                        if: ${{ false }} # Temporarily disabled as it is not compatible with PHPStan 2.0
                         run: composer rector --ansi
 
                     -
@@ -34,6 +35,7 @@ jobs:
 
                     -
                         name: 'Check Active Classes'
+                        if: ${{ false }} # Temporarily disabled as it is not compatible with PHPStan 2.0
                         run: vendor/bin/class-leak check src --ansi
 
         name: ${{ matrix.actions.name }}

composer.json

@@ -7,21 +7,17 @@
         "php": ">=8.1",
         "nette/utils": "^3.2.9 || ^4.0",
         "webmozart/assert": "^1.11",
-        "phpstan/phpstan": "^1.11",
+        "phpstan/phpstan": "^2.0",
         "symplify/rule-doc-generator-contracts": "^11.2"
     },
     "require-dev": {
         "nikic/php-parser": "^4.19",
-        "symplify/phpstan-extensions": "^11.4",
         "symplify/rule-doc-generator": "^12.2",
         "phpunit/phpunit": "^10.5",
         "symfony/framework-bundle": "6.1.*",
-        "rector/rector": "^1.2.3",
         "symplify/easy-coding-standard": "^12.3",
-        "phpstan/extension-installer": "^1.4",
-        "tomasvotruba/class-leak": "^0.2",
-        "tomasvotruba/unused-public": "^0.3.10",
-        "tomasvotruba/type-coverage": "^0.3.1"
+        "rector/rector": "dev-main as 1.2.10",
+        "phpstan/extension-installer": "^1.4"
     },
     "autoload": {
         "psr-4": {
@@ -36,10 +32,6 @@
             "stubs"
         ],
         "files": [
-            "tests/Rules/Rector/PhpUpgradeImplementsMinPhpVersionInterfaceRule/Fixture/SomePhpFeatureRector.php",
-            "vendor/rector/rector/src/Contract/Rector/RectorInterface.php",
-            "vendor/rector/rector/src/Contract/Rector/ConfigurableRectorInterface.php",
-            "vendor/rector/rector/vendor/rector/rector-downgrade-php/src/Set/ValueObject/DowngradeSetList.php"
         ]
     },
     "extra": {
@@ -58,7 +50,7 @@
     "scripts": {
         "check-cs": "vendor/bin/ecs check --ansi",
         "fix-cs": "vendor/bin/ecs check --fix --ansi",
-        "phpstan": "vendor/bin/phpstan analyse --ansi  --error-format symplify",
+        "phpstan": "vendor/bin/phpstan analyse --ansi",
         "rector": "vendor/bin/rector process --dry-run --ansi",
         "docs": "vendor/bin/rule-doc-generator generate src --readme --ansi"
     }

phpstan.neon

@@ -20,15 +20,15 @@ parameters:
         - */Fixture/*
 
     # https://github.com/TomasVotruba/unused-public
-    unused_public:
-        methods: true
-        properties: true
-        constants: true
-
-    type_coverage:
-        return: 99
-        param: 99
-        property: 99
+    # unused_public:
+    #     methods: true
+    #     properties: true
+    #     constants: true
+
+    # type_coverage:
+    #     return: 99
+    #     param: 99
+    #     property: 99
 
     ignoreErrors:
         # needless generics

src/Reflection/ReflectionParser.php

@@ -31,7 +31,7 @@ public function __construct(
         private readonly TypeAwareNodeFinder $typeAwareNodeFinder
     ) {
         $parserFactory = new ParserFactory();
-        $this->parser = $parserFactory->create(ParserFactory::PREFER_PHP7);
+        $this->parser = $parserFactory->createForNewestSupportedVersion();
     }
 
     public function parseMethodReflection(ReflectionMethod|MethodReflection $reflectionMethod): ?ClassMethod

src/ReturnTypeExtension/NodeGetAttributeTypeExtension.php

@@ -13,7 +13,6 @@
 use PhpParser\Node\Scalar\String_;
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\MethodReflection;
-use PHPStan\Reflection\ParametersAcceptorSelector;
 use PHPStan\Type\DynamicMethodReturnTypeExtension;
 use PHPStan\Type\NullType;
 use PHPStan\Type\ObjectType;

src/Rules/AbstractSymplifyRule.php

@@ -7,7 +7,6 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
-use PHPStan\Rules\RuleError;
 use Symplify\PHPStanRules\Contract\ManyNodeRuleInterface;
 use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
 
@@ -24,9 +23,6 @@ public function getNodeType(): string
         return Node::class;
     }
 
-    /**
-     * @return string[]|RuleError[]
-     */
     public function processNode(Node $node, Scope $scope): array
     {
         if ($this->shouldSkipNode($node)) {

src/Rules/AnnotateRegexClassConstWithRegexLinkRule.php

@@ -11,11 +11,13 @@
 use PhpParser\Node\Stmt\ClassConst;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @implements Rule<ClassConst>
  * @see \Symplify\PHPStanRules\Tests\Rules\AnnotateRegexClassConstWithRegexLinkRule\AnnotateRegexClassConstWithRegexLinkRuleTest
  */
 final class AnnotateRegexClassConstWithRegexLinkRule implements Rule, DocumentedRuleInterface
@@ -31,17 +33,13 @@ final class AnnotateRegexClassConstWithRegexLinkRule implements Rule, Documented
      */
     private const ALL_MODIFIERS = 'imsxeADSUXJu';
 
-    /**
-     * @return class-string<Node>
-     */
     public function getNodeType(): string
     {
         return ClassConst::class;
     }
 
     /**
      * @param ClassConst $node
-     * @return string[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -69,7 +67,7 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        return [self::ERROR_MESSAGE];
+        return [RuleErrorBuilder::message(self::ERROR_MESSAGE)->build()];
     }
 
     public function getRuleDefinition(): RuleDefinition

src/Rules/CheckClassNamespaceFollowPsr4Rule.php

@@ -9,6 +9,7 @@
 use PhpParser\Node\Stmt\ClassLike;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use Symplify\PHPStanRules\Composer\ClassNamespaceMatcher;
 use Symplify\PHPStanRules\Composer\ComposerAutoloadResolver;
 use Symplify\PHPStanRules\Composer\Psr4PathValidator;
@@ -17,6 +18,7 @@
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @implements Rule<ClassLike>
  * @see \Symplify\PHPStanRules\Tests\Rules\CheckClassNamespaceFollowPsr4Rule\CheckClassNamespaceFollowPsr4RuleTest
  */
 final class CheckClassNamespaceFollowPsr4Rule implements Rule, DocumentedRuleInterface
@@ -49,7 +51,6 @@ public function getNodeType(): string
 
     /**
      * @param ClassLike $node
-     * @return string[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -87,7 +88,7 @@ public function processNode(Node $node, Scope $scope): array
         $namespacePart = substr($namespaceBeforeClass, 0, -1);
         $errorMessage = sprintf(self::ERROR_MESSAGE, $namespacePart);
 
-        return [$errorMessage];
+        return [RuleErrorBuilder::message($errorMessage)->build()];
     }
 
     public function getRuleDefinition(): RuleDefinition

src/Rules/CheckRequiredInterfaceInContractNamespaceRule.php

@@ -9,6 +9,7 @@
 use PhpParser\Node\Stmt\Interface_;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
@@ -30,17 +31,13 @@ final class CheckRequiredInterfaceInContractNamespaceRule implements Rule, Docum
      */
     private const A_CONTRACT_NAMESPACE_REGEX = '#\bContracts?\b#';
 
-    /**
-     * @return class-string<Node>
-     */
     public function getNodeType(): string
     {
         return Interface_::class;
     }
 
     /**
      * @param Interface_ $node
-     * @return string[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -53,7 +50,7 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        return [self::ERROR_MESSAGE];
+        return [RuleErrorBuilder::message(self::ERROR_MESSAGE)->build()];
     }
 
     public function getRuleDefinition(): RuleDefinition

src/Rules/ClassNameRespectsParentSuffixRule.php

@@ -12,6 +12,8 @@
 use PHPStan\Node\InClassNode;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPUnit\Framework\TestCase;
 use Rector\Rector\AbstractRector;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
@@ -23,6 +25,7 @@
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @implements Rule<InClassNode>
  * @see \Symplify\PHPStanRules\Tests\Rules\ClassNameRespectsParentSuffixRule\ClassNameRespectsParentSuffixRuleTest
  */
 final class ClassNameRespectsParentSuffixRule implements Rule, DocumentedRuleInterface, ConfigurableRuleInterface
@@ -62,17 +65,13 @@ public function __construct(
         $this->parentClasses = array_merge($parentClasses, self::DEFAULT_PARENT_CLASSES);
     }
 
-    /**
-     * @return class-string<Node>
-     */
     public function getNodeType(): string
     {
         return InClassNode::class;
     }
 
     /**
      * @param InClassNode $node
-     * @return string[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -117,7 +116,7 @@ class SomeCommand extends Command
     }
 
     /**
-     * @return array<int, string>
+     * @return list<RuleError>
      */
     private function processClassNameAndShort(ClassReflection $classReflection): array
     {
@@ -132,7 +131,7 @@ private function processClassNameAndShort(ClassReflection $classReflection): arr
             }
 
             $errorMessage = sprintf(self::ERROR_MESSAGE, $expectedSuffix);
-            return [$errorMessage];
+            return [RuleErrorBuilder::message($errorMessage)->build()];
         }
 
         return [];

src/Rules/Complexity/ForbiddenArrayMethodCallRule.php

@@ -9,13 +9,15 @@
 use PhpParser\Node\Expr\ArrayItem;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\Constant\ConstantStringType;
 use PHPStan\Type\TypeWithClassName;
 use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @implements Rule<Array_>
  * @see \Symplify\PHPStanRules\Tests\Rules\Complexity\ForbiddenArrayMethodCallRule\ForbiddenArrayMethodCallRuleTest
  */
 final class ForbiddenArrayMethodCallRule implements Rule, DocumentedRuleInterface
@@ -25,17 +27,13 @@ final class ForbiddenArrayMethodCallRule implements Rule, DocumentedRuleInterfac
      */
     public const ERROR_MESSAGE = 'Array method calls [$this, "method"] are not allowed. Use explicit method instead to help PhpStorm, PHPStan and Rector understand your code';
 
-    /**
-     * @return class-string<Node>
-     */
     public function getNodeType(): string
     {
         return Array_::class;
     }
 
     /**
      * @param Array_ $node
-     * @return string[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -58,7 +56,7 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        return [self::ERROR_MESSAGE];
+        return [RuleErrorBuilder::message(self::ERROR_MESSAGE)->build()];
     }
 
     public function getRuleDefinition(): RuleDefinition

src/Rules/Domain/RequireAttributeNamespaceRule.php

@@ -8,11 +8,13 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\InClassNode;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @implements Rule<InClassNode>
  * @see \Symplify\PHPStanRules\Tests\Rules\Domain\RequireAttributeNamespaceRule\RequireAttributeNamespaceRuleTest
  */
 final class RequireAttributeNamespaceRule implements Rule, DocumentedRuleInterface
@@ -59,7 +61,6 @@ public function getNodeType(): string
 
     /**
      * @param InClassNode $node
-     * @return string[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -74,6 +75,6 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        return [self::ERROR_MESSAGE];
+        return [RuleErrorBuilder::message(self::ERROR_MESSAGE)->build()];
     }
 }

src/Rules/Domain/RequireExceptionNamespaceRule.php

@@ -8,11 +8,13 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\InClassNode;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @implements Rule<InClassNode>
  * @see \Symplify\PHPStanRules\Tests\Rules\Domain\RequireExceptionNamespaceRule\RequireExceptionNamespaceRuleTest
  */
 final class RequireExceptionNamespaceRule implements Rule, DocumentedRuleInterface
@@ -48,17 +50,13 @@ final class SomeException extends Exception
         ]);
     }
 
-    /**
-     * @return class-string<Node>
-     */
     public function getNodeType(): string
     {
         return InClassNode::class;
     }
 
     /**
      * @param InClassNode $node
-     * @return string[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -77,6 +75,6 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        return [self::ERROR_MESSAGE];
+        return [RuleErrorBuilder::message(self::ERROR_MESSAGE)->build()];
     }
 }