Bump phpstan from 1.x to 2.x and remove unnecessary psalm annotations

Author: SerafimArts

composer.json

@@ -19,9 +19,9 @@
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.53",
         "jetbrains/phpstorm-attributes": "^1.0",
-        "phpstan/extension-installer": "^1.4",
-        "phpstan/phpstan": "^1.11",
-        "phpstan/phpstan-strict-rules": "^1.6",
+        "phpstan/phpstan": "^2.0",
+        "phpstan/phpstan-deprecation-rules": "^2.0",
+        "phpstan/phpstan-strict-rules": "^2.0",
         "phpunit/phpunit": "^10.5|^11.0",
         "rector/rector": "^1.1",
         "type-lang/parser": "^1.0"
@@ -44,9 +44,6 @@
         "optimize-autoloader": true,
         "preferred-install": {
             "*": "dist"
-        },
-        "allow-plugins": {
-            "phpstan/extension-installer": true
         }
     },
     "scripts": {

phpstan.neon

@@ -1,7 +1,9 @@
 includes:
   - phar://phpstan.phar/conf/bleedingEdge.neon
+  - vendor/phpstan/phpstan-deprecation-rules/rules.neon
+  - vendor/phpstan/phpstan-strict-rules/rules.neon
 parameters:
-  level: 9
+  level: max
   strictRules:
     allRules: true
   fileExtensions:

src/Parser.php

@@ -42,11 +42,7 @@ public function parse(#[Language('PHP')] string $docblock): DocBlock
         $mapper = new SourceMap();
 
         try {
-            /**
-             * @var Segment $segment
-             *
-             * @psalm-suppress InvalidIterator
-             */
+            /** @var Segment $segment */
             foreach ($result = $this->analyze($docblock) as $segment) {
                 $mapper->add($segment->offset, $segment->text);
             }
@@ -72,7 +68,6 @@ public function parse(#[Language('PHP')] string $docblock): DocBlock
      */
     private function analyze(string $docblock): \Generator
     {
-        /** @psalm-suppress InvalidIterator */
         yield from $blocks = $this->groupByCommentSections($docblock);
 
         $description = null;

src/Tag/Content.php

@@ -24,8 +24,6 @@ class Content implements \Stringable
 
     /**
      * @var int<0, max>
-     *
-     * @psalm-readonly-allow-private-mutation
      */
     public int $offset = 0;
 

src/Tag/Content/TypeParserApplicator.php

@@ -32,7 +32,6 @@ public function __invoke(Content $lexer): TypeStatement
         try {
             $type = $this->parser->parse($lexer->value);
         } catch (ParserExceptionInterface $e) {
-            /** @psalm-suppress InvalidArgument */
             throw $lexer->getTagException(
                 message: \sprintf('Tag @%s contains an incorrect type', $this->tag),
                 previous: $e,

src/Tag/Description/DescriptionInterface.php

@@ -16,8 +16,6 @@ interface DescriptionInterface extends \Stringable
      * Magic method {@link https://www.php.net/manual/en/language.oop5.magic.php#object.tostring}
      * allows a class to decide how it will react when it is treated like
      * a string.
-     *
-     * @psalm-immutable Each call to the method must return the same value.
      */
     public function __toString(): string;
 }

src/Tag/Description/DescriptionProviderInterface.php

@@ -9,8 +9,6 @@ interface DescriptionProviderInterface extends OptionalDescriptionProviderInterf
     /**
      * Returns description object which can be represented as a string and
      * contains additional information.
-     *
-     * @psalm-immutable Each call to the method must return the same value.
      */
     public function getDescription(): DescriptionInterface;
 }

src/Tag/Description/OptionalDescriptionProviderInterface.php

@@ -9,8 +9,6 @@ interface OptionalDescriptionProviderInterface
     /**
      * Returns description object which can be represented as a string and
      * contains additional information.
-     *
-     * @psalm-immutable Each call to the method must return the same value.
      */
     public function getDescription(): ?DescriptionInterface;
 }

src/Tag/OptionalTypeProviderInterface.php

@@ -17,8 +17,6 @@ interface OptionalTypeProviderInterface
     /**
      * Returns an AST object of the type or {@see null} in case the
      * type is not specified.
-     *
-     * @psalm-immutable Each call to the method must return the same value.
      */
     public function getType(): ?TypeStatement;
 }

src/Tag/OptionalVariableNameProviderInterface.php

@@ -11,8 +11,6 @@ interface OptionalVariableNameProviderInterface
      * which this tag is attached or {@see null} in case of the tag does
      * not contain a name.
      *
-     * @psalm-immutable Each call to the method must return the same value.
-     *
      * @return non-empty-string|null
      */
     public function getVariableName(): ?string;

src/Tag/TagInterface.php

@@ -15,8 +15,6 @@ interface TagInterface extends OptionalDescriptionProviderInterface, \Stringable
      * that is, can contain all the characters that can match the PHP FQN, as
      * well as the '-' character.
      *
-     * @psalm-immutable Each call to the method must return the same value.
-     *
      * @return non-empty-string
      */
     public function getName(): string;
@@ -26,8 +24,6 @@ public function getName(): string;
      * allows a class to decide how it will react when it is treated like
      * a string.
      *
-     * @psalm-immutable Each call to the method must return the same value.
-     *
      * @return string returns string representation of the object that
      *         implements this interface (and/or {@see __toString()} magic
      *         method)

src/Tag/TagsProviderInterface.php

@@ -13,8 +13,6 @@ interface TagsProviderInterface
     /**
      * Returns the tags for this object.
      *
-     * @psalm-immutable Each call to the method must return the same value.
-     *
      * @return iterable<array-key, TagInterface>
      */
     public function getTags(): iterable;

src/Tag/TypeProviderInterface.php

@@ -10,8 +10,6 @@ interface TypeProviderInterface extends OptionalTypeProviderInterface
 {
     /**
      * Returns an AST object of the type.
-     *
-     * @psalm-immutable Each call to the method must return the same value.
      */
     public function getType(): TypeStatement;
 }

src/Tag/VariableNameProviderInterface.php

@@ -10,8 +10,6 @@ interface VariableNameProviderInterface extends OptionalVariableNameProviderInte
      * Returns the name of the variable (parameter, field, etc.) to
      * which this tag is attached.
      *
-     * @psalm-immutable Each call to the method must return the same value.
-     *
      * @return non-empty-string
      */
     public function getVariableName(): string;