spatie/laravel-horizon-watcher

Automatically restart Horizon when local PHP files change

1.1.0 2024-03-04 09:32 UTC

Requires

• php: ^8.1
• illuminate/contracts: ^9.0|^10.0|^11.0
• spatie/file-system-watcher: ^1.1.1
• spatie/laravel-package-tools: ^1.13.6

Requires (Dev)

• laravel/pint: ^1.2
• nunomaduro/collision: ^6.3.1|^8.0
• orchestra/testbench: ^7.11|^8.0|^9.0
• pestphp/pest: ^1.22.1|^2.34
• pestphp/pest-plugin-laravel: ^1.3|^2.3
• phpunit/phpunit: ^9.5.26|^10.5
• spatie/laravel-ray: ^1.31

MIT

• Freek Van der Herten

• laravel
• spatie
• laravel-horizon-watcher

README

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.

Support us

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.

Installation

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',
];

Usage

Run php artisan horizon:watch to start Horizon. When a PHP file in your project gets created, updated or deleted, Horizon will automatically restart.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Freek Van der Herten
• All Contributors

License

The MIT License (MIT). Please see License File for more information.