彩色Ruby输出到终端[关闭]


273

使用Ruby,如何在终端中对输出的背景和前景文本进行着色?

我记得,在对Pascal进行编程时,我们所有人都习惯编写自己的textcolor(…)程序,以使我们的小型教育程序看起来更美观,更具表现力。

我将如何在Ruby中编写与之等效的代码?


因此,举例来说,获得“橙色”颜色是不可能的吗?
Matrix

Answers:


379

Colorize是我最喜欢的宝石!:-)

看看这个:

https://github.com/fazibear/colorize

安装:

gem install colorize

用法:

require 'colorize'

puts "I am now red".red
puts "I am now blue".blue
puts "Testing".yellow

2
有人可以告诉我Colorize是否可以在Cygwin Terminal中运行吗?我尝试在Cygwin中运行上述代码,但结果没有颜色
。.– jj_

5
如果您安装了win32consolegem及require 'win32console'之后的版本,则在Windows命令提示符中将可以正常工作colorize
2013年

2
@Ben我还没有亲自尝试过,但是从Ruby 2.0开始,您就不再需要win32consolegem。github.com/luislavena/win32console/issues/…–
丹尼斯

1
有什么办法可以使用Sumb​​lime Text控制台进行这项工作?
日本,2014年

6
该宝石是根据GPL许可的,因此(我认为)不能在专有软件中使用。jonathannen.com/2013/07/07/license-your-gems.html
Andrei Botalov,2016年

249

结合以上答案,您可以实现类似gem colorize的功能,而无需其他依赖项。

class String
  # colorization
  def colorize(color_code)
    "\e[#{color_code}m#{self}\e[0m"
  end

  def red
    colorize(31)
  end

  def green
    colorize(32)
  end

  def yellow
    colorize(33)
  end

  def blue
    colorize(34)
  end

  def pink
    colorize(35)
  end

  def light_blue
    colorize(36)
  end
end

啊,很好编辑尼克。是的,当然没有必要自我传递。当我写这篇文章的时候,我很累:)
Erik Skoglund 2012年

在Windows中也可以使用吗?
阿尔卑斯

如果您使用的是ConEmu,
Mike Glenn

1
我喜欢此方法比着色好,因为这只会更改前景色。着色似乎总是会改变背景颜色。
jlyonsmith

1
我知道我晚会晚了,但是在这里使用闭包会更好吗?

215

作为String类方法(仅Unix):

class String
def black;          "\e[30m#{self}\e[0m" end
def red;            "\e[31m#{self}\e[0m" end
def green;          "\e[32m#{self}\e[0m" end
def brown;          "\e[33m#{self}\e[0m" end
def blue;           "\e[34m#{self}\e[0m" end
def magenta;        "\e[35m#{self}\e[0m" end
def cyan;           "\e[36m#{self}\e[0m" end
def gray;           "\e[37m#{self}\e[0m" end

def bg_black;       "\e[40m#{self}\e[0m" end
def bg_red;         "\e[41m#{self}\e[0m" end
def bg_green;       "\e[42m#{self}\e[0m" end
def bg_brown;       "\e[43m#{self}\e[0m" end
def bg_blue;        "\e[44m#{self}\e[0m" end
def bg_magenta;     "\e[45m#{self}\e[0m" end
def bg_cyan;        "\e[46m#{self}\e[0m" end
def bg_gray;        "\e[47m#{self}\e[0m" end

def bold;           "\e[1m#{self}\e[22m" end
def italic;         "\e[3m#{self}\e[23m" end
def underline;      "\e[4m#{self}\e[24m" end
def blink;          "\e[5m#{self}\e[25m" end
def reverse_color;  "\e[7m#{self}\e[27m" end
end

和用法:

puts "I'm back green".bg_green
puts "I'm red and back cyan".red.bg_cyan
puts "I'm bold and green and backround red".bold.green.bg_red

在我的控制台上:

