Laravel IDE Helper

Laravel IDE Helper is a developer tool that generates helper files enabling your IDE to provide accurate autocompletion for Laravel’s dynamic facades, Eloquent models, and macros. Because generation is driven by the actual files and database schema in your project, the produced PHPDocs stay in sync with your code.

Installed as a dev dependency, it exposes artisan commands that write _ide_helper.php, model docblocks, and a PhpStorm meta file. This restores the static-analysis and autocompletion experience that Laravel’s magic methods and container bindings would otherwise hide from editors like PhpStorm, VS Code, and Sublime Text.

What You Get

• Artisan command ide-helper:generate that produces _ide_helper.php for all facades
• Model docblock generation from table columns, relations, and accessors via ide-helper:models
• A PhpStorm .phpstorm.meta.php file mapping container make() calls to concrete classes
• Configurable output: separate files, in-place model writes, or @mixin annotations
• Support for macros, mixins, real-time facades, and custom relationship return types

Common Use Cases

• Enabling reliable autocompletion for Laravel facades in PhpStorm or VS Code
• Documenting Eloquent model properties and query-builder methods for type hints
• Regenerating helper files automatically after composer update via post-update hooks

Under The Hood

Architecture - The package registers an IdeHelperServiceProvider that wires up artisan commands (GeneratorCommand, ModelsCommand, MetaCommand) under src/Console. Each command uses PHP reflection plus barryvdh/reflection-docblock and composer/class-map-generator to walk facades, container bindings, and Eloquent models, then renders PHPDoc output through Blade-style templates in php-templates.

Tech Stack - Written in PHP 8.2+, it depends on Laravel’s illuminate/console, illuminate/database, illuminate/filesystem, and illuminate/support components (v11-v13). Dev tooling includes PHPUnit, Orchestra Testbench, Larastan/PHPStan, and PHP-CS-Fixer.

Code Quality - The repo ships a tests suite run under Testbench, a committed phpstan-baseline.neon for static analysis, and PHP-CS-Fixer configuration, indicating disciplined maintenance and consistent style enforcement.

API Design - Developer experience centers on a handful of well-named artisan commands with intuitive flags (-W, -R, -M, --dir, --ignore) and a publishable config file, keeping setup to a single composer require --dev and one command.