Module: RuboCop::Formatter::Colorizable Private

Included in:
SimpleTextFormatter, SimpleTextFormatter::Report
Defined in:
lib/rubocop/formatter/colorizable.rb

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

This mix-in module provides string coloring methods for terminals. It automatically disables coloring if coloring is disabled in the process globally or the formatter’s output is not a terminal.

Instance Method Summary collapse

Instance Method Details

#colorize(string, *args) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



21
22
23
 
# File 'lib/rubocop/formatter/colorizable.rb', line 21

def colorize(string, *args)
  rainbow.wrap(string).color(*args)
end

#rainbow ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/rubocop/formatter/colorizable.rb', line 9

def rainbow
  @rainbow ||= begin
    rainbow = Rainbow.new
    if options[:color]
      rainbow.enabled = true
    elsif options[:color] == false || !output.tty?
      rainbow.enabled = false
    end
    rainbow
  end
end