在此处输入图片说明

额外:

def no_colors
  self.gsub /\e\[\d+m/, ""
end

删除格式字符

注意

puts "\e[31m" # set format (red foreground)
puts "\e[0m"   # clear format
puts "green-#{"red".red}-green".green # will be green-red-normal, because of \e[0

大胆应该使用逃逸代码22而不是21:def bold; "\e[1m#{self}\e[22m" end
Kanat Bolazar

@KanatBolazar,某些系统支持21。但是为了功能,我将其更改为22。谢谢。
伊万·布莱克

1
太好了,我将其放在Rails应用程序的初始化程序中。奇迹般有效!

很棒的提示。如此简单,没有依赖性。做得非常好!
mraxus

1
在Windows 10中cmd.exeputs "\e[0"无法清除格式。puts "\e[0m"必须使用
Nnnes

41

我根据Erik Skoglund和其他人的答案写了一点方法来测试基本的色彩模式。

#outputs color table to console, regular and bold modes
def colortable
  names = %w(black red green yellow blue pink cyan white default)
  fgcodes = (30..39).to_a - [38]

  s = ''
  reg  = "\e[%d;%dm%s\e[0m"
  bold = "\e[1;%d;%dm%s\e[0m"
  puts '                       color table with these background codes:'
  puts '          40       41       42       43       44       45       46       47       49'
  names.zip(fgcodes).each {|name,fg|
    s = "#{fg}"
    puts "%7s "%name + "#{reg}  #{bold}   "*9 % [fg,40,s,fg,40,s,  fg,41,s,fg,41,s,  fg,42,s,fg,42,s,  fg,43,s,fg,43,s,  
      fg,44,s,fg,44,s,  fg,45,s,fg,45,s,  fg,46,s,fg,46,s,  fg,47,s,fg,47,s,  fg,49,s,fg,49,s ]
  }
end

示例输出: 红宝石色


37

您可以使用ANSI转义序列在控制台上执行此操作。我知道这可以在Linux和OSX上使用,我不确定Windows控制台(cmd)是否支持ANSI。

我是用Java完成的,但是想法是一样的。

//foreground color
public static final String BLACK_TEXT()   { return "\033[30m";}
public static final String RED_TEXT()     { return "\033[31m";}
public static final String GREEN_TEXT()   { return "\033[32m";}
public static final String BROWN_TEXT()   { return "\033[33m";}
public static final String BLUE_TEXT()    { return "\033[34m";}
public static final String MAGENTA_TEXT() { return "\033[35m";}
public static final String CYAN_TEXT()    { return "\033[36m";}
public static final String GRAY_TEXT()    { return "\033[37m";}

//background color
public static final String BLACK_BACK()   { return "\033[40m";}
public static final String RED_BACK()     { return "\033[41m";}
public static final String GREEN_BACK()   { return "\033[42m";}
public static final String BROWN_BACK()   { return "\033[43m";}
public static final String BLUE_BACK()    { return "\033[44m";}
public static final String MAGENTA_BACK() { return "\033[45m";}
public static final String CYAN_BACK()    { return "\033[46m";}
public static final String WHITE_BACK()   { return "\033[47m";}

//ANSI control chars
public static final String RESET_COLORS() { return "\033[0m";}
public static final String BOLD_ON()      { return "\033[1m";}
public static final String BLINK_ON()     { return "\033[5m";}
public static final String REVERSE_ON()   { return "\033[7m";}
public static final String BOLD_OFF()     { return "\033[22m";}
public static final String BLINK_OFF()    { return "\033[25m";}
public static final String REVERSE_OFF()  { return "\033[27m";}

7
这有效,并且具有不需要宝石的优点,这可能会使某些人烦恼。
ThomasW 2011年

3
Windows控制台确实支持ANSI代码。
2013年

16

尽管其他答案对大多数人来说都可以完成,但应该提到“正确”的Unix方式。由于所有类型的文本终端均不支持这些序列,因此您可以查询terminfo数据库,该数据库是各种文本终端的功能的抽象。这似乎大多是历史的兴趣-软件终端目前使用普遍支持ANSI序列-但它确实有(至少)一个实际的效果:它有时是有用的,以便能够设置环境变量TERM,以dumb避免所有这些造型,例如在将输出保存到文本文件时。另外,做正确的事感觉很好。:-)

