Module | Guard::Notifier::Emacs |
In: |
lib/guard/notifiers/emacs.rb
|
Send a notification to Emacs with emacsclient (www.emacswiki.org/emacs/EmacsClient).
@example Add the `:emacs` notifier to your `Guardfile`
notification :emacs
DEFAULTS | = | { :client => 'emacsclient', :success => 'ForestGreen', :failed => 'Firebrick', :default => 'Black', :fontcolor => 'White', } |
Test if Emacs with running server is available.
@param [Boolean] silent true if no error messages should be shown @param [Hash] options notifier options @return [Boolean] the availability status
Get the Emacs color for the notification type. You can configure your own color by overwrite the defaults.
@param [String] type the notification type @param [Hash] options aditional notification options @option options [String] success the color to use for success notifications (default is ‘ForestGreen’) @option options [String] failed the color to use for failure notifications (default is ‘Firebrick’) @option options [String] pending the color to use for pending notifications @option options [String] default the default color to use (default is ‘Black’) @return [String] the name of the emacs color
Show a system notification.
@param [String] type the notification type. Either ‘success’, ‘pending’, ‘failed’ or ‘notify’ @param [String] title the notification title @param [String] message the notification message body @param [String] image the path to the notification image @param [Hash] options additional notification library options @option options [String] success the color to use for success notifications (default is ‘ForestGreen’) @option options [String] failed the color to use for failure notifications (default is ‘Firebrick’) @option options [String] pending the color to use for pending notifications @option options [String] default the default color to use (default is ‘Black’) @option options [String] client the client to use for notification (default is ‘emacsclient’) @option options [String, Integer] priority specify an int or named key (default is 0)