Introduce PHPStan + improve DocBlocks (#768)

Author: pascalbaljet

.gitattributes

@@ -11,3 +11,4 @@
 /tests export-ignore
 /CHANGELOG.md export-ignore
 /README.md export-ignore
+/phpstan.neon export-ignore

.github/workflows/facade.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.1
+          php-version: 8.2
           tools: composer:v2
           coverage: none
 

.github/workflows/static-analysis.yml

@@ -0,0 +1,14 @@
+name: static analysis
+
+on:
+  push:
+    branches:
+      - "2.x"
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    uses: laravel/.github/.github/workflows/static-analysis.yml@main

.github/workflows/tests.yml

@@ -37,6 +37,10 @@ jobs:
           tools: composer:v2
           coverage: none
 
+      - name: Remove PHPStan on PHP 8.1 and Laravel 10
+        run: composer remove --dev larastan/larastan
+        if: matrix.php == 8.1 || matrix.laravel == 10
+
       - name: Set Minimum PHP 8.1 Versions
         uses: nick-fields/retry@v3
         with:

composer.json

@@ -39,7 +39,8 @@
         "orchestra/testbench": "^8.0|^9.2|^10.0",
         "mockery/mockery": "^1.3.3",
         "phpunit/phpunit": "^10.4|^11.5",
-        "laravel/pint": "^1.16"
+        "laravel/pint": "^1.16",
+        "larastan/larastan": "^3.0"
     },
     "suggest": {
         "ext-pcntl": "Recommended when running the Inertia SSR server via the `inertia:start-ssr` artisan command."
@@ -53,4 +54,4 @@
     },
     "minimum-stability": "dev",
     "prefer-stable": true
-}
+}

phpstan.neon

@@ -0,0 +1,17 @@
+includes:
+	- vendor/larastan/larastan/extension.neon
+
+parameters:
+	level: 6
+	paths:
+		- src
+		- tests
+	excludePaths:
+		- src/Testing/Concerns
+	ignoreErrors:
+		- '#Call to an undefined method.*TestResponse.*::assertInertia\(\)#'
+		- '#Call to an undefined method.*TestResponse.*::inertiaPage\(\)#'
+		- '#Call to an undefined method.*TestResponse.*::inertiaProps\(\)#'
+		- '#Call to an undefined.*method.*Request::inertia\(\)#'
+		- '#Call to an undefined.*method.*Route::inertia\(\)#'
+

src/AlwaysProp.php

@@ -6,17 +6,32 @@
 
 class AlwaysProp
 {
-    /** @var mixed */
+    /**
+     * The property value.
+     *
+     * Always included in Inertia responses, bypassing partial reload filtering.
+     *
+     * @var mixed
+     */
     protected $value;
 
     /**
+     * Create a new always property instance. Always properties are included
+     * in every Inertia response, even during partial reloads when only
+     * specific props are requested.
+     *
      * @param  mixed  $value
      */
     public function __construct($value)
     {
         $this->value = $value;
     }
 
+    /**
+     * Resolve the property value.
+     *
+     * @return mixed
+     */
     public function __invoke()
     {
         return is_callable($this->value) ? App::call($this->value) : $this->value;

src/Commands/CheckSsr.php

@@ -25,7 +25,7 @@ class CheckSsr extends Command
     protected $description = 'Check the Inertia SSR server health status';
 
     /**
-     * check the SSR server via a Node process.
+     * Check the Inertia SSR server health status.
      */
     public function handle(Gateway $gateway): int
     {

src/Commands/CreateMiddleware.php

@@ -50,6 +50,8 @@ protected function getDefaultNamespace($rootNamespace): string
 
     /**
      * Get the console command arguments.
+     *
+     * @return array<int, array<int, mixed>>
      */
     protected function getArguments(): array
     {
@@ -60,6 +62,8 @@ protected function getArguments(): array
 
     /**
      * Get the console command options.
+     *
+     * @return array<int, array<int, mixed>>
      */
     protected function getOptions(): array
     {

src/Commands/StartSsr.php

@@ -26,7 +26,7 @@ class StartSsr extends Command
     protected $description = 'Start the Inertia SSR server';
 
     /**
-     * Start the SSR server via a Node process.
+     * Start the Inertia SSR server.
      */
     public function handle(): int
     {