Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/laravel-horizon-watcher
Automatically restart Horizon when local PHP files change
https://github.com/spatie/laravel-horizon-watcher
development horizon laravel local
Last synced: 4 days ago
JSON representation
Automatically restart Horizon when local PHP files change
- Host: GitHub
- URL: https://github.com/spatie/laravel-horizon-watcher
- Owner: spatie
- License: mit
- Created: 2022-10-28T18:29:22.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T11:13:09.000Z (9 months ago)
- Last Synced: 2024-05-01T11:45:43.545Z (9 months ago)
- Topics: development, horizon, laravel, local
- Language: PHP
- Homepage: https://spatie.be/open-source
- Size: 168 KB
- Stars: 172
- Watchers: 3
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Automatically restart Horizon when local PHP files change
[](https://packagist.org/packages/spatie/laravel-horizon-watcher)
[](https://packagist.org/packages/spatie/laravel-horizon-watcher)
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
[
](https://spatie.be/github-ad-click/laravel-horizon-watcher)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
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](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
You can install the package via composer:
```bash
composer require spatie/laravel-horizon-watcher --dev
```
In your project, you should have the JavaScript package [`chokidar`](https://github.com/paulmillr/chokidar) installed. You can install it via npm
```bash
npm install chokidar --save-dev
```
or Yarn
```bash
yarn add chokidar --dev
```
Optionally, you can publish the config file with this command:
```bash
php artisan vendor:publish --tag="horizon-watcher-config"
```
This is the contents of the published config file:
```php
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
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Freek Van der Herten](https://github.com/freekmurze)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.