feat: enable phpstan on travis

Author: Ark4ne

.travis.yml

@@ -11,6 +11,7 @@ before_script:
   - travis_retry composer install --no-interaction
 
 script:
+  - vendor/bin/phpstan analyze
   - vendor/bin/phpunit --coverage-clover coverage.xml
 
 after_success:

phpstan.neon

@@ -1,5 +1,9 @@
 parameters:
     paths:
         - src
+        - tests/app
+    excludePaths:
+        - tests/app/migrations.php
+        - tests/app/routes.php
     level: 6
     checkGenericClassInNonGenericObjectType: false

tests/app/Http/Controllers/AsApiController.php

@@ -2,20 +2,26 @@
 
 namespace Test\app\Http\Controllers;
 
+use Ark4ne\JsonApi\Resources\JsonApiCollection;
+use Ark4ne\JsonApi\Resources\JsonApiResource;
 use Illuminate\Http\Request;
 
 trait AsApiController
 {
+    /**
+     * @return class-string<\Illuminate\Database\Eloquent\Model>
+     */
     abstract protected function getModelClass(): string;
 
+    /**
+     * @return class-string<\Ark4ne\JsonApi\Resources\JsonApiResource>
+     */
     abstract protected function getResourceClass(): string;
 
     /**
      * Display a listing of the resource.
-     *
-     * @return \Illuminate\Http\Response
      */
-    public function index(Request $request)
+    public function index(Request $request): JsonApiCollection
     {
         $modelClass = $this->getModelClass();
 
@@ -42,12 +48,8 @@ public function store(Request $request)
 
     /**
      * Display the specified resource.
-     *
-     * @param int $id
-     *
-     * @return \Illuminate\Http\Response
      */
-    public function show(Request $request, $id)
+    public function show(Request $request, string $id): JsonApiResource
     {
         $modelClass = $this->getModelClass();
 

tests/app/Http/Controllers/CommentController.php

@@ -2,6 +2,8 @@
 
 namespace Test\app\Http\Controllers;
 
+use Ark4ne\JsonApi\Resources\JsonApiCollection;
+use Ark4ne\JsonApi\Resources\JsonApiResource;
 use Illuminate\Routing\Controller;
 use Test\app\Http\Requests\CommentRequest;
 use Test\app\Http\Resources\CommentResource;
@@ -24,12 +26,12 @@ protected function getResourceClass(): string
         return CommentResource::class;
     }
 
-    public function index(CommentRequest $request)
+    public function index(CommentRequest $request): JsonApiCollection
     {
         return $this->apiIndex($request);
     }
 
-    public function show(CommentRequest $request, $id)
+    public function show(CommentRequest $request, string $id): JsonApiResource
     {
         return $this->apiShow($request, $id);
     }

tests/app/Http/Controllers/UserController.php

@@ -2,6 +2,8 @@
 
 namespace Test\app\Http\Controllers;
 
+use Ark4ne\JsonApi\Resources\JsonApiCollection;
+use Ark4ne\JsonApi\Resources\JsonApiResource;
 use Illuminate\Routing\Controller;
 use Test\app\Http\Requests\UserRequest;
 use Test\app\Http\Resources\UserResource;
@@ -24,12 +26,12 @@ protected function getResourceClass(): string
         return UserResource::class;
     }
 
-    public function index(UserRequest $request)
+    public function index(UserRequest $request): JsonApiCollection
     {
         return $this->apiIndex($request);
     }
 
-    public function show(UserRequest $request, $id)
+    public function show(UserRequest $request, string $id): JsonApiResource
     {
         return $this->apiShow($request, $id);
     }

tests/app/Http/Requests/CommentRequest.php

@@ -9,12 +9,15 @@
 
 class CommentRequest extends FormRequest
 {
-    public function authorize()
+    public function authorize(): bool
     {
         return true;
     }
 
-    public function rules()
+    /**
+     * @return array{fields: array<mixed>, include: array<mixed>}
+     */
+    public function rules(): array
     {
         return [
             'fields' => [new Fields(CommentResource::class)],

tests/app/Http/Requests/PostRequest.php

@@ -9,12 +9,15 @@
 
 class PostRequest extends FormRequest
 {
-    public function authorize()
+    public function authorize(): bool
     {
         return true;
     }
 
-    public function rules()
+    /**
+     * @return array{fields: array<mixed>, include: array<mixed>}
+     */
+    public function rules(): array
     {
         return [
             'fields' => [new Fields(PostResource::class)],

tests/app/Http/Requests/UserRequest.php

@@ -9,12 +9,15 @@
 
 class UserRequest extends FormRequest
 {
-    public function authorize()
+    public function authorize(): bool
     {
         return true;
     }
 
-    public function rules()
+    /**
+     * @return array{fields: array<mixed>, include: array<mixed>}
+     */
+    public function rules(): array
     {
         return [
             'fields' => [new Fields(UserResource::class)],

tests/app/Models/Comment.php

@@ -20,7 +20,7 @@ class Comment extends Model
 {
     use HasFactory;
 
-    protected static function newFactory()
+    protected static function newFactory(): CommentFactory
     {
         return new CommentFactory();
     }

tests/app/Models/Post.php

@@ -22,7 +22,7 @@ class Post extends Model
 {
     use HasFactory;
 
-    protected static function newFactory()
+    protected static function newFactory(): PostFactory
     {
         return new PostFactory();
     }