Repolode
Enviar
barryvdh

barryvdh/laravel-ide-helper

Gera arquivos PHPDoc para facades do Laravel e modelos Eloquent, permitindo que IDEs como o PhpStorm ofereçam autocomplete preciso.

Ver no GitHub
Estrelas
14,972
Forks
1,194
Issues abertas
195
Último commit
há 4 dias

O que é?

O IDE Helper for Laravel é uma dependência de desenvolvimento do Composer que gera arquivos auxiliares a partir do próprio código do projeto, para que os editores ofereçam autocomplete preciso. Ao executar `php artisan ide-helper:generate`, você cria um arquivo que descreve as facades do Laravel; já `ide-helper:models` gera PHPDocs para os modelos Eloquent com base nas colunas das tabelas, relações e getters/setters.

O pacote também cria arquivos meta do PhpStorm com `ide-helper:meta`, permitindo que a IDE infira qual classe é retornada por consultas ao container, como `app('events')`. Há opções adicionais para macros, métodos Fluent de migration, builders de factory, facades em tempo real e tipos de relacionamento personalizados. A saída dos modelos pode ser gravada nos próprios arquivos dos modelos, em um arquivo separado ou adicionada como uma referência `@mixin`.

A branch 3.x oferece suporte ao Laravel 10 e versões posteriores; versões mais antigas do Laravel usam os releases 2.x.

Recursos principais

  • 01Gera arquivos de autocomplete para facades com `ide-helper:generate`.
  • 02Gera PHPDocs para colunas, relações e accessors dos modelos.
  • 03Cria arquivos meta do PhpStorm para resolução do container.
  • 04Permite gravar a documentação dos modelos em arquivos separados por meio de mixins.
  • 05Dá suporte a macros, métodos Fluent de migration e builders de factory.

Casos de uso

  • Obter autocomplete preciso para atributos e relações de modelos Eloquent no PhpStorm.
  • Manter as sugestões da IDE em sincronia após mudanças no schema ou nas dependências, executando o gerador novamente.
  • Ajudar IDEs a entender facades e bindings do container em um projeto Laravel.

Início rápido

  1. 1

    Instale o pacote como dependência de desenvolvimento com o Composer

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

    Gere o arquivo de preenchimento automático de Facade

    php artisan ide-helper:generate
  3. 3

    Gere os PHPDocs dos seus modelos e grave-os nos arquivos dos modelos

    php artisan ide-helper:models -RW

Antes de usar

  • A geração de PHPDoc para modelos requer uma conexão funcional com o banco de dados.
  • A branch 3.x é compatível com o Laravel 10 e versões posteriores; versões mais antigas do Laravel precisam das releases 2.x.

Tópicos

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

Perguntas frequentes

O que é laravel-ide-helper?
Gera arquivos PHPDoc para facades do Laravel e modelos Eloquent, permitindo que IDEs como o PhpStorm ofereçam autocomplete preciso. O IDE Helper for Laravel é uma dependência de desenvolvimento do Composer que gera arquivos auxiliares a partir do próprio código do projeto, para que os editores ofereçam autocomplete preciso. Ao executar `php artisan ide-helper:generate`, você cria um arquivo que descreve as facades do Laravel; já `ide-helper:models` gera PHPDocs para os modelos Eloquent com base nas colunas das tabelas, relações e getters/setters.
laravel-ide-helper é gratuito? Qual é a licença?
laravel-ide-helper é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
laravel-ide-helper ainda é mantido?
Manutenção ativa. O último commit de laravel-ide-helper foi em 3 de nov. de 2026.
Para que posso usar laravel-ide-helper?
Obter autocomplete preciso para atributos e relações de modelos Eloquent no PhpStorm. Manter as sugestões da IDE em sincronia após mudanças no schema ou nas dependências, executando o gerador novamente. Ajudar IDEs a entender facades e bindings do container em um projeto Laravel.
Como instalar laravel-ide-helper?
Instale o pacote como dependência de desenvolvimento com o Composer: composer require --dev barryvdh/laravel-ide-helper Gere o arquivo de preenchimento automático de Facade: php artisan ide-helper:generate Gere os PHPDocs dos seus modelos e grave-os nos arquivos dos modelos: php artisan ide-helper:models -RW
Onde consigo laravel-ide-helper?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/barryvdh/laravel-ide-helper

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados