michiruf/laravel-ide-helper-companion

Package that provides convenience features around the barryvdh/laravel-ide-helper package

0.2-rc1 2024-09-02 15:18 UTC

Requires

• php: ^8.2
• barryvdh/laravel-ide-helper: ^3.1
• barryvdh/reflection-docblock: ^2.1
• illuminate/contracts: ^10.0||^11.0
• michiruf/laravel-collection-differ: 0.1
• spatie/laravel-package-tools: ^1.16

Requires (Dev)

• laravel/pint: ^1.14
• laravel/sail: ^1.31
• nunomaduro/collision: ^8.1.1||^7.10.0
• orchestra/testbench: ^9.0.0||^8.22.0
• pestphp/pest: ^2.34
• pestphp/pest-plugin-arch: ^2.7
• pestphp/pest-plugin-laravel: ^2.3
• spatie/laravel-ray: ^1.35

MIT

• laravel
• michiruf
• laravel-ide-helper-companion

README

This is a zero configuration package around barryvdh / laravel-ide-helper. Which aims to integrate easily with PHPStorm.

Installation

composer require --dev michiruf/laravel-ide-helper-companion

Usage

Commands:

php artisan ide-helper-companion {--throttle=0}
php artisan ide-helper-companion:annotate {--D|dir=} {--throttle=0} {--pint}
php artisan ide-helper-companion:generate {--throttle=0}

Command for a file watcher:

php artisan ide-helper-companion --throttle=10

will execute the command only every 10 seconds, and also will retry the current execution after 10 seconds. Append --pint automatically run pint after annotation and so to ensure pint is not permanently conflicting with the generated code.

Example file watcher for WSL and laravel sail

License

The MIT License (MIT). Please see License File for more information.