philiprehberger-color

Terminal ANSI color and styling with auto-detection

Requirements

Ruby >= 3.1

Installation

Add to your Gemfile:

gem "philiprehberger-color"

Or install directly:

gem install philiprehberger-color

Usage

require "philiprehberger/color"

Named Colors and Styles

Apply standard ANSI colors directly, or chain styles for compound effects:

puts Philiprehberger::Color.red("Error!")
puts Philiprehberger::Color.green("Success!")
puts Philiprehberger::Color.bright_cyan("Info")

puts Philiprehberger::Color.bold.red.call("Bold red")
puts Philiprehberger::Color.italic.yellow.call("Italic yellow")
puts Philiprehberger::Color.dim.underline.white.call("Dim underlined")

RGB and Hex Colors

Use 24-bit true color with RGB values or hex strings:

puts Philiprehberger::Color.rgb(255, 165, 0).call("Orange")
puts Philiprehberger::Color.hex("#ff6432").call("Coral")
puts Philiprehberger::Color.bold.rgb(100, 200, 255).call("Bold sky blue")

Background Colors

Set background colors by name, RGB, or hex, and combine them with foreground styles:

puts Philiprehberger::Color.bg(:yellow).call("Yellow background")
puts Philiprehberger::Color.bg(:red).bold.white.call("White on red")
puts Philiprehberger::Color.bg_rgb(0, 0, 128).bright_white.call("White on navy")
puts Philiprehberger::Color.bg_hex("#663399").bold.call("Bold on purple")

Detection

Color output is automatically enabled when stdout is a TTY. Control it with environment variables:

Philiprehberger::Color.enabled? # => true (when TTY)

# Disable all color output:  NO_COLOR=1
# Force color output:        FORCE_COLOR=1

Rainbow Text

Apply cycling colors (red, yellow, green, cyan, blue, magenta) to each character:

puts Philiprehberger::Color.rainbow("Hello, world!")

Stripping ANSI Codes

require "philiprehberger/color"

colored = Philiprehberger::Color.red("hello")
Philiprehberger::Color.strip(colored)           # => "hello"
Philiprehberger::Color.visible_length(colored)   # => 5

API

Named Colors

Method	Code
`Color.black(str)`	30
`Color.red(str)`	31
`Color.green(str)`	32
`Color.yellow(str)`	33
`Color.blue(str)`	34
`Color.magenta(str)`	35
`Color.cyan(str)`	36
`Color.white(str)`	37
`Color.bright_black(str)`	90
`Color.bright_red(str)`	91
`Color.bright_green(str)`	92
`Color.bright_yellow(str)`	93
`Color.bright_blue(str)`	94
`Color.bright_magenta(str)`	95
`Color.bright_cyan(str)`	96
`Color.bright_white(str)`	97

Styling

Method	Description
`Color.bold`	Returns chainable Styler with bold
`Color.dim`	Returns chainable Styler with dim
`Color.italic`	Returns chainable Styler with italic
`Color.underline`	Returns chainable Styler with underline
`Color.rgb(r, g, b)`	Returns Styler with 24-bit foreground color
`Color.hex(hex_string)`	Returns Styler with hex foreground color
`Color.bg(color_name)`	Returns Styler with background color
`Color.bg_rgb(r, g, b)`	Returns Styler with 24-bit background color
`Color.bg_hex(hex_string)`	Returns Styler with hex background color

Detection

Method	Description
`Color.enabled?`	`true` if stdout is a TTY and `NO_COLOR` is not set

Set NO_COLOR to disable color output. Set FORCE_COLOR to force color output regardless of TTY.

Utilities

Method	Description
`Color.rainbow(str)`	Apply cycling rainbow colors to each character
`Color.strip(str)`	Remove all ANSI escape sequences from a string
`Color.visible_length(str)`	Return display width of a string excluding ANSI codes

Development

bundle install
bundle exec rspec
bundle exec rubocop

Support

If you find this project useful:

⭐ Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT