add phpstan settings.

Author: smeghead

phpstan.neon

@@ -0,0 +1,4 @@
+parameters:
+	level: max
+	paths:
+		- src

src/Analyze/FunctionScope.php

@@ -6,8 +6,12 @@
 
 final class FunctionScope implements Scope
 {
+    /** @var list<AnalyzedVariable> */
     private array $analyzedVariables;
 
+    /**
+     * @param list<AnalyzedVariable> $analyzedVariables
+     */
     public function __construct(private string $name, array $analyzedVariables)
     {
         $this->analyzedVariables = $analyzedVariables;
@@ -19,7 +23,7 @@ public function getName(): string
     }
 
     /**
-     * @return list<AlalyzedVariable>
+     * @return list<AnalyzedVariable>
      */
     public function getAnalyzedVariables(): array
     {

src/Analyze/VariableAnalyzer.php

@@ -5,13 +5,17 @@
 namespace Smeghead\PhpVariableHardUsage\Analyze;
 
 use Smeghead\PhpVariableHardUsage\Parse\Func;
+use Smeghead\PhpVariableHardUsage\Parse\VarReference;
 
 final class VariableAnalyzer
 {
+    /**
+     * @var list<Func>
+     */
     private array $functions;
 
     /**
-     * @param array<Func> $functions
+     * @param list<Func> $functions
      */
     public function __construct(array $functions)
     {
@@ -39,6 +43,9 @@ private function analyzeFunction(Func $function): Scope
         return new FunctionScope($function->name, $analyzedVars);
     }
 
+    /**
+     * @param list<VarReference> $vars
+     */
     private function calcVariableHardUsage(array $vars): int
     {
         $lineNumbers = array_map(fn($var) => $var->lineNumber, $vars);

src/Command.php

@@ -5,11 +5,13 @@
 namespace Smeghead\PhpVariableHardUsage;
 
 use Smeghead\PhpVariableHardUsage\Analyze\VariableAnalyzer;
-use Smeghead\PhpVariableHardUsage\Core\Analyzer;
 use Smeghead\PhpVariableHardUsage\Parse\VariableParser;
 
 final class Command
 {
+    /**
+     * @param list<string> $argv
+     */
     public function run(array $argv): void
     {
         if (count($argv) < 2) {
@@ -24,7 +26,12 @@ public function run(array $argv): void
         }
 
         $parser = new VariableParser();
-        $parseResult = $parser->parse(file_get_contents($filePath));
+        $content =file_get_contents($filePath);
+        if ($content === false) {
+            echo "Failed to read file: $filePath\n";
+            return;
+        }
+        $parseResult = $parser->parse($content);
         $analyzer = new VariableAnalyzer($parseResult->functions);
         $result = $analyzer->analyze();
         echo $result->format();

src/Parse/Exception/ParseFailedException.php

@@ -8,8 +8,8 @@
 
 final class ParseFailedException extends Exception
 {
-    public function __construct($message = "Parsing failed", $code = 0, Exception $previous = null)
+    public function __construct(string $message = "Parsing failed", int $code = 0)
     {
-        parent::__construct($message, $code, $previous);
+        parent::__construct($message, $code);
     }
 }

src/Parse/Func.php

@@ -15,7 +15,7 @@ public function __construct(public readonly string $name)
     }
 
     /**
-     * @param array<VarReference> $variables
+     * @return array<VarReference>
      */
     public function getVariables(): array
     {

src/Parse/VariableParser.php

@@ -7,6 +7,7 @@
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Stmt;
 use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\Function_;
 use PhpParser\NodeDumper;
 use PhpParser\NodeVisitor\FindingVisitor;
@@ -24,7 +25,7 @@ public function __construct()
 
     /**
      * @param list<Stmt> $stmt
-     * @return List<Function_>
+     * @return list<Function_>
      */
     private function getFunctions(array $stmt): array
     {
@@ -35,7 +36,7 @@ private function getFunctions(array $stmt): array
         $traverser->addVisitor($functionVisitor);
         $traverser->traverse($stmt);
 
-        return $functionVisitor->getFoundNodes();
+        return $functionVisitor->getFoundNodes(); // @phpstan-ignore-line
     }
 
     /**
@@ -51,7 +52,7 @@ private function getVariables(Function_|ClassMethod $function): array
         $traverser->addVisitor($variableVisitor);
         $traverser->traverse([$function]);
 
-        return $variableVisitor->getFoundNodes();
+        return $variableVisitor->getFoundNodes(); // @phpstan-ignore-line
     }
 
     /**
@@ -67,7 +68,7 @@ private function parseFunctions(array $stmts): array
             $variables = $this->getVariables($foundFunction);
             $func = new Func($foundFunction->name->name);
             foreach ($variables as $variable) {
-                $func->addVariable(new VarReference($variable->name, $variable->getLine()));
+                $func->addVariable(new VarReference($variable->name, $variable->getLine())); // @phpstan-ignore-line
             }
             $functions[] = $func;
         }
@@ -76,7 +77,7 @@ private function parseFunctions(array $stmts): array
 
     /**
      * @param list<Stmt> $stmt
-     * @return List<Class_>
+     * @return list<Class_>
      */
     private function getClasses(array $stmt): array
     {
@@ -87,7 +88,7 @@ private function getClasses(array $stmt): array
         $traverser->addVisitor($classVisitor);
         $traverser->traverse($stmt);
 
-        return $classVisitor->getFoundNodes();
+        return $classVisitor->getFoundNodes(); // @phpstan-ignore-line
     }
 
     /**
@@ -104,7 +105,7 @@ private function parseClasses(array $stmts): array
                 $variables = $this->getVariables($method);
                 $func = new Func(sprintf('%s::%s', $foundClass->name, $method->name->name));
                 foreach ($variables as $variable) {
-                    $func->addVariable(new VarReference($variable->name, $variable->getLine()));
+                    $func->addVariable(new VarReference($variable->name, $variable->getLine())); // @phpstan-ignore-line
                 }
                 $methods[] = $func;
             }