Repolode
Enviar
barryvdh

barryvdh/laravel-ide-helper

Genera archivos PHPDoc para facades de Laravel y modelos Eloquent, para que IDEs como PhpStorm ofrezcan autocompletado preciso.

Ver en GitHub
Estrellas
14,972
Forks
1,194
Issues abiertos
195
Último commit
hace 4 días

¿Qué es?

IDE Helper for Laravel es una dependencia de Composer para desarrollo que genera archivos auxiliares a partir del código del propio proyecto, para que los editores ofrezcan autocompletado preciso. Al ejecutar `php artisan ide-helper:generate`, se genera un archivo que describe las facades de Laravel, y `ide-helper:models` escribe PHPDocs para los modelos Eloquent a partir de las columnas de las tablas, las relaciones y los getters/setters.

El paquete también crea archivos meta de PhpStorm mediante `ide-helper:meta`, que permiten al IDE inferir la clase que devuelven las búsquedas en el contenedor, como `app('events')`. Otras opciones abarcan macros, métodos de migración Fluent, constructores de factories, facades en tiempo real y tipos de relaciones personalizados. La salida de los modelos puede escribirse en los propios archivos del modelo, en un archivo independiente o añadirse como referencia `@mixin`.

La rama 3.x es compatible con Laravel 10 y versiones posteriores; las versiones anteriores de Laravel usan las versiones 2.x.

Funciones clave

  • 01Genera archivos de autocompletado para facades con `ide-helper:generate`.
  • 02Escribe PHPDocs para columnas, relaciones y accesores de los modelos.
  • 03Crea archivos meta de PhpStorm para la resolución del contenedor.
  • 04Permite escribir la documentación de los modelos en archivos independientes mediante mixins.
  • 05Admite macros, métodos de migración Fluent y constructores de factories.

Casos de uso

  • Obtener autocompletado preciso de los atributos y las relaciones de modelos Eloquent en PhpStorm.
  • Mantener las sugerencias del IDE sincronizadas tras cambios en el esquema o las dependencias, volviendo a ejecutar el generador.
  • Ayudar a los IDEs a interpretar las facades y los bindings del contenedor en un proyecto Laravel.

Inicio rápido

  1. 1

    Instala el paquete como dependencia de desarrollo con Composer

    composer require --dev barryvdh/laravel-ide-helper
  2. 2

    Genera el archivo de autocompletado de Facade

    php artisan ide-helper:generate
  3. 3

    Genera los PHPDoc de tus modelos y escríbelos en los archivos de modelo

    php artisan ide-helper:models -RW

Antes de usarlo

  • La generación de PHPDoc para modelos requiere una conexión a la base de datos funcional.
  • La rama 3.x es compatible con Laravel 10 y versiones posteriores; las versiones anteriores de Laravel requieren las versiones 2.x.

Temas

#laravel#php#autocompletion#phpstorm#ide#eloquent#hacktoberfest

Preguntas frecuentes

¿Qué es laravel-ide-helper?
Genera archivos PHPDoc para facades de Laravel y modelos Eloquent, para que IDEs como PhpStorm ofrezcan autocompletado preciso. IDE Helper for Laravel es una dependencia de Composer para desarrollo que genera archivos auxiliares a partir del código del propio proyecto, para que los editores ofrezcan autocompletado preciso. Al ejecutar `php artisan ide-helper:generate`, se genera un archivo que describe las facades de Laravel, y `ide-helper:models` escribe PHPDocs para los modelos Eloquent a partir de las columnas de las tablas, las relaciones y los getters/setters.
¿laravel-ide-helper es gratuito? ¿Qué licencia tiene?
laravel-ide-helper es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿laravel-ide-helper sigue mantenido?
Mantenimiento activo. El último commit de laravel-ide-helper fue el 3 nov 2026.
¿Para qué puedo usar laravel-ide-helper?
Obtener autocompletado preciso de los atributos y las relaciones de modelos Eloquent en PhpStorm. Mantener las sugerencias del IDE sincronizadas tras cambios en el esquema o las dependencias, volviendo a ejecutar el generador. Ayudar a los IDEs a interpretar las facades y los bindings del contenedor en un proyecto Laravel.
¿Cómo se instala laravel-ide-helper?
Instala el paquete como dependencia de desarrollo con Composer: composer require --dev barryvdh/laravel-ide-helper Genera el archivo de autocompletado de Facade: php artisan ide-helper:generate Genera los PHPDoc de tus modelos y escríbelos en los archivos de modelo: php artisan ide-helper:models -RW
¿Dónde consigo laravel-ide-helper?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/barryvdh/laravel-ide-helper

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados