laravel-shift/blueprint

Enhance Blueprint Stubs with PHPDoc to Eliminate PHPStan Warnings

Open

#738 ouverte le 11 févr. 2025

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)PHP (295 forks)user submission
communityenhancementgood first issue

Métriques du dépôt

Stars
 (3 107 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

Synopsis:

Blueprint generates stubs for models, controllers, and more, but without proper PHPDoc annotations, my IDE won’t stop nagging about missing or unclear types. Adding detailed annotations would improve type inference, reduce warnings, and make development smoother.

Proposed Syntax:

As an Example we can modify the stub: stubs/model.class.stub

<?php

namespace {{ namespace }};

{{ imports }}

class {{ class }} extends Model
{
    use HasFactory;
}

To:

<?php

namespace {{ namespace }};

{{ imports }}

class {{ class }} extends Model
{
    /** @use HasFactory<\Database\Factories\{{ class }}Factory> */
    use HasFactory;
}

Expected Behavior:

PHPStan would stop complaining about missing PHPDoc comments in generated files.
P.S. The above change did introduce another issue - SoftDeletes ended up in PHPDoc instead of being added as a trait.

Guide contributeur