Fix issues reported by PHPStan (#41)

* Fix issues reported by PHPStan

* Relax phpstan/phpstan-symfony version constraint

Author: IanDelMar

composer.json

@@ -31,7 +31,9 @@
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "3.4.0 || ^3.12",
+        "phpstan/extension-installer": "^1.4",
         "phpstan/phpstan": "^1.0 || ^2.0",
+        "phpstan/phpstan-symfony": "^1.0 || ^2.0",
         "phpunit/phpunit": "^9.4"
     },
     "scripts": {
@@ -41,6 +43,9 @@
         "phpstan": "phpstan analyse"
     },
     "config": {
+        "allow-plugins": {
+            "phpstan/extension-installer": true
+        },
         "sort-packages": true
     }
 }

phpstan.neon

@@ -2,3 +2,5 @@ parameters:
     level: max
     paths:
         - src
+    symfony:
+        consoleApplicationLoader: test/console-loader.php

src/GenerateStubsCommand.php

@@ -22,8 +22,7 @@
 class GenerateStubsCommand extends Command
 {
     /**
-     * @var (string|int)[][]
-     * @psalm-var array<int,array{0: string, 1: string, 2: int}>
+     * @var array<int, array{0: string, 1: int}>
      */
     private const SYMBOL_OPTIONS = [
         ['functions', StubsGenerator::FUNCTIONS],
@@ -37,13 +36,11 @@ class GenerateStubsCommand extends Command
     ];
 
     /**
-     * @psalm-suppress PropertyNotSetInConstructor
      * @var Filesystem
      */
     private $filesystem;
 
     /**
-     * @psalm-suppress PropertyNotSetInConstructor
      * @var string|null
      */
     private $outFile;

src/NodeVisitor.php

@@ -2,6 +2,7 @@
 namespace StubsGenerator;
 
 use PhpParser\Node;
+use PhpParser\Node\Arg;
 use PhpParser\Node\Expr\ArrayDimFetch;
 use PhpParser\Node\Expr\Assign;
 use PhpParser\Node\Expr\ConstFetch;
@@ -25,6 +26,10 @@
 use PhpParser\NodeTraverser;
 use PhpParser\NodeVisitorAbstract;
 
+use function count;
+use function defined;
+use function is_string;
+
 /**
  * On node traversal, this visitor converts any AST to one just containing stub
  * definitions, removing anything uninteresting.
@@ -53,22 +58,21 @@ class NodeVisitor extends NodeVisitorAbstract
     private $includeInaccessibleClassNodes;
 
     /**
-     * @psalm-suppress PropertyNotSetInConstructor
-     * @var Node[]
+     * @var array<Node>
      */
     protected $stack;
 
-    /** @var Namespace_[] */
+    /** @var array<Namespace_> */
     private $namespaces = [];
     /** @var Namespace_ */
     private $globalNamespace;
-    /** @var Node[] */
+    /** @var array<Node> */
     private $globalExpressions = [];
-    /** @var ClassLikeWithDependencies[] */
+    /** @var array<string, ClassLikeWithDependencies> */
     private $classLikes = [];
-    /** @var true[] */
+    /** @var array<string, true> */
     private $resolvedClassLikes = [];
-    /** @var Namespace_[] */
+    /** @var array<Namespace_> */
     private $classLikeNamespaces = [];
     /** @var Namespace_|null */
     private $currentClassLikeNamespace = null;
@@ -79,8 +83,7 @@ class NodeVisitor extends NodeVisitorAbstract
     private $isInIf = false;
 
     /**
-     * @var int[][]
-     * @psalm-var array<string, array<string, int>>
+     * @var array<string, array<string, int>>
      */
     private $counts = [
         'functions' => [],
@@ -93,6 +96,8 @@ class NodeVisitor extends NodeVisitorAbstract
 
     /**
      * @param int $symbols Set of symbol types to include stubs for.
+     * @param array<mixed> $config
+     * @return void
      */
     public function init(int $symbols = StubsGenerator::DEFAULT, array $config = [])
     {
@@ -113,6 +118,7 @@ public function init(int $symbols = StubsGenerator::DEFAULT, array $config = [])
     public function beforeTraverse(array $nodes)
     {
         $this->stack = [];
+        return null;
     }
 
     public function enterNode(Node $node)
@@ -121,7 +127,7 @@ public function enterNode(Node $node)
 
         if ($node instanceof Namespace_) {
             // We always need to parse the children of namespaces.
-            return;
+            return null;
         }
 
         if (($this->needsClasses && $node instanceof Class_)
@@ -180,14 +186,15 @@ public function enterNode(Node $node)
                 // We'll examine the first level inside of an if statement to
                 // look for function/class/etc. declarations.
                 $this->isInIf = true;
-                return; // Traverse children.
+                return null; // Traverse children.
             }
         }
 
         if (!$this->isInDeclaration) {
             // Don't bother parsing descendents of uninteresting nodes.
             return NodeTraverser::DONT_TRAVERSE_CHILDREN;
         }
+        return null;
     }
 
     public function leaveNode(Node $node, bool $preserveStack = false)
@@ -231,12 +238,12 @@ public function leaveNode(Node $node, bool $preserveStack = false)
 
         if ($node instanceof Namespace_) {
             $this->namespaces[] = $node;
-            return;
+            return null;
         }
 
         if ($node instanceof Name) {
             // Can't delete namespace names!
-            return;
+            return null;
         }
 
         if ($parent && !($parent instanceof Namespace_)) {
@@ -250,7 +257,7 @@ public function leaveNode(Node $node, bool $preserveStack = false)
                 }
             }
 
