Module Guard::Notifier::Tmux
In: lib/guard/notifiers/tmux.rb

Changes the color of the Tmux status bar and optionally shows messages in the status bar.

@example Add the `:tmux` notifier to your `Guardfile`

  notification :tmux

@example Enable text messages

  notification :tmux, :display_message => true

@example Customize the tmux status colored for notifications

  notification :tmux, :color_location => 'status-right-bg'

Methods

Constants

DEFAULTS = { :client => 'tmux', :tmux_environment => 'TMUX', :success => 'green', :failed => 'red', :pending => 'yellow', :default => 'green', :timeout => 5, :display_message => false, :default_message_format => '%s - %s', :default_message_color => 'white', :line_separator => ' - ', :color_location => 'status-left-bg'   Default options for Tmux

Public Instance methods

Test if currently running in a Tmux session

@param [Boolean] silent true if no error messages should be shown @return [Boolean] the availability status

Display a message in the status bar of tmux.

@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 [Hash] options additional notification library options @option options [Integer] timeout the amount of seconds to show the message in the status bar @option options [String] success_message_format a string to use as formatter for the success message. @option options [String] failed_message_format a string to use as formatter for the failed message. @option options [String] pending_message_format a string to use as formatter for the pending message. @option options [String] default_message_format a string to use as formatter when no format per type is defined. @option options [String] success_message_color the success notification foreground color name. @option options [String] failed_message_color the failed notification foreground color name. @option options [String] pending_message_color the pending notification foreground color name. @option options [String] default_message_color a notification foreground color to use when no color per type is defined. @option options [String] line_separator a string to use instead of a line-break.

Show a system notification. By default, the Tmux notifier only makes use of a color based notification, changing the background color of the `color_location` to the color defined in either the `success`, `failed`, `pending` or `default`, depending on the notification type. If you also want display a text message, you have to enable it explicit by setting `display_message` to `true`.

@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] color_location the location where to draw the color notification @option options [Boolean] display_message whether to display a message or not

Get the Tmux color for the notification type. You can configure your own color by overwriting the defaults.

@param [String] type the notification type @return [String] the name of the emacs color

Notification stopping. Restore the previous Tmux state if available (existing options are restored, new options are unset) and unquite the Tmux output.

Notification starting, save the current Tmux settings and quiet the Tmux output.

[Validate]