Merge pull request #78 from swinn-io/chore/php-linting-formatting

build: modern PHP linting & formatting (Pint + Larastan)

Author: ikidnapmyself

.github/workflows/ci.yml

@@ -5,6 +5,28 @@ on:
   pull_request:
 
 jobs:
+  quality:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP 8.3
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.3'
+          extensions: mbstring, pdo, pdo_mysql, xml, curl
+          coverage: none
+
+      - name: Install Dependencies
+        run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
+
+      - name: Check formatting (Pint)
+        run: vendor/bin/pint --test
+
+      - name: Static analysis (Larastan)
+        run: vendor/bin/phpstan analyse --no-progress --memory-limit=1G
+
   tests:
     runs-on: ubuntu-latest
 

.gitignore

@@ -19,6 +19,7 @@ yarn-error.log
 
 # Premature design briefs — kept locally, not part of the repo
 /docs/SWINN_DESIGN*.md
+/storage/phpstan
 
 # Laravel Boost — regenerated per-developer via `php artisan boost:install`/`boost:update`
 /.claude

.styleci.yml

@@ -10,7 +10,7 @@ class Kernel extends ConsoleKernel
     /**
      * The Artisan commands provided by your application.
      *
-     * @var array
+     * @var array<int, class-string>
      */
     protected $commands = [
         //
@@ -19,7 +19,6 @@ class Kernel extends ConsoleKernel
     /**
      * Define the application's command schedule.
      *
-     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
      * @return void
      */
     protected function schedule(Schedule $schedule)

app/Console/Kernel.php

@@ -3,14 +3,16 @@
 namespace App\Exceptions;
 
 use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
+use Illuminate\Http\Request;
+use Symfony\Component\HttpFoundation\Response;
 use Throwable;
 
 class Handler extends ExceptionHandler
 {
     /**
      * A list of the exception types that are not reported.
      *
-     * @var array
+     * @var array<int, class-string<Throwable>>
      */
     protected $dontReport = [
         //
@@ -19,7 +21,7 @@ class Handler extends ExceptionHandler
     /**
      * A list of the inputs that are never flashed for validation exceptions.
      *
-     * @var array
+     * @var array<int, string>
      */
     protected $dontFlash = [
         'password',
@@ -29,7 +31,6 @@ class Handler extends ExceptionHandler
     /**
      * Report or log an exception.
      *
-     * @param  \Throwable  $exception
      * @return void
      *
      * @throws \Exception
@@ -42,11 +43,10 @@ public function report(Throwable $exception)
     /**
      * Render an exception into an HTTP response.
      *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  \Throwable  $exception
-     * @return \Symfony\Component\HttpFoundation\Response
+     * @param  Request  $request
+     * @return Response
      *
-     * @throws \Throwable
+     * @throws Throwable
      */
     public function render($request, Throwable $exception)
     {

app/Exceptions/Handler.php

@@ -11,4 +11,4 @@ public function __construct(array $descriptor)
     {
         parent::__construct(response()->json($descriptor, 422));
     }
-}
+}

app/Exceptions/InvalidEnvelopeException.php

@@ -2,30 +2,25 @@
 
 namespace App\Http\Controllers;
 
-use App\Http\Requests\ContactStoreRequest;
 use App\Http\Resources\ContactResource;
 use App\Interfaces\ContactServiceInterface;
 use App\Interfaces\UserServiceInterface;
+use App\Models\User;
+use Illuminate\Contracts\Foundation\Application;
+use Illuminate\Http\RedirectResponse;
 use Illuminate\Http\Request;
+use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
+use Illuminate\Routing\Redirector;
 use Illuminate\Support\Facades\Auth;
 
 class ContactController extends Controller
 {
-    /**
-     * @var ContactServiceInterface
-     */
     private ContactServiceInterface $service;
 
-    /**
-     * @var UserServiceInterface
-     */
     private UserServiceInterface $userService;
 
     /**
      * ContactController constructor.
-     *
-     * @param  ContactServiceInterface  $service
-     * @param  UserServiceInterface  $userService
      */
     public function __construct(ContactServiceInterface $service, UserServiceInterface $userService)
     {
@@ -36,11 +31,11 @@ public function __construct(ContactServiceInterface $service, UserServiceInterfa
     /**
      * Returns user by id.
      *
-     * @param  string  $id
      * @return ContactResource
      */
     public function show(string $id)
     {
+        /** @var User $user */
         $user = Auth::user();
 
         return new ContactResource(
@@ -51,23 +46,22 @@ public function show(string $id)
     /**
      * Returns contacts by user.
      *
-     * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection
+     * @return AnonymousResourceCollection
      */
     public function index()
     {
+        /** @var User $user */
         $user = Auth::user();
 
         return ContactResource::collection($this->service->contacts($user));
     }
 
     /**
      * Store a contact.
-     *
-     * @param  string  $user_id
-     * @return ContactResource
      */
     public function store(string $user_id): ContactResource
     {
+        /** @var User $user */
         $user = Auth::user();
         $contact = $this->userService->find($user_id);
 
@@ -79,21 +73,20 @@ public function store(string $user_id): ContactResource
     /**
      * Redirects to URI.
      *
-     * @param  Request  $request
-     * @param  string  $id
-     * @return \Illuminate\Contracts\Foundation\Application|\Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
+     * @return Application|RedirectResponse|Redirector
      */
     public function redirect(Request $request, string $id)
     {
+        /** @var User $user */
         $user = Auth::user();
         $contact = $this->service->contact($id, $user);
 
-        if (null === $contact) {
+        if ($contact === null) {
             abort(404);
         }
 
         $URI = $request->get('redirect_uri', config('app.uri'));
 
-        return redirect($URI ?? '/');
+        return redirect(is_string($URI) ? $URI : '/');
     }
 }

app/Http/Controllers/ContactController.php

@@ -4,19 +4,23 @@
 
 use App\Http\Controllers\Controller;
 use App\Interfaces\MessageServiceInterface;
+use App\Models\User;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Auth;
+use Illuminate\View\View;
+
 use function view;
 
 class DashboardController extends Controller
 {
     /**
      * Display a listing of the resource.
      *
-     * @return \Illuminate\Http\Response
+     * @return View
      */
     public function index(MessageServiceInterface $messages)
     {
+        /** @var User $user */
         $user = Auth::user();
         $threads = $messages->threads($user);
 
@@ -26,7 +30,7 @@ public function index(MessageServiceInterface $messages)
                 'subject' => $thread->subject,
                 'unread_count' => 0,
                 'participants' => $thread->participants
-                    ->map(fn ($participant) => ['user' => ['name' => $participant->user->name]])
+                    ->map(fn ($participant) => ['user' => ['name' => $participant->user?->name]])
                     ->values()
                     ->all(),
             ])->values()->all(),
@@ -36,7 +40,7 @@ public function index(MessageServiceInterface $messages)
     /**
      * Show the form for creating a new resource.
      *
-     * @return \Illuminate\Http\Response
+     * @return void
      */
     public function create()
     {
@@ -46,8 +50,7 @@ public function create()
     /**
      * Store a newly created resource in storage.
      *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return void
      */
     public function store(Request $request)
     {
@@ -58,7 +61,7 @@ public function store(Request $request)
      * Display the specified resource.
      *
      * @param  int  $id
-     * @return \Illuminate\Http\Response
+     * @return void
      */
     public function show($id)
     {
@@ -69,7 +72,7 @@ public function show($id)
      * Show the form for editing the specified resource.
      *
      * @param  int  $id
-     * @return \Illuminate\Http\Response
+     * @return void
      */
     public function edit($id)
     {
@@ -79,9 +82,8 @@ public function edit($id)
     /**
      * Update the specified resource in storage.
      *
-     * @param  \Illuminate\Http\Request  $request
      * @param  int  $id
-     * @return \Illuminate\Http\Response
+     * @return void
      */
     public function update(Request $request, $id)
     {
@@ -92,7 +94,7 @@ public function update(Request $request, $id)
      * Remove the specified resource from storage.
      *
      * @param  int  $id
-     * @return \Illuminate\Http\Response
+     * @return void
      */
     public function destroy($id)
     {

app/Http/Controllers/FrontEnd/DashboardController.php

@@ -4,13 +4,14 @@
 
 use App\Http\Controllers\Controller;
 use Illuminate\Http\Request;
+use Illuminate\View\View;
 
 class PageController extends Controller
 {
     /**
      * Display a listing of the resource.
      *
-     * @return \Illuminate\Http\Response
+     * @return View
      */
     public function index()
     {
@@ -20,7 +21,7 @@ public function index()
     /**
      * Show the form for creating a new resource.
      *
-     * @return \Illuminate\Http\Response
+     * @return void
      */
     public function create()
     {
@@ -30,8 +31,7 @@ public function create()
     /**
      * Store a newly created resource in storage.
      *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return void
      */
     public function store(Request $request)
     {
@@ -42,7 +42,7 @@ public function store(Request $request)
      * Display the specified resource.
      *
      * @param  int  $id
-     * @return \Illuminate\Http\Response
+     * @return void
      */
     public function show($id)
     {
@@ -53,7 +53,7 @@ public function show($id)
      * Show the form for editing the specified resource.
      *
      * @param  int  $id
-     * @return \Illuminate\Http\Response
+     * @return void
      */
     public function edit($id)
     {
@@ -63,9 +63,8 @@ public function edit($id)
     /**
      * Update the specified resource in storage.
      *
-     * @param  \Illuminate\Http\Request  $request
      * @param  int  $id
-     * @return \Illuminate\Http\Response
+     * @return void
      */
     public function update(Request $request, $id)
     {
@@ -76,7 +75,7 @@ public function update(Request $request, $id)
      * Remove the specified resource from storage.
      *
      * @param  int  $id
-     * @return \Illuminate\Http\Response
+     * @return void
      */
     public function destroy($id)
     {