maxime-rainville / silverstripe-cli-notify
Genetrate desktop notifications when running Silverstripe CMS sake commands
Installs: 30
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Type:silverstripe-vendormodule
Requires
- jolicode/jolinotif: ^2.3
- silverstripe/framework: ^4 || ^5
- silverstripe/vendor-plugin: ^1.4 || ^2
This package is auto-updated.
Last update: 2024-04-23 06:55:00 UTC
README
This module adds a middleware to Silverstripe CMS that will try to display desktop notification when using the command line to execute a dev/ command.
The notification is displayed once the command has completed. This allows you to start a long running proccess in your terminal and move on to other things.
Installation
composer require --dev maxime-rainville/silverstripe-cli-notify
Note the usage of the --dev flag. This is meant to be a development tool only.
How does it work
This modules uses the jolicode/jolinotif PHP library to display the notifications. This library works on MacOS, most Linux distros and MS Windows ... althought I've only tested on Ubuntu.
You can still use this library if your OS doesn't support desktop notifications. Nothing will happen, but your project will otherwise work as expected.
This is unlikely to work if your sake command is run from inside vagrant or docker.