psalm est mort, vive le phpstan!

Author: Kirill Nesmeyanov

composer.json

@@ -24,14 +24,16 @@
         "jetbrains/phpstorm-attributes": "^1.0",
         "nikic/php-parser": "^4.19|^5.0",
         "phplrt/compiler": "^3.6",
-        "phpunit/phpunit": "^10.5|^11.0",
+        "phpstan/extension-installer": "^1.3",
+        "phpstan/phpstan": "^1.10",
+        "phpstan/phpstan-strict-rules": "^1.5",
+        "phpunit/phpunit": "^10.5",
         "rector/rector": "^1.0",
         "symfony/finder": "^5.4|^6.0|^7.0",
         "symfony/var-dumper": "^5.4|^6.0|^7.0",
         "type-lang/printer": ">=1.0.0-beta2 <2.0",
         "type-lang/phpdoc": ">=1.0.0-beta8 <2.0",
-        "type-lang/phpdoc-standard-tags": "^1.0",
-        "vimeo/psalm": "^5.23"
+        "type-lang/phpdoc-standard-tags": "^1.0"
     },
     "autoload-dev": {
         "psr-4": {
@@ -51,6 +53,9 @@
         "optimize-autoloader": true,
         "preferred-install": {
             "*": "dist"
+        },
+        "allow-plugins": {
+            "phpstan/extension-installer": true
         }
     },
     "scripts": {
@@ -61,8 +66,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

@@ -27,7 +27,6 @@ public function build(Context $context, mixed $result): mixed
             return $result;
         }
 
-        /** @psalm-suppress MixedAssignment */
         $result = ($this->reducers[$context->state])($context, $result);
 
         if ($result instanceof Node && $result->offset === 0) {

src/Builder.php

@@ -42,17 +42,14 @@ final class Identifier extends Node implements \Stringable
 
     /**
      * @param non-empty-string $value
-     *
-     * @psalm-suppress RedundantCondition
      */
     public function __construct(string $value)
     {
-        /** @psalm-suppress PropertyTypeCoercion */
-        $this->value = \trim($value);
+        $value = \trim($value);
+
+        assert($value !== '', new \InvalidArgumentException('Identifier value cannot be empty'));
 
-        assert($this->value !== '', new \InvalidArgumentException(
-            'Identifier value cannot be empty',
-        ));
+        $this->value = $value;
     }
 
     /**
@@ -128,13 +125,17 @@ public function __toString(): string
         return $this->value;
     }
 
+    /**
+     * @return array{int<0, max>, non-empty-string}
+     */
     public function __serialize(): array
     {
         return [$this->offset, $this->value];
     }
 
     /**
-     * @psalm-suppress MixedAssignment
+     * @param array{0?: int<0, max>, 1?: non-empty-string} $data
+     * @throws \UnexpectedValueException
      */
     public function __unserialize(array $data): void
     {

src/Node/Identifier.php

@@ -5,32 +5,20 @@
 namespace TypeLang\Parser\Node\Literal;
 
 /**
- * @template TValue of bool
- * @template-extends LiteralNode<TValue>
+ * @template-extends LiteralNode<bool>
  *
  * @psalm-consistent-constructor
- * @psalm-consistent-templates
+ * @phpstan-consistent-constructor
  */
 class BoolLiteralNode extends LiteralNode implements ParsableLiteralNodeInterface
 {
-    /**
-     * @param TValue $value
-     */
     public function __construct(
         public readonly bool $value,
         string $raw = null,
     ) {
         parent::__construct($raw ?? ($value ? 'true' : 'false'));
     }
 
-    /**
-     * @param non-empty-string $value
-     *
-     * @return static<bool>
-     * @psalm-suppress MoreSpecificImplementedParamType : Strengthening the
-     *                 precondition will violate the LSP, but in this case it is
-     *                 acceptable.
-     */
     public static function parse(string $value): static
     {
         return new static(\strtolower($value) === 'true', $value);

src/Node/Literal/BoolLiteralNode.php

@@ -5,34 +5,26 @@
 namespace TypeLang\Parser\Node\Literal;
 
 /**
- * @template TValue of float
- * @template-extends LiteralNode<TValue>
+ * @template-extends LiteralNode<float>
  *
  * @psalm-consistent-constructor
- * @psalm-consistent-templates
+ * @phpstan-consistent-constructor
  */
 class FloatLiteralNode extends LiteralNode implements ParsableLiteralNodeInterface
 {
-    /**
-     * @param TValue $value
-     */
     public function __construct(
         public readonly float $value,
         string $raw = null,
     ) {
         parent::__construct($raw ?? (string) $this->value);
     }
 
-    /**
-     * @param numeric-string $value
-     *
-     * @return static<float>
-     * @psalm-suppress MoreSpecificImplementedParamType : Strengthening the
-     *                 precondition will violate the LSP, but in this case it is
-     *                 acceptable.
-     */
     public static function parse(string $value): static
     {
+        if (!\is_numeric($value)) {
+            return new static(0.0, $value);
+        }
+
         return new static((float) $value, $value);
     }
 

src/Node/Literal/FloatLiteralNode.php

@@ -5,34 +5,26 @@
 namespace TypeLang\Parser\Node\Literal;
 
 /**
- * @template TValue of int
- * @template-extends LiteralNode<TValue>
+ * @template-extends LiteralNode<int>
  *
  * @psalm-consistent-constructor
- * @psalm-consistent-templates
+ * @phpstan-consistent-constructor
  */
 class IntLiteralNode extends LiteralNode implements ParsableLiteralNodeInterface
 {
-    /**
-     * @param TValue $value
-     */
     public function __construct(
         public readonly int $value,
         string $raw = null,
     ) {
         parent::__construct($raw ?? (string) $this->value);
     }
 
-    /**
-     * @param numeric-string $value
-     *
-     * @return static<int>
-     * @psalm-suppress MoreSpecificImplementedParamType : Strengthening the
-     *                 precondition will violate the LSP, but in this case it is
-     *                 acceptable.
-     */
     public static function parse(string $value): static
     {
+        if (!\is_numeric($value)) {
+            return new static(0, $value);
+        }
+
         [$isNegative, $decimal] = self::split($value);
 
         return new static($isNegative ? -$decimal : $decimal, $value);

src/Node/Literal/IntLiteralNode.php

@@ -6,12 +6,10 @@
 
 /**
  * @template-extends LiteralNode<null>
- *
- * @psalm-consistent-constructor
  */
 class NullLiteralNode extends LiteralNode
 {
-    final public function __construct(string $raw = null)
+    public function __construct(string $raw = null)
     {
         parent::__construct($raw ?? 'null');
     }

src/Node/Literal/NullLiteralNode.php

@@ -5,11 +5,10 @@
 namespace TypeLang\Parser\Node\Literal;
 
 /**
- * @template TValue of string
- * @template-extends LiteralNode<TValue>
+ * @template-extends LiteralNode<string>
  *
  * @psalm-consistent-constructor
- * @psalm-consistent-templates
+ * @phpstan-consistent-constructor
  */
 class StringLiteralNode extends LiteralNode implements ParsableLiteralNodeInterface
 {
@@ -36,27 +35,16 @@ class StringLiteralNode extends LiteralNode implements ParsableLiteralNodeInterf
         '\$' => "\$",
     ];
 
-    /**
-     * @param TValue $value
-     */
     final public function __construct(
         public readonly string $value,
         string $raw = null,
     ) {
         parent::__construct($raw ?? $this->value);
     }
 
-    /**
-     * @param non-empty-string $value
-     *
-     * @return static<string>
-     * @psalm-suppress MoreSpecificImplementedParamType : Strengthening the
-     *                 precondition will violate the LSP, but in this case it is
-     *                 acceptable.
-     */
     public static function parse(string $value): static
     {
-        assert(\strlen($value) >= 2);
+        assert(\strlen($value) >= 2, new \InvalidArgumentException('Could not parse non-quoted string'));
 
         if ($value[0] === '"') {
             return static::createFromDoubleQuotedString($value);
@@ -67,29 +55,25 @@ public static function parse(string $value): static
 
     /**
      * @param non-empty-string $value
-     *
-     * @return static<string>
      */
     public static function createFromDoubleQuotedString(string $value): static
     {
-        assert(\strlen($value) >= 2);
+        assert(\strlen($value) >= 2, new \InvalidArgumentException('Could not parse non-quoted string'));
 
         $body = \substr($value, 1, -1);
 
-        return static::parseEncodedValue(
+        return self::parseEncodedValue(
             string: \str_replace('\"', '"', $body),
             raw: $value,
         );
     }
 
     /**
      * @param non-empty-string $value
-     *
-     * @return static<string>
      */
     public static function createFromSingleQuotedString(string $value): static
     {
-        assert(\strlen($value) >= 2);
+        assert(\strlen($value) >= 2, new \InvalidArgumentException('Could not parse non-quoted string'));
 
         $body = \substr($value, 1, -1);
 
@@ -146,7 +130,9 @@ private static function renderEscapeSequences(string $body): string
      */
     private static function renderHexadecimalSequences(string $body): string
     {
-        $callee = static fn(array $matches): string => \chr(\hexdec((string) $matches[1]));
+        $callee = static fn(array $matches): string
+            => \chr((int) \hexdec((string) $matches[1]))
+        ;
 
         /** @psalm-suppress InvalidArgument */
         return @\preg_replace_callback(self::HEX_SEQUENCE_PATTERN, $callee, $body) ?? $body;
@@ -161,11 +147,10 @@ private static function renderHexadecimalSequences(string $body): string
     private static function renderUtfSequences(string $body): string
     {
         $callee = static function (array $matches): string {
-            $code = \hexdec((string) $matches[1]);
+            $code = (int) \hexdec((string) $matches[1]);
 
-            if (\function_exists('\\mb_chr')
-                && ($result = \mb_chr($code)) !== false
-            ) {
+            // @phpstan-ignore-next-line : PHPStan false-positive mb_chr evaluation
+            if (\function_exists('\\mb_chr') && ($result = \mb_chr($code)) !== false) {
                 return $result;
             }