Add workflow job for phpstan (#70)

Boy132 · web-flow · commit c2ca0f66f6f7 · 2026-01-01T17:01:56.000+01:00
* add workflow job for phpstan

* use custom phpstan.neon

* fix name

* add ignoreErrors

* fix some errors

* fix remaining errors

* small cleanup
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,74 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  pint:
+    name: Pint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.4
+          tools: composer:v2
+          coverage: none
+
+      - name: Init composer
+        run: composer init --no-interaction
+
+      - name: Install Laravel Pint
+        run: composer require "laravel/pint:^1.15.3"
+
+      - name: Run Pint
+        run: vendor/bin/pint --test
+  phpstan:
+    name: PHPStan
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Clone Pelican Panel
+        run: git clone --depth=1 https://github.com/pelican-dev/panel pelican
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.4
+          tools: composer:v2
+          coverage: none
+
+      - name: Install panel dependencies
+        run: |
+          cd pelican
+          composer install --no-interaction --no-suggest --no-progress --no-scripts
+
+      - name: Install plugin dependencies
+        run: |
+          cd pelican
+          composer require "stripe/stripe-php:^18.0" "kovah/laravel-socialite-oidc:^0.5" "krymosoftware/gameq:^4.0"
+
+      - name: Setup .env file
+        run: cp pelican/.env.example pelican/.env
+
+      - name: Move plugin folders and phpstan.neon
+        run: |
+          mkdir -p pelican/plugins
+          rsync -av --progress ./ pelican/plugins/ --exclude=pelican
+          cp phpstan.neon pelican/phpstan.neon
+
+      - name: Run PHPStan Analysis
+        run: |
+          cd pelican
+          vendor/bin/phpstan analyse --memory-limit=-1 --error-format=github
+
diff --git a/.github/workflows/pint.yml b/.github/workflows/pint.yml
diff --git a/billing/src/Filament/App/Widgets/ProductWidget.php b/billing/src/Filament/App/Widgets/ProductWidget.php
@@ -22,7 +22,7 @@ class ProductWidget extends Widget implements HasActions, HasSchemas
     use InteractsWithActions;
     use InteractsWithSchemas;
 
-    protected string $view = 'billing::widget';
+    protected string $view = 'billing::widget'; // @phpstan-ignore property.defaultValue
 
     public ?Product $product = null;
 
diff --git a/billing/src/Models/Coupon.php b/billing/src/Models/Coupon.php
@@ -54,7 +54,7 @@ protected static function boot(): void
         static::deleted(function (self $model) {
             if (!is_null($model->stripe_coupon_id)) {
                 /** @var StripeClient $stripeClient */
-                $stripeClient = app(StripeClient::class); // @phpstan-ignore myCustomRules.forbiddenGlobalFunctions
+                $stripeClient = app(StripeClient::class);
 
                 $stripeClient->coupons->delete($model->stripe_coupon_id);
                 $stripeClient->coupons->delete($model->stripe_promotion_id);
@@ -65,7 +65,7 @@ protected static function boot(): void
     public function sync(): void
     {
         /** @var StripeClient $stripeClient */
-        $stripeClient = app(StripeClient::class); // @phpstan-ignore myCustomRules.forbiddenGlobalFunctions
+        $stripeClient = app(StripeClient::class);
 
         if (is_null($this->stripe_coupon_id)) {
             $data = [
diff --git a/billing/src/Models/Order.php b/billing/src/Models/Order.php
@@ -75,7 +75,7 @@ public function checkExpire(): bool
         if ($this->status === OrderStatus::Active && !is_null($this->expires_at) && now('UTC') >= $this->expires_at) {
             try {
                 if ($this->server) {
-                    app(SuspensionService::class)->handle($this->server, SuspendAction::Suspend); // @phpstan-ignore myCustomRules.forbiddenGlobalFunctions
+                    app(SuspensionService::class)->handle($this->server, SuspendAction::Suspend);
                 }
             } catch (Exception $exception) {
                 report($exception);
@@ -98,7 +98,7 @@ private function expireCheckoutSession(): void
     {
         if (!is_null($this->stripe_checkout_id)) {
             /** @var StripeClient $stripeClient */
-            $stripeClient = app(StripeClient::class); // @phpstan-ignore myCustomRules.forbiddenGlobalFunctions
+            $stripeClient = app(StripeClient::class);
 
             $session = $stripeClient->checkout->sessions->retrieve($this->stripe_checkout_id);
 
@@ -111,7 +111,7 @@ private function expireCheckoutSession(): void
     public function getCheckoutSession(): Session
     {
         /** @var StripeClient $stripeClient */
-        $stripeClient = app(StripeClient::class); // @phpstan-ignore myCustomRules.forbiddenGlobalFunctions
+        $stripeClient = app(StripeClient::class);
 
         if (is_null($this->stripe_checkout_id)) {
             $session = $stripeClient->checkout->sessions->create([
@@ -165,7 +165,7 @@ public function activate(?string $stripePaymentId): void
 
         try {
             if ($this->server) {
-                app(SuspensionService::class)->handle($this->server, SuspendAction::Unsuspend); // @phpstan-ignore myCustomRules.forbiddenGlobalFunctions
+                app(SuspensionService::class)->handle($this->server, SuspendAction::Unsuspend);
             } else {
                 $this->createServer();
             }
@@ -178,7 +178,7 @@ public function close(): void
     {
         try {
             if ($this->server) {
-                app(SuspensionService::class)->handle($this->server, SuspendAction::Suspend); // @phpstan-ignore myCustomRules.forbiddenGlobalFunctions
+                app(SuspensionService::class)->handle($this->server, SuspendAction::Suspend);
             }
         } catch (Exception $exception) {
             report($exception);
@@ -228,7 +228,7 @@ public function createServer(): Server
         $object->setTags($product->tags);
         $object->setPorts($product->ports);
 
-        $server = app(ServerCreationService::class)->handle($data, $object); // @phpstan-ignore myCustomRules.forbiddenGlobalFunctions
+        $server = app(ServerCreationService::class)->handle($data, $object);
 
         $this->update([
             'server_id' => $server->id,
diff --git a/billing/src/Models/Product.php b/billing/src/Models/Product.php
@@ -74,7 +74,7 @@ protected static function boot(): void
         static::deleted(function (self $model) {
             if (!is_null($model->stripe_id)) {
                 /** @var StripeClient $stripeClient */
-                $stripeClient = app(StripeClient::class); // @phpstan-ignore myCustomRules.forbiddenGlobalFunctions
+                $stripeClient = app(StripeClient::class);
 
                 $stripeClient->products->delete($model->stripe_id);
             }
@@ -99,7 +99,7 @@ public function getLabel(): string
     public function sync(): void
     {
         /** @var StripeClient $stripeClient */
-        $stripeClient = app(StripeClient::class); // @phpstan-ignore myCustomRules.forbiddenGlobalFunctions
+        $stripeClient = app(StripeClient::class);
 
         if (is_null($this->stripe_id)) {
             $stripeProduct = $stripeClient->products->create([
diff --git a/billing/src/Models/ProductPrice.php b/billing/src/Models/ProductPrice.php
@@ -65,7 +65,7 @@ public function sync(): void
         $this->product->sync();
 
         /** @var StripeClient $stripeClient */
-        $stripeClient = app(StripeClient::class); // @phpstan-ignore myCustomRules.forbiddenGlobalFunctions
+        $stripeClient = app(StripeClient::class);
 
         if (is_null($this->stripe_id)) {
             $stripePrice = $stripeClient->prices->create([
diff --git a/pastefox-share/src/Filament/Components/Actions/UploadLogsAction.php b/pastefox-share/src/Filament/Components/Actions/UploadLogsAction.php
@@ -74,10 +74,10 @@ protected function setUp(): void
                 }
 
                 $response = Http::withHeaders($headers)
-                    ->post('https://pastefox.com/api/pastes', $payload)
                     ->timeout(30)
                     ->connectTimeout(5)
                     ->throw()
+                    ->post('https://pastefox.com/api/pastes', $payload)
                     ->json();
 
                 if ($response['success']) {
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,13 @@
+includes:
+    - vendor/larastan/larastan/extension.neon
+
+parameters:
+
+    paths:
+        - plugins
+
+    level: 6
+
+    ignoreErrors:
+        - identifier: missingType.generics
+        - identifier: larastan.noEnvCallsOutsideOfConfig
diff --git a/player-counter/database/Seeders/PlayerCounterSeeder.php b/player-counter/database/Seeders/PlayerCounterSeeder.php
@@ -32,6 +32,7 @@ public function run(): void
             }
         }
 
+        // @phpstan-ignore if.alwaysTrue
         if ($this->command) {
             $this->command->info('Created game query types for minecraft and source');
         }
diff --git a/player-counter/src/Filament/Server/Pages/PlayersPage.php b/player-counter/src/Filament/Server/Pages/PlayersPage.php
@@ -40,7 +40,7 @@ public static function canAccess(): bool
         /** @var Server $server */
         $server = Filament::getTenant();
 
-        return parent::canAccess() && $server->allocation && $server->egg->gameQuery()->exists();
+        return parent::canAccess() && $server->allocation && $server->egg->gameQuery()->exists(); // @phpstan-ignore method.notFound
     }
 
     public static function getNavigationLabel(): string
@@ -72,7 +72,7 @@ public function table(Table $table): Table
         $server = Filament::getTenant();
 
         /** @var ?GameQuery $gameQuery */
-        $gameQuery = $server->egg->gameQuery;
+        $gameQuery = $server->egg->gameQuery; // @phpstan-ignore property.notFound
 
         $isMinecraft = $gameQuery?->query_type->isMinecraft();
 
@@ -105,7 +105,7 @@ public function table(Table $table): Table
                 $players = [];
 
                 /** @var ?GameQuery $gameQuery */
-                $gameQuery = $server->egg->gameQuery;
+                $gameQuery = $server->egg->gameQuery; // @phpstan-ignore property.notFound
 
                 if ($gameQuery) {
                     $data = $gameQuery->runQuery($server->allocation);
diff --git a/player-counter/src/Filament/Server/Widgets/ServerPlayerWidget.php b/player-counter/src/Filament/Server/Widgets/ServerPlayerWidget.php
@@ -17,7 +17,7 @@ public static function canView(): bool
         /** @var Server $server */
         $server = Filament::getTenant();
 
-        return !$server->isInConflictState() && $server->allocation && $server->egg->gameQuery()->exists() && !$server->retrieveStatus()->isOffline();
+        return !$server->isInConflictState() && $server->allocation && $server->egg->gameQuery()->exists() && !$server->retrieveStatus()->isOffline(); // @phpstan-ignore method.notFound
     }
 
     protected function getStats(): array
@@ -26,7 +26,7 @@ protected function getStats(): array
         $server = Filament::getTenant();
 
         /** @var ?GameQuery $gameQuery */
-        $gameQuery = $server->egg->gameQuery;
+        $gameQuery = $server->egg->gameQuery; // @phpstan-ignore property.notFound
 
         if (!$gameQuery) {
             return [];
diff --git a/subdomains/src/Filament/Server/Resources/Subdomains/SubdomainResource.php b/subdomains/src/Filament/Server/Resources/Subdomains/SubdomainResource.php
@@ -60,7 +60,7 @@ protected static function getBadgeCount(): int
         /** @var Server $server */
         $server = Filament::getTenant();
 
-        return $server->subdomains->count();
+        return $server->subdomains->count(); // @phpstan-ignore property.notFound
     }
 
     protected static function getBadgeLimit(): int
diff --git a/subdomains/src/Models/CloudflareDomain.php b/subdomains/src/Models/CloudflareDomain.php
@@ -34,6 +34,7 @@ public function subdomains(): HasMany
 
     public function fetchCloudflareId(): void
     {
+        // @phpstan-ignore staticMethod.notFound
         $response = Http::cloudflare()->get('zones', [
             'name' => $this->name,
         ])->json();
diff --git a/subdomains/src/Models/Subdomain.php b/subdomains/src/Models/Subdomain.php
@@ -68,6 +68,7 @@ protected function createOnCloudflare(): void
         }
 
         if (!$this->cloudflare_id) {
+            // @phpstan-ignore staticMethod.notFound
             $response = Http::cloudflare()->post("zones/{$this->domain->cloudflare_id}/dns_records", [
                 'name' => $this->name,
                 'ttl' => 120,
@@ -94,6 +95,7 @@ protected function updateOnCloudflare(): void
         }
 
         if ($this->cloudflare_id) {
+            // @phpstan-ignore staticMethod.notFound
             Http::cloudflare()->patch("zones/{$this->domain->cloudflare_id}/dns_records/{$this->cloudflare_id}", [
                 'name' => $this->name,
                 'ttl' => 120,
@@ -108,6 +110,7 @@ protected function updateOnCloudflare(): void
     protected function deleteOnCloudflare(): void
     {
         if ($this->cloudflare_id) {
+            // @phpstan-ignore staticMethod.notFound
             Http::cloudflare()->delete("zones/{$this->domain->cloudflare_id}/dns_records/{$this->cloudflare_id}");
         }
     }
diff --git a/user-creatable-servers/src/Filament/Server/Pages/ServerResourcePage.php b/user-creatable-servers/src/Filament/Server/Pages/ServerResourcePage.php
@@ -163,7 +163,7 @@ public function save(): void
 
         try {
             /** @var DaemonServerRepository $repository */
-            $repository = app(DaemonServerRepository::class); // @phpstan-ignore-line
+            $repository = app(DaemonServerRepository::class);
 
             $repository->setServer($server)->sync();
 
diff --git a/user-creatable-servers/src/Models/UserResourceLimits.php b/user-creatable-servers/src/Models/UserResourceLimits.php
@@ -148,7 +148,7 @@ public function createServer(string $name, int|Egg $egg, int $cpu, int $memory,
             $object->setPorts(array_filter(explode(',', config('user-creatable-servers.deployment_ports'))));
 
             /** @var ServerCreationService $service */
-            $service = app(ServerCreationService::class); // @phpstan-ignore-line
+            $service = app(ServerCreationService::class);
 
             return $service->handle($data, $object);
         }

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ public function run(): void`
`32`	`32`	`}`
`33`	`33`	`}`
`34`	`34`
	`35`	`+ // @phpstan-ignore if.alwaysTrue`
`35`	`36`	`if ($this->command) {`
`36`	`37`	`$this->command->info('Created game query types for minecraft and source');`
`37`	`38`	`}`