Stars: 147
Forks: 10
Pull Requests: 15
Issues: 4
Watchers: 4
Last Updated: 2023-09-11 16:59:15
Automatically restart Horizon when local PHP files change
License: MIT License
Languages: PHP
How many hours have lost debugging local jobs only to find out that you forgot to restart Horizon?
This package contains an Artisan command horizon:watch
that will start Horizon and automatically restart it when any PHP file is created, updated or deleted.
This command is meant to be used in local environment.
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
You can install the package via composer:
composer require spatie/laravel-horizon-watcher --dev
In your project, you should have the JavaScript package chokidar
installed. You can install it via npm
npm install chokidar --save-dev
or Yarn
yarn add chokidar --dev
Optionally, you can publish the config file with this command:
php artisan vendor:publish --tag="horizon-watcher-config"
This is the contents of the published config file:
return [
/*
* Horizon will be restarted when any PHP file inside these directories
* get created, updated or deleted. You can also specify other kinds
* of files here.
*/
'paths' => [
app_path(),
config_path(),
database_path(),
resource_path('views'),
base_path('.env'),
base_path('composer.lock'),
],
/*
* This command will be executed to start Horizon.
*/
'command' => 'php artisan horizon',
];
Run php artisan horizon:watch
to start Horizon. When a PHP file in your project gets created, updated or deleted, Horizon will automatically restart.
composer test
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.