File: README.markdown

package info (click to toggle)
ruby-colorator 1.1.0-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 152 kB
  • sloc: ruby: 163; makefile: 2
file content (47 lines) | stat: -rw-r--r-- 851 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# colorator

Colorize your text for the terminal

[![Build Status](https://travis-ci.org/octopress/colorator.png?branch=master)](https://travis-ci.org/octopress/colorator)

## Example

```ruby
"this string".red
# => \e[31mthis string\e[0m
"my string".blue
# => \e[34mmy string\e[0m
# etc...
```

## Supported Colors

- `red`
- `black`
- `green`
- `yellow`
- `magenta`
- `white`
- `blue`
- `cyan`
- `bold`

## Other supported Ansi methods

- `clear_line`
- `has_ansi?`, `has_color?`
- `strip_ansi`, `strip_color`
- `reset_ansi`, `reset_color`
- `clear_screen`
- `ansi_jump`

## Why

There are a bunch of gems that provide functionality like this, but none have
as simple an API as this. Just call `"string".color` and your text will be
colorized.

## License

MIT. Written as a single Ruby file by Brandon Mathis, converted into a gem by
Parker Moore.