Add type checks

.gitattributes

@@ -1,6 +1,7 @@
 /.docker                export-ignore
 /.github                export-ignore
 /tests                  export-ignore
+/types                  export-ignore
 .gitattributes          export-ignore
 .gitignore              export-ignore
 docker-compose.ci.yml   export-ignore

.github/CONTRIBUTING.md

@@ -26,4 +26,5 @@ We accept contributions via Pull Requests on [GitHub](https://github.com/stauden
 docker compose run --rm php8.3 composer install
 docker compose run --rm php8.3 vendor/bin/phpunit
 docker compose run --rm php8.3 vendor/bin/phpstan analyse --memory-limit=-1
+docker compose run --rm php8.3 vendor/bin/phpstan analyse --configuration=phpstan.types.neon.dist --memory-limit=-1
 ```

.github/workflows/static-analysis.yml

@@ -31,3 +31,7 @@ jobs:
         run: |
           docker compose -f docker-compose.yml -f docker-compose.ci.yml run --rm php${{ matrix.php }} \
             vendor/bin/phpstan analyse --error-format=github --memory-limit=-1
+      - name: Analyse types
+        run: |
+          docker compose -f docker-compose.yml -f docker-compose.ci.yml run --rm php${{ matrix.php }} \
+            vendor/bin/phpstan analyse --configuration=phpstan.types.neon.dist --error-format=github --memory-limit=-1   

composer.json

@@ -18,8 +18,8 @@
     },
     "require-dev": {
         "barryvdh/laravel-ide-helper": "^3.0",
+        "larastan/larastan": "^2.9",
         "orchestra/testbench": "^9.0",
-        "phpstan/phpstan": "^1.12",
         "phpunit/phpunit": "^11.0"
     },
     "autoload": {

phpstan.types.neon.dist

@@ -0,0 +1,6 @@
+includes:
+    - ./vendor/larastan/larastan/extension.neon
+parameters:
+    level: 9
+    paths:
+        - types

types/Models/Comment.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Staudenmeir\BelongsToThrough\Types\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Znck\Eloquent\Traits\BelongsToThrough;
+
+class Comment extends Model
+{
+    use BelongsToThrough;
+}

types/Models/Country.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Staudenmeir\BelongsToThrough\Types\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+class Country extends Model
+{
+    //
+}

types/Models/Post.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Staudenmeir\BelongsToThrough\Types\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+class Post extends Model
+{
+    //
+}

types/Models/User.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Staudenmeir\BelongsToThrough\Types\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+class User extends Model
+{
+    //
+}

types/Relationships.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Staudenmeir\BelongsToThrough\Types;
+
+use Staudenmeir\BelongsToThrough\Types\Models\Comment;
+use Staudenmeir\BelongsToThrough\Types\Models\Country;
+use Staudenmeir\BelongsToThrough\Types\Models\Post;
+use Staudenmeir\BelongsToThrough\Types\Models\User;
+
+use function PHPStan\Testing\assertType;
+
+function test(Comment $comment): void
+{
+    assertType(
+        'Znck\Eloquent\Relations\BelongsToThrough<Staudenmeir\BelongsToThrough\Types\Models\Country, Staudenmeir\BelongsToThrough\Types\Models\Comment>',
+        $comment->belongsToThrough(Country::class, [User::class, Post::class])
+    );
+}