Laravel IDE Helper Generator

Множество разработчиков использующих Laravel ставят себе пакет github.com/barryvdh/laravel-ide-helper. Он служит для генерации файла-помощника, который позволит вашей IDE автокомплитить классы Laravel. Это, конечно, «костыль», но без него не удобно писать код.

На данный момент установка выглядит следующим образом:

«На данный момент» потому что Laravel довольно часто меняется и через полгода, или даже меньше, эта инструкция может устареть.

1. Устанавливаем пакет в проект через composer:

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

2. Добавляем нового провайдера «IdeHelperServiceProvider». Обычно, используется один из двух вариантов.

Первый — массив всех провайдеров «config/app.php».
<?php
 
return [
    // Другие настройки.
    'providers' => [
        // Другие провайдеры.
    ],
    // Другие настройки.
];
Второй — «app/Providers/AppServiceProvider.php».
<?php
 
namespace App\Providers;
 
use Illuminate\Support\ServiceProvider;
use Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider;
 
class AppServiceProvider extends ServiceProvider
{
    public function register()
    {
        if ($this->app->environment() !== 'production') {
            $this->app->register(IdeHelperServiceProvider::class);
        }
    }
}

3. Генерируем файл-помощник. Есть, также, два варианта использования.

Вручную.
php artisan ide-helper:generate
Автоматически — при каждом обновлении проекта через composer. В composer.json необходимо добавить:
"scripts":{
    "post-update-cmd": [
        "Illuminate\\Foundation\\ComposerScripts::postUpdate",
        "@php artisan ide-helper:generate",
        "@php artisan ide-helper:meta"
    ]
},

На этом установка и настройка закончена.

Команды

Генерация phpDoc’а для моделей.
php artisan ide-helper:generate
Генерация phpDoc’а для фасадов.
php artisan ide-helper:models
Генерация мета-информации для контейнера внедрения зависимостей.
php artisan ide-helper:meta

Полезные ссылки

11.02.2020

Категория(-и): Laravel

# #

Добавить комментарий