psalm est mort, vive le phpstan!

Author: Kirill Nesmeyanov

composer.json

@@ -18,10 +18,12 @@
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.53",
+        "phpstan/extension-installer": "^1.3",
+        "phpstan/phpstan": "^1.10",
+        "phpstan/phpstan-strict-rules": "^1.5",
         "phpunit/phpunit": "^10.5",
         "rector/rector": "^1.0",
-        "type-lang/parser": "^1.0",
-        "vimeo/psalm": "^5.23"
+        "type-lang/parser": "^1.0"
     },
     "autoload-dev": {
         "psr-4": {
@@ -41,6 +43,9 @@
         "optimize-autoloader": true,
         "preferred-install": {
             "*": "dist"
+        },
+        "allow-plugins": {
+            "phpstan/extension-installer": true
         }
     },
     "scripts": {
@@ -49,8 +54,8 @@
         "test:functional": "phpunit --testsuite=functional",
 
         "linter": "@linter:check",
-        "linter:check": "psalm --no-cache",
-        "linter:fix": "psalm --no-cache --alter",
+        "linter:check": "phpstan analyse --configuration phpstan.neon",
+        "linter:baseline": "phpstan analyse --configuration phpstan.neon --generate-baseline",
 
         "phpcs": "@phpcs:check",
         "phpcs:check": "php-cs-fixer fix --config=.php-cs-fixer.php --allow-risky=yes --dry-run --verbose --diff",

phpstan.neon

@@ -0,0 +1,12 @@
+includes:
+  - phar://phpstan.phar/conf/bleedingEdge.neon
+parameters:
+  level: 9
+  strictRules:
+    allRules: true
+  fileExtensions:
+    - php
+  paths:
+    - src
+  tmpDir: vendor/.cache.phpstan
+  reportUnmatchedIgnoredErrors: false

psalm.xml

@@ -14,8 +14,8 @@
  * This class represents structure containing a description and a set of tags
  * that describe an arbitrary DocBlock Comment in the code.
  *
- * @template-implements \ArrayAccess<int<0, max>, TagInterface|null>
- * @template-implements \IteratorAggregate<int<0, max>, TagInterface>
+ * @template-implements \ArrayAccess<array-key, TagInterface|null>
+ * @template-implements \IteratorAggregate<array-key, TagInterface>
  */
 final class DocBlock implements
     OptionalDescriptionProviderInterface,
@@ -28,7 +28,6 @@ final class DocBlock implements
 
     /**
      * @var list<TagInterface>
-     * @psalm-suppress PropertyNotSetInConstructor
      */
     private readonly array $tags;
 
@@ -54,6 +53,9 @@ public function getDescription(): DescriptionInterface
         return $this->description;
     }
 
+    /**
+     * @return list<TagInterface>
+     */
     public function getTags(): array
     {
         return $this->tags;

src/DocBlock.php

@@ -91,7 +91,7 @@ private function getDocBlockChunks(string $contents): array
         }
 
         /** @var list<non-empty-string> */
-        return \array_filter($result);
+        return \array_filter($result, static fn (string $chunk): bool => $chunk !== '');
     }
 
     /**

src/Parser/Description/RegexDescriptionParser.php

@@ -85,9 +85,9 @@ public function parse(string $tag, DescriptionParserInterface $parser): TagInter
         try {
             return $this->tags->create($name, new Content($trimmed), $parser);
         } catch (RuntimeExceptionInterface $e) {
-            /** @var int<0, max> */
             $offset += \strlen($content) - \strlen($trimmed);
 
+            /** @var int<0, max> $offset */
             throw $e->withSource($tag, $offset);
         }
     }

src/Parser/Tag/RegexTagParser.php

@@ -50,7 +50,7 @@ public function shift(int $offset, bool $ltrim = true): void
             $this->value = \ltrim($this->value);
         }
 
-        /** @psalm-suppress InvalidPropertyAssignmentValue */
+        // @phpstan-ignore-next-line : Offset already greater than 0
         $this->offset += $size - \strlen($this->value);
     }
 
@@ -175,6 +175,15 @@ public function toDescription(DescriptionParserInterface $descriptions): Descrip
         return $descriptions->parse($this->value);
     }
 
+    public function toOptionalDescription(DescriptionParserInterface $descriptions): ?DescriptionInterface
+    {
+        if (\trim($this->value) === '') {
+            return null;
+        }
+
+        return $descriptions->parse(\rtrim($this->value));
+    }
+
     public function __toString(): string
     {
         return $this->value;

src/Tag/Content.php

@@ -15,9 +15,6 @@
  */
 final class OptionalTypeParserApplicator extends Applicator
 {
-    /**
-     * @param non-empty-string $tag
-     */
     public function __construct(
         private readonly TypesParserInterface $parser,
     ) {}
@@ -36,10 +33,7 @@ public function __invoke(Content $lexer): ?TypeStatement
             return null;
         }
 
-        /**
-         * @psalm-suppress MixedArgument
-         * @psalm-suppress NoInterfaceProperties
-         */
+        // @phpstan-ignore-next-line : Property is defined
         $lexer->shift($this->parser->lastProcessedTokenOffset);
 
         return $type;

src/Tag/Content/OptionalTypeParserApplicator.php

@@ -32,7 +32,6 @@ public function __construct(
     public function __invoke(Content $lexer): TypeStatement
     {
         try {
-            /** @var TypeStatement $type */
             $type = $this->parser->parse($lexer->value);
         } catch (ParserExceptionInterface $e) {
             /** @psalm-suppress InvalidArgument */
@@ -42,10 +41,7 @@ public function __invoke(Content $lexer): TypeStatement
             );
         }
 
-        /**
-         * @psalm-suppress MixedArgument
-         * @psalm-suppress NoInterfaceProperties
-         */
+        // @phpstan-ignore-next-line : Property is defined
         $lexer->shift($this->parser->lastProcessedTokenOffset);
 
         return $type;

src/Tag/Content/TypeParserApplicator.php

@@ -13,6 +13,9 @@
  */
 final class ValueApplicator extends Applicator
 {
+    /**
+     * @var OptionalValueApplicator<T>
+     */
     private readonly OptionalValueApplicator $identifier;
 
     /**