lorisleiva / laravel-actions

⚡️ Laravel components that take care of one specific task
https://laravelactions.com
MIT License
2.52k stars 124 forks source link

Added docBlock annotations to assist with IDE auto complete for Actions #252

Closed travisaustin closed 1 year ago

travisaustin commented 1 year ago

This PR adds docBlocks to several Laravel Actions traits. The docBlocks are intended to help provide better autocompletion when using a PHP IDE. Created for use with PhpStorm, but I suspect it will help users of other IDEs as well.

This PR has no code-changes. The only changes is within comments (docBlocks).

lorisleiva commented 1 year ago

Thanks!

@Wulfheart just to double check, would this interfere with your IDE helper package or is it okay to merge?

travisaustin commented 1 year ago

Thanks!

@Wulfheart just to double check, would this interfere with your IDE helper package or is it okay to merge?

I use @Wulfheart 's IDE completion, and I don't expect my PR will affect his package.

My PR helps when writing the action itself. For example, once you've added the AsAction trait, my PR will help your IDE know that you can add properties like jobTimeout and methods like configureJob.

The @Wulfheart package helps provide auto-complete when working outside of the action. For example, when dispatching an Action, the @Wulfheart package helps the IDE know what arguments should be sent to the ::dispatch() method.

Thanks for considering this addition. I hope my understand is correct and that this will work alongside @Wulfheart.

Wulfheart commented 1 year ago

@travisaustin I guess I should start communicating that I don't have any idea how this package works anymore. Would love to find another maintainer.

travisaustin commented 1 year ago

@Wulfheart I, for one, find your package useful and helpful. So thanks for the work even if it's abandoned.