您可以使用ruby-terminfo gem。它需要一些C编译来安装;我能够使用以下命令在Ubuntu 14.10系统下安装它:

$ sudo apt-get install libncurses5-dev
$ gem install ruby-terminfo --user-install

然后,您可以像这样查询数据库(有关可用代码列表,请参见terminfo手册页):

require 'terminfo' 
TermInfo.control("bold")
puts "Bold text"
TermInfo.control("sgr0")
puts "Back to normal."
puts "And now some " + TermInfo.control_string("setaf", 1) + 
     "red" + TermInfo.control_string("sgr0") + " text."

这是我包装的包装类,使事情使用起来更简单。

require 'terminfo'

class Style
  def self.style() 
    @@singleton ||= Style.new
  end

  colors = %w{black red green yellow blue magenta cyan white}
  colors.each_with_index do |color, index|
    define_method(color) { get("setaf", index) }
    define_method("bg_" + color) { get("setab", index) }
  end

  def bold()  get("bold")  end
  def under() get("smul")  end
  def dim()   get("dim")   end
  def clear() get("sgr0")  end

  def get(*args)
    begin
      TermInfo.control_string(*args)
    rescue TermInfo::TermInfoError
      ""
    end
  end
end

用法:

c = Style.style
C = c.clear
puts "#{c.red}Warning:#{C} this is #{c.bold}way#{C} #{c.bg_red}too much #{c.cyan + c.under}styling#{C}!"
puts "#{c.dim}(Don't you think?)#{C}"

上面的Ruby脚本的输出

(编辑)最后,如果您不想使用gem,则可以依赖该tput程序,如下所述 -Ruby示例:

puts "Hi! " + `tput setaf 1` + "This is red!" + `tput sgr0`

4
主要,主要的 +1使用的tput。甚至无法说出多少脱发tput救了我。
皮尔斯2015年

14

我提出了这种方法可能会有所帮助。没什么大不了,但它可以工作:

def colorize(text, color = "default", bgColor = "default")
    colors = {"default" => "38","black" => "30","red" => "31","green" => "32","brown" => "33", "blue" => "34", "purple" => "35",
     "cyan" => "36", "gray" => "37", "dark gray" => "1;30", "light red" => "1;31", "light green" => "1;32", "yellow" => "1;33",
      "light blue" => "1;34", "light purple" => "1;35", "light cyan" => "1;36", "white" => "1;37"}
    bgColors = {"default" => "0", "black" => "40", "red" => "41", "green" => "42", "brown" => "43", "blue" => "44",
     "purple" => "45", "cyan" => "46", "gray" => "47", "dark gray" => "100", "light red" => "101", "light green" => "102",
     "yellow" => "103", "light blue" => "104", "light purple" => "105", "light cyan" => "106", "white" => "107"}
    color_code = colors[color]
    bgColor_code = bgColors[bgColor]
    return "\033[#{bgColor_code};#{color_code}m#{text}\033[0m"
end

使用方法如下:

puts "#{colorize("Hello World")}"
puts "#{colorize("Hello World", "yellow")}"
puts "#{colorize("Hello World", "white","light red")}"

可能的改进可能是:

  • colors并且bgColors每次调用该方法时都会被定义,并且它们不会更改。
  • 添加其他选项,如boldunderlinedim,等。

此方法不适用于工作p,作为p一个不inspect以它的参数。例如:

p "#{colorize("Hello World")}"

