svenluijten / laravel-ide

💻 Generate IDE helper files for your Laravel applications with a single command.

Laravel IDE

Note: This package is no longer maintained. Use sven/artisan-shortcuts instead.

This package provides a single command to quickly generate IDE helper files. I grew tired of remembering the 3 or 4 commands it took me to generate the helper files with Barry van den Heuvel's laravel-ide-helper package, so I wrote my own command. Eventually though, I kept copying and pasting that same command in all my projects. And thus, this package was born.

Index

• Installation
  • Downloading
  • Registering the service provider
• Usage
• Configuration
• Contributing
• License

Installation

You'll have to follow a couple of simple steps to install this package.

Downloading

Via composer:

$ composer require sven/laravel-ide --dev

Or add the package to your dependencies in composer.json and run composer update on the command line to download the package:

{
    "require-dev": {
        "sven/laravel-ide": "^1.0"
    }
}

Registering the service provider

Thanks to auto-discovery, the service provider is already registered. If you disabled auto-discovery in your project, you must register \Sven\LaravelIde\ServiceProvider while the app is in the local environment.

Usage

To (re-)generate IDE helper files, execute the following command:

$ php artisan ide

Configuration

To publish the configuration file for this package, run the following command:

$ php artisan vendor:publish --provider="Sven\LaravelIde\ServiceProvider"

This will create a new file at config/ide.php, where you can configure the following values:

write_to_model_files

This option is to determine whether to write the generated docblocks for models directly to the model files or to create a seperate file for them.

commands.*

The keys here stand for the ide-helper command to execute. If you want to disable one of them, set its value to false.

Contributing

All contributions (pull requests, issues and feature requests) are welcome. Make sure to read through the CONTRIBUTING.md first, though. See the contributors page for all contributors.

License

sven/laravel-ide is licensed under the MIT License (MIT). Please see the license file for more information.