Add PHPDoc annotations to stubs for better PHPStan support (#738)

src/Generators/ModelGenerator.php

@@ -13,7 +13,9 @@
 
 class ModelGenerator extends AbstractClassGenerator implements Generator
 {
-    use HandlesImports, HandlesInterfaces, HandlesTraits;
+    use HandlesImports, HandlesInterfaces, HandlesTraits {
+        HandlesTraits::buildTraits as protected buildBaseTraits;
+    }
 
     protected array $types = ['models'];
 
@@ -56,6 +58,27 @@ protected function populateStub(string $stub, Model $model): string
         return $stub;
     }
 
+    protected function buildTraits(Model $model): string
+    {
+        $traits = $this->buildBaseTraits($model);
+
+        if ($traits === '') {
+            return '';
+        }
+
+        if (!config('blueprint.generate_phpdocs')) {
+            return $traits;
+        }
+
+        if (!in_array('HasFactory', $this->traits[$model->name()] ?? [], true)) {
+            return $traits;
+        }
+
+        $factory = '\\Database\\Factories\\' . $model->name() . 'Factory';
+
+        return "/** @use HasFactory<{$factory}> */" . PHP_EOL . '    ' . $traits;
+    }
+
     protected function buildClassPhpDoc(Model $model): string
     {
         if (!config('blueprint.generate_phpdocs')) {

tests/fixtures/models/disable-auto-columns-phpdoc.php

@@ -12,6 +12,7 @@
  */
 class State extends Model
 {
+    /** @use HasFactory<\Database\Factories\StateFactory> */
     use HasFactory;
 
     /**

tests/fixtures/models/foreign-key-shorthand-phpdoc.php

@@ -16,6 +16,7 @@
  */
 class Comment extends Model
 {
+    /** @use HasFactory<\Database\Factories\CommentFactory> */
     use HasFactory;
 
     /**

tests/fixtures/models/readme-example-phpdoc.php

@@ -17,6 +17,7 @@
  */
 class Post extends Model
 {
+    /** @use HasFactory<\Database\Factories\PostFactory> */
     use HasFactory;
 
     /**

tests/fixtures/models/relationships-phpdoc.php

@@ -15,6 +15,7 @@
  */
 class Comment extends Model
 {
+    /** @use HasFactory<\Database\Factories\CommentFactory> */
     use HasFactory;
 
     /**

tests/fixtures/models/soft-deletes-phpdoc.php

@@ -16,6 +16,7 @@
  */
 class Comment extends Model
 {
+    /** @use HasFactory<\Database\Factories\CommentFactory> */
     use HasFactory, SoftDeletes;
 
     /**