Add Larastan and level 6 static analysis

Author: aarondfrancis

.github/workflows/tests.yml

@@ -55,3 +55,31 @@ jobs:
           LINES: 32
           COLUMNS: 180
         run: vendor/bin/phpunit
+
+  analyse:
+    runs-on: ubuntu-latest
+
+    name: Static Analysis
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6.0.2
+
+      - name: Cache dependencies
+        uses: actions/cache@v5.0.3
+        with:
+          path: ~/.composer/cache/files
+          key: analysis-php-8.4-composer-${{ hashFiles('composer.json') }}
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@2.37.0
+        with:
+          php-version: "8.4"
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick
+          coverage: none
+
+      - name: Install dependencies
+        run: composer update --prefer-dist --prefer-stable --no-interaction
+
+      - name: Run static analysis
+        run: composer analyse

composer.json

@@ -31,7 +31,9 @@
         "phpunit/phpunit": "^10.5|^11|^12.5",
         "orchestra/testbench": "^8.29|^9.5|^10|^11.0",
         "laravel/serializable-closure": "^1.3|^2.0",
-        "mockery/mockery": "1.6.12"
+        "mockery/mockery": "1.6.12",
+        "larastan/larastan": "^3.9.3@stable",
+        "phpstan/phpstan": "^2.1.32@stable"
     },
     "autoload": {
         "psr-4": {
@@ -62,6 +64,7 @@
             "Composer\\Config::disableProcessTimeout",
             "@php vendor/bin/testbench serve --ansi"
         ],
+        "analyse": "@php vendor/bin/phpstan analyse --memory-limit=1G",
         "dev": [
             "@php vendor/bin/testbench solo"
         ]

phpstan.neon.dist

@@ -0,0 +1,11 @@
+includes:
+    - vendor/larastan/larastan/extension.neon
+
+parameters:
+    level: 6
+    paths:
+        - src
+        - tests
+        - workbench/app
+        - workbench/routes
+    tmpDir: build/phpstan

src/Commands/Command.php

@@ -21,6 +21,7 @@
 use SoloTerm\Solo\Support\KeyPressListener;
 use SplQueue;
 
+/** @phpstan-consistent-constructor */
 class Command implements Loopable
 {
     use ManagesProcess, Ticks;
@@ -43,6 +44,7 @@ class Command implements Loopable
 
     public int $scrollIndex = 0;
 
+    /** @var SplQueue<string> */
     public SplQueue $lines;
 
     public int $height = 0;
@@ -108,6 +110,9 @@ public function boot(): void
         //
     }
 
+    /**
+     * @return array<int|string, Hotkey>
+     */
     public function allHotkeys(): array
     {
         // In interactive mode, the only hotkey that works is
@@ -125,7 +130,7 @@ public function allHotkeys(): array
             $hotkeys['interactive'] = Hotkey::make('i', KeyHandler::Interactive)->label('Enter interactive mode');
         }
 
-        return array_filter($hotkeys);
+        return $hotkeys;
     }
 
     /**
@@ -138,7 +143,7 @@ public function hotkeys(): array
         ];
     }
 
-    public function setDimensions($width, $height): static
+    public function setDimensions(int $width, int $height): static
     {
         $existingOutput = isset($this->screen) ? $this->renderScreenBuffer() : null;
 
@@ -228,12 +233,12 @@ public function isInteractive(): bool
     | Actions
     |--------------------------------------------------------------------------
     */
-    public function dd()
+    public function dd(): never
     {
         dd($this->screen->printable->buffer);
     }
 
-    public function addOutput($text)
+    public function addOutput(string $text): void
     {
         if ($this->expectsOutputMarkers) {
             $text = Str::before($text, $this->outputEndMarker);
@@ -243,7 +248,7 @@ public function addOutput($text)
         $this->screen->write($text);
     }
 
-    public function addLine($line)
+    public function addLine(string $line): void
     {
         $this->screen->writeln($line);
     }
@@ -301,15 +306,15 @@ public function catchUpScroll(): void
         }
     }
 
-    public function scrollTo($index): void
+    public function scrollTo(int|float $index): void
     {
         $this->scrollIndex = max(0, min(
             $index,
             $this->wrappedLines()->count() - $this->scrollPaneHeight()
         ));
     }
 
-    public function scrollDown($amount = 1): void
+    public function scrollDown(int|float $amount = 1): void
     {
         $this->paused = true;
         $this->scrollTo($this->scrollIndex + $amount);
@@ -320,18 +325,18 @@ public function scrollToBottom(): void
         $this->scrollDown(INF);
     }
 
-    public function pageDown()
+    public function pageDown(): void
     {
         $this->scrollDown($this->scrollPaneHeight() - 1);
     }
 
-    public function scrollUp($amount = 1): void
+    public function scrollUp(int|float $amount = 1): void
     {
         $this->paused = true;
         $this->scrollTo($this->scrollIndex - $amount);
     }
 
-    public function pageUp()
+    public function pageUp(): void
     {
         $this->scrollUp($this->scrollPaneHeight() - 1);
     }
@@ -361,6 +366,9 @@ public function scrollPaneWidth(): int
         return max(1, $this->width - 4);
     }
 
+    /**
+     * @return Collection<int, string>
+     */
     public function wrappedLines(): Collection
     {
         // Check if the screen has changed since last render
@@ -409,7 +417,7 @@ protected function renderScreenBuffer(): string
         return implode(PHP_EOL, $lines);
     }
 
-    protected function makeNewScreen()
+    protected function makeNewScreen(): Screen
     {
         $screen = new Screen(
             width: $this->scrollPaneWidth(),
@@ -421,7 +429,10 @@ protected function makeNewScreen()
         });
     }
 
-    public function wrapLine($line, $width = null, $continuationIndent = 0, $recursive = false): array
+    /**
+     * @return array<int, string>
+     */
+    public function wrapLine(string $line, ?int $width = null, int $continuationIndent = 0, bool $recursive = false): array
     {
         $defaultWidth = $this->scrollPaneWidth();
 
@@ -446,15 +457,13 @@ public function wrapLine($line, $width = null, $continuationIndent = 0, $recursi
         $first = array_shift($exploded);
         $indent = str_repeat(' ', $continuationIndent);
 
-        if ($continuationIndent) {
-            $allIndented = true;
-            foreach ($exploded as $continuationLine) {
-                $allIndented = $allIndented && str_starts_with($continuationLine, $indent);
-            }
+        $allIndented = true;
+        foreach ($exploded as $continuationLine) {
+            $allIndented = $allIndented && str_starts_with($continuationLine, $indent);
+        }
 
-            if ($allIndented) {
-                return [$first, ...$exploded];
-            }
+        if ($allIndented) {
+            return [$first, ...$exploded];
         }
 
         $rest = $indent . ltrim(implode('', $exploded));
@@ -465,13 +474,20 @@ public function wrapLine($line, $width = null, $continuationIndent = 0, $recursi
         ];
     }
 
+    /**
+     * @param  Collection<int, string>  $lines
+     * @return Collection<int, string>
+     */
     protected function modifyWrappedLines(Collection $lines): Collection
     {
         // Primarily here for any subclasses.
         return $lines;
     }
 
-    public static function __set_state(array $data)
+    /**
+     * @param  array<string, mixed>  $data
+     */
+    public static function __set_state(array $data): static
     {
         $instance = new static;