使用 Ruby,如何为终端中的输出执行背景和前景文本着色?
我记得,在编写 Pascal 时,我们都曾经编写自己的textcolor(…)
程序,以使我们的小型教育程序看起来更漂亮和更具表现力。
我将如何在 Ruby 中编写等价的代码?核心库中是否有任何内置支持可以做到这一点?如果没有,添加它的惯用方式是什么?
使用 Ruby,如何为终端中的输出执行背景和前景文本着色?
我记得,在编写 Pascal 时,我们都曾经编写自己的textcolor(…)
程序,以使我们的小型教育程序看起来更漂亮和更具表现力。
我将如何在 Ruby 中编写等价的代码?核心库中是否有任何内置支持可以做到这一点?如果没有,添加它的惯用方式是什么?
着色是我最喜欢的宝石!:-)
看看这个:
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
结合上面的答案,您可以实现类似于 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
作为 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
根据 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
示例输出:
您可以在控制台中使用 ANSI 转义序列来执行此操作。我知道这适用于 Linux 和 Mac OS X,但我不确定 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 characters
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";}
虽然其他答案对大多数人来说都可以很好地完成工作,但应该提到“正确”的 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}"
(编辑)最后,如果您不想需要 gem,您可以依赖该tput
程序,如此处所述– Ruby 示例:
puts "Hi! " + `tput setaf 1` + "This is red!" + `tput sgr0`
我做了这个可以帮助的方法。这没什么大不了的,但它有效:
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
每次调用该方法时都被定义并且它们不会改变。bold
, underline
,dim
等。此方法不适用于p
,其参数也是p
如此。inspect
例如:
p "#{colorize("Hello World")}"
将显示“\e[0;38mHello World\e[0m”
我用puts
、print
和 Logger gem 对其进行了测试,它工作正常。
我对此进行了改进并创建了一个类,所以是类常量并且colors
是类方法:bgColors
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
这是我在不需要任何宝石的情况下使它工作的方法:
def red(mytext) ; "\e[31m#{mytext}\e[0m" ; end
puts red("hello world")
然后只有引号中的文本是彩色的,然后您将返回到您定期安排的程序。
我找到了几个:
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 ,文章Colorizing console Ruby-script output也很有用。它解释了如何为字符串添加 ANSI 着色。您可以使用这些知识将其包装在一些扩展字符串或其他东西的类中。
这可能会对您有所帮助: 彩色红宝石输出
我发现以前的答案很有用。但是,如果我想在不使用任何第三方库的情况下对日志输出等内容进行着色,它们就不符合要求。以下为我解决了这个问题:
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" }