class SlimLint::Logger

Encapsulates all communication to an output source.

Attributes

color_enabled[RW]

Whether colored output via ANSI escape sequences is enabled. @return [true,false]

Public Class Methods

new(out) click to toggle source

Creates a new {SlimLint::Logger} instance.

@param out [IO] the output destination.

# File lib/slim_lint/logger.rb, line 19
def initialize(out)
  @out = out
end
silent() click to toggle source

Creates a logger which outputs nothing. @return [SlimLint::Logger]

# File lib/slim_lint/logger.rb, line 12
def self.silent
  new(File.open('/dev/null', 'w'))
end

Public Instance Methods

bold(*args) click to toggle source

Print the specified output in bold face. If output destination is not a TTY, behaves the same as {#log}.

@param args [Array<String>]

# File lib/slim_lint/logger.rb, line 36
def bold(*args)
  color('1', *args)
end
bold_error(*args) click to toggle source

Print the specified output in a bold face and color indicative of error. If output destination is not a TTY, behaves the same as {#log}.

@param args [Array<String>]

# File lib/slim_lint/logger.rb, line 52
def bold_error(*args)
  color('1;31', *args)
end
error(*args) click to toggle source

Print the specified output in a color indicative of error. If output destination is not a TTY, behaves the same as {#log}.

@param args [Array<String>]

# File lib/slim_lint/logger.rb, line 44
def error(*args)
  color(31, *args)
end
info(*args) click to toggle source

Print the specified output in a color indicating information. If output destination is not a TTY, behaves the same as {#log}.

@param args [Array<String>]

# File lib/slim_lint/logger.rb, line 76
def info(*args)
  color(36, *args)
end
log(output, newline = true) click to toggle source

Print the specified output.

@param output [String] the output to send @param newline [true,false] whether to append a newline

# File lib/slim_lint/logger.rb, line 27
def log(output, newline = true)
  @out.print(output)
  @out.print("\n") if newline
end
newline() click to toggle source

Print a blank line.

# File lib/slim_lint/logger.rb, line 81
def newline
  log('')
end
success(*args) click to toggle source

Print the specified output in a color indicative of success. If output destination is not a TTY, behaves the same as {#log}.

@param args [Array<String>]

# File lib/slim_lint/logger.rb, line 60
def success(*args)
  color(32, *args)
end
tty?() click to toggle source

Whether this logger is outputting to a TTY.

@return [true,false]

# File lib/slim_lint/logger.rb, line 88
def tty?
  @out.respond_to?(:tty?) && @out.tty?
end
warning(*args) click to toggle source

Print the specified output in a color indicative of a warning. If output destination is not a TTY, behaves the same as {#log}.

@param args [Array<String>]

# File lib/slim_lint/logger.rb, line 68
def warning(*args)
  color(33, *args)
end

Private Instance Methods

color(code, output, newline = true) click to toggle source

Print output in the specified color.

@param code [Integer,String] ANSI color code @param output [String] output to print @param newline [Boolean] whether to append a newline

# File lib/slim_lint/logger.rb, line 99
def color(code, output, newline = true)
  log(color_enabled ? "\033[#{code}m#{output}\033[0m" : output, newline)
end