-            return;
+            return null;
         }
 
         $namespaceName = ($parent && $parent->name) ? $parent->name->toString() : '';
@@ -265,7 +272,7 @@ public function leaveNode(Node $node, bool $preserveStack = false)
             } elseif ($parent) {
                 // If we're here, `$parent` is a namespace.  Let's just keep the
                 // `$node` around in `$parent->stmts`.
-                return; // Don't remove.
+                return null; // Don't remove.
             } elseif ($node instanceof Stmt) {
                 // Anything other than a namespace which doesn't have a parent
                 // node must belong in the global namespace. We can still remove
@@ -290,12 +297,13 @@ public function afterTraverse(array $nodes)
         $this->namespaces = array_filter($this->namespaces, function (Namespace_ $ns): bool {
             return (bool) $ns->stmts;
         });
+        return null;
     }
 
     /**
      * Returns the stored set of stub nodes which are built up during traversal.
      *
-     * @return Node[]
+     * @return array<Node>
      */
     public function getStubStmts(): array
     {
@@ -325,7 +333,7 @@ public function getStubStmts(): array
      *
      * These counts are built up during traversal.
      *
-     * @psalm-return array<string, array<string, int>>
+     * @return array<string, array<string, int>>
      */
     public function getCounts(): array
     {
@@ -394,7 +402,9 @@ function (\PhpParser\Node\Const_ $const) {
                 $node instanceof Expression &&
                 $node->expr instanceof FuncCall &&
                 $node->expr->name instanceof Name &&
-                $node->expr->name->getFirst() === 'define'
+                $node->expr->name->getFirst() === 'define' &&
+                $node->expr->args[0] instanceof Arg &&
+                $node->expr->args[0]->value instanceof String_
             ) {
                 $fullyQualifiedName = $node->expr->args[0]->value->value;
 

src/Result.php

@@ -10,23 +10,23 @@
 /**
  * Contains the results of stub generation, including the stubs themselves as
  * well as some metadata.
+ *
+ * @implements IteratorAggregate<int, \PhpParser\Node>
  */
 class Result implements IteratorAggregate
 {
     /** @var NodeVisitor */
     private $visitor;
 
     /**
-     * @var \Exception[]
-     * @psalm-var array<string, \Exception>
+     * @var array<string, \Exception>
      */
     private $unparsed;
 
     /**
      * @param NodeVisitor $visitor The visitor which was used to generate stubs.
-     * @param \Exception[] $unparsed A map of file path => reason for any
-     *                               unparsed files.
-     * @psalm-param $unparsed array<string, \Exception>
+     * @param array<string, \Exception> $unparsed A map of file path => reason
+     *                                            for any unparsed files.
      */
     public function __construct(NodeVisitor $visitor, array $unparsed)
     {
@@ -43,7 +43,7 @@ public function getIterator(): Traversable
      * Returns the list of stub statements, which can be pretty-printed or
      * operated on further.
      *
-     * @return \PhpParser\Node[]
+     * @return array<\PhpParser\Node>
      */
     public function getStubStmts(): array
     {
@@ -54,12 +54,7 @@ public function getStubStmts(): array
      * Returns a map of symbol type to count of unique symbols of that type
      * which are included in the stubs.
      *
-     * Psalm doesn't seem to parse this correctly.
-     * @psalm-suppress InvalidReturnType
-     * @psalm-suppress InvalidReturnStatement
-     *
-     * @return int[]
-     * @psalm-return array<string, int>
+     * @return array<string, int>
      */
     public function getStats(): array
     {
@@ -70,8 +65,7 @@ public function getStats(): array
      * Returns a list which includes any symbols for which more than one
      * declaration was found during stub generation.
      *
-     * @return (string|int)[][]
-     * @psalm-return array<array{ type: string, name: string, count: int }>
+     * @return array<array{type: string, name: string, count: int}>
      */
     public function getDuplicates(): array
     {

src/StubsGenerator.php

@@ -89,11 +89,12 @@ class StubsGenerator
 
     /** @var int */
     private $symbols;
-    /** @var array */
+    /** @var array<mixed> */
     private $config;
 
     /**
      * @param int $symbols Bitmask of symbol types to include in the stubs.
+     * @param array<mixed> $config
      */
     public function __construct(int $symbols = self::DEFAULT, array $config = [])
     {

test/console-loader.php

@@ -0,0 +1,19 @@
+<?php
+
+foreach ([__DIR__ . '/../../../autoload.php', __DIR__ . '/../vendor/autoload.php'] as $file) {
+    if (file_exists($file)) {
+        require $file;
+        break;
+    }
+}
+
+use StubsGenerator\GenerateStubsCommand;
+use Symfony\Component\Console\Application;
+
+$command = new GenerateStubsCommand();
+$application = new Application();
+$application->add($command);
+$application->setDefaultCommand($command->getName(), true);
+
+// Return the application for PHPStan (don't run it)
+return $application;