macroactive/laravel-psalm

Psalm integration with Laravel. Do not cover Facades. Relatively simple integration

v9.0.4 2024-05-09 23:37 UTC

Requires

• php: >7.4
• ext-xml: *
• vimeo/psalm: >=4.7

Conflicts

• laravel/framework: <9.0

MIT

• Aleksandr Zhuravlev

README

Why?

Because we use Laravel and want to have decent Psalm coverage. Yes, we are aware on existence of official integration. But it's bigger and has some generalisations. Our implementation adds some limitations on code but, hopefully, more lightweight and makes better checks. Also, this one is more internal tool still, so lack of documentation and other drawbacks could still present :/ Choice is yours — check both and find what suits better for you.

Limitations

We try to make the code easier for Psalm understanding by introducing these limitations. Idea of them is to decrease amount of magic as much as possible.

• all model requests must start with Model::query()
• don't use facades (we consider this antipattern), only proper constructor/signature DI should be used
• models must have proper notation. Version generated by ide-helper must be adjusted
• we don't use Eloquent collections and fallbacks to Support Collections at all time

Example of a model

//declare strict, NS and other usages here

use Illuminate\Support\Collection;

/**
 * @property int                                                                           $id
… other columns
 * @property-read       Collection|CountryRegion[] $regions
 * @psalm-property-read Collection<CountryRegion>  $regions
 *
 * @method self published()
 */
final class Country extends Model
{

You can see Psalm notation for relations/ro-properties here. Also, the method published() is a form of scope annotation.