Module Guard::UI
In: lib/guard/ui.rb

The UI class helps to format messages for the user. Everything that is logged through this class is considered either as an error message or a diagnostic message and is written to standard error ($stderr).

If your Guard plugin does some output that is piped into another process for further processing, please just write it to STDOUT with `puts`.

Methods

Constants

ANSI_ESCAPE_BRIGHT = '1'   Brighten the color
ANSI_ESCAPE_BLACK = '30'   Black foreground color
ANSI_ESCAPE_RED = '31'   Red foreground color
ANSI_ESCAPE_GREEN = '32'   Green foreground color
ANSI_ESCAPE_YELLOW = '33'   Yellow foreground color
ANSI_ESCAPE_BLUE = '34'   Blue foreground color
ANSI_ESCAPE_MAGENTA = '35'   Magenta foreground color
ANSI_ESCAPE_CYAN = '36'   Cyan foreground color
ANSI_ESCAPE_WHITE = '37'   White foreground color
ANSI_ESCAPE_BGBLACK = '40'   Black background color
ANSI_ESCAPE_BGRED = '41'   Red background color
ANSI_ESCAPE_BGGREEN = '42'   Green background color
ANSI_ESCAPE_BGYELLOW = '43'   Yellow background color
ANSI_ESCAPE_BGBLUE = '44'   Blue background color
ANSI_ESCAPE_BGMAGENTA = '45'   Magenta background color
ANSI_ESCAPE_BGCYAN = '46'   Cyan background color
ANSI_ESCAPE_BGWHITE = '47'   White background color

Public Class methods

Show a scoped action message.

@param [String] action the action to show @param [Hash] scopes hash with a guard or a group scope

Clear the output if clearable.

Allow the screen to be cleared again.

Show a debug message that is prefixed with DEBUG and a timestamp.

@param [String] message the message to show @option options [Boolean] reset whether to clean the output before @option options [String] plugin manually define the calling plugin

Show a red deprecation message that is prefixed with DEPRECATION. It has a log level of `warn`.

@param [String] message the message to show @option options [Boolean] reset whether to clean the output before @option options [String] plugin manually define the calling plugin

Show a red error message that is prefixed with ERROR.

@param [String] message the message to show @option options [Boolean] reset whether to clean the output before @option options [String] plugin manually define the calling plugin

Show an info message.

@param [String] message the message to show @option options [Boolean] reset whether to clean the output before @option options [String] plugin manually define the calling plugin

Get the Guard::UI logger instance

Get the logger options

@return [Hash] the logger options

Set the logger options

@param [Hash] options the logger options @option options [Symbol] level the log level @option options [String] template the logger template @option options [String] time_format the time format

Reset a line.

Show a yellow warning message that is prefixed with WARNING.

@param [String] message the message to show @option options [Boolean] reset whether to clean the output before @option options [String] plugin manually define the calling plugin

[Validate]