将显示“ \ e [0; 38mHello World \ e [0m””

我使用putsprint和Logger gem 对其进行了测试,并且工作正常。


我对此进行了改进,并制作了一个类,所以colorsbgColors是类常量,并且colorize是一个类方法:

编辑:更好的代码样式,定义常量而不是类变量,使用符号代替字符串,添加了更多选项,如粗体,斜体等。

class Colorizator
    COLOURS = { default: '38', black: '30', red: '31', green: '32', brown: '33', blue: '34', purple: '35',
                cyan: '36', gray: '37', dark_gray: '1;30', light_red: '1;31', light_green: '1;32', yellow: '1;33',
                light_blue: '1;34', light_purple: '1;35', light_cyan: '1;36', white: '1;37' }.freeze
    BG_COLOURS = { default: '0', black: '40', red: '41', green: '42', brown: '43', blue: '44',
                   purple: '45', cyan: '46', gray: '47', dark_gray: '100', light_red: '101', light_green: '102',
                   yellow: '103', light_blue: '104', light_purple: '105', light_cyan: '106', white: '107' }.freeze

    FONT_OPTIONS = { bold: '1', dim: '2', italic: '3', underline: '4', reverse: '7', hidden: '8' }.freeze

    def self.colorize(text, colour = :default, bg_colour = :default, **options)
        colour_code = COLOURS[colour]
        bg_colour_code = BG_COLOURS[bg_colour]
        font_options = options.select { |k, v| v && FONT_OPTIONS.key?(k) }.keys
        font_options = font_options.map { |e| FONT_OPTIONS[e] }.join(';').squeeze
        return "\e[#{bg_colour_code};#{font_options};#{colour_code}m#{text}\e[0m".squeeze(';')
    end
end

您可以通过以下方式使用它:

Colorizator.colorize "Hello World", :gray, :white
Colorizator.colorize "Hello World", :light_blue, bold: true
Colorizator.colorize "Hello World", :light_blue, :white, bold: true, underline: true

13

我做了以下工作,无需任何宝石:

def red(mytext) ; "\e[31m#{mytext}\e[0m" ; end
puts red("hello world")

然后,只有那里的引号中的文本是彩色的,并且您将返回到定期计划的程序。


3
对我不起作用。我得到的正是:e[32mSOMETEXT
奥斯卡·戈德森

有一个在第一个转义字符笔误:应该是"\e(...)"代替"e\(...)"
节肢动物

12

我发现了一些:

http://github.com/ssoroka/ansi/tree/master

例子:

puts ANSI.color(:red) { "hello there" }
puts ANSI.color(:green) + "Everything is green now" + ANSI.no_color

http://flori.github.com/term-ansicolor/

例子:

print red, bold, "red bold", reset, "\n"
print red(bold("red bold")), "\n"
print red { bold { "red bold" } }, "\n"

http://github.com/sickill/rainbow

例:

puts "this is red".foreground(:red) + " and " + "this on yellow bg".background(:yellow) + " and " + "even bright underlined!".underline.bright

如果您使用的是Windows,则可能需要执行“ gem install win32console”以启用对颜色的支持。

另外,如果您需要创建自己的gem,则文章Coloring console Ruby-script output也很有用。它说明了如何向字符串添加ANSI着色。您可以使用此知识将其包装在扩展字符串之类的某个类中。


8

这可能对您有帮助: 彩色红宝石输出


1
并改进此链接上的示例,您可以扩展String类,使其更易于使用(“ Hello” .red):class String; def red; colorize(self, "\033[31m"); end; end
Adriano P

3

我发现上面的答案很有用,但是如果我想在使用任何第三方库的情况下为日志输出上色,则不符合要求。以下为我解决了这个问题:

red = 31
green = 32
blue = 34

def color (color=blue)
  printf "\033[#{color}m";
  yield
  printf "\033[0m"
end

color { puts "this is blue" }
color(red) { logger.info "and this is red" }

希望对您有所帮助!

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.