Skip to content

Enhance Blueprint Stubs with PHPDoc to Eliminate PHPStan Warnings #738

Open
@Maya7474

Description

@Maya7474

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.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions