[Feature Request]: Mago support

[pawel-omniaz]

Feature Description

Hi, do you plan on making some adjustments to better support Mago tool? I've tried to use it along with helper code generated by Laravel Idea, but there was huge amount of issues/errors/warnings, e.g. relations type hints are like @property ProductsCollection|Product[] $variants and because of that Product[] Mago shows error when I'm using collection methods like $product->variants->pluck('id').

[adelf]

Hello. What tool do you mean? I found only one on GitHub, it's written in Rust.

ProductCollection should be extended from Laravel collection, and it will work. Could you provide more samples from your code? It's not enough to understand the problem...

[pawel-omniaz]

Yes, sorry, it's this one - https://mago.carthage.software (https://github.com/carthage-software/mago).
I know that this tool may be at early stage of adoption at the moment, but looks very promising - It's like having PHP CS, PHPStan etc. in single tool which is also a lot faster than any of them. So far I was using PHPStan with Larastan extension. Using Mago right now I have many errors like those and I'm not sure if something can be done to make it work (e.g. add option to generate only Collection<...> type hints for relations, without array hint?)

[adelf]

Could you show a ProductsCollection class?

Looks like the tool can't understand what there might be more than one declaration of the class in the project... Yes, it looks weird, but it's the only possible way to make it work with Laravel magic.

[pawel-omniaz]

I understand, thanks. ProductsCollection is actually rather simple. I guess I will also create the ticket in Mago repository, maybe there is some configuration I'm missing.

[adelf]

Yes, as you see, it should be ok with methods like pluck, but it finds another class declaration(in our helper files) and can't understand this.

[azjezz]

Mago is right here. the code is wrong.

ProductsCollection|Product[] implies the value could either be an instance of ProductsCollection OR Product[] ( which is array<array-key, Product> ), attempting to call a method on it would result in in an array because you are essentially calling a method on array.

If the type is known to be ProductsCollection, then it should be that, without Product[] as that is completely wrong.

[adelf]

We can add a setting so we don't generate the additional "Product[]" type for known custom collection types...

[pawel-omniaz]

@adelf Or maybe even to not generate the additional array type ("Product[]") for all relationships?