search

usernotnull / tall-toasts

A Toast notification library for the Laravel TALL stack. You can push notifications from the backend or frontend to render customizable toasts with almost zero footprint on the published CSS/JS 🔥🚀
MIT License
553 stars 30 forks source link

Adding PHPDoc for Facade so ide-helper works #460

Open BoGnY opened 1 year ago

BoGnY commented 1 year ago

Description

I would like to add PHPDoc for Facade so that the ide helper works properly.

Screenshots

This is what I would like to do: image

This is the ide helper without my code: image

And this is the ide helper with the phpdoc added: image

Additional context

In the end it doesn't change any logic, but it's improves the operation of the ide (at least phpstorm/idea) but I think also with vscode.

usernotnull commented 1 year ago

The controversy of which is "cleaner", facades or static methods :)

That's part of the reason why for IDEs and for shorter code (both the library and its usage), I opted for the easier toast() and did not document the facade way of doing it as you did.

I'll add them if I get more requests for this.

BoGnY commented 1 year ago

Yes ^^ I personally prefer Facade on php files and helper on blade files, but obviously the choice remains up to the dev. I found somewhere that this is more recommended.

I hope others are interested ^^ Also because a few lines of documentation simplifies the use of the Facade :)

usernotnull commented 1 year ago

Hmm. Have you tried laravel helper plugin or the free laravel ide helper? They add these annotations automatically.

BoGnY commented 1 year ago

Hmm. Have you tried laravel helper plugin or the free laravel ide helper? They add these annotations automatically.

Yes I have tried laravel-ide-helper, but needs to put Facade manually on config/app.php... I don't know why...