Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Kabie/dye
Dyeing your terminal!
https://github.com/Kabie/dye
elixir
Last synced: 2 months ago
JSON representation
Dyeing your terminal!
- Host: GitHub
- URL: https://github.com/Kabie/dye
- Owner: Kabie
- Created: 2014-12-06T20:37:43.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-03-02T18:31:26.000Z (10 months ago)
- Last Synced: 2024-10-12T22:58:14.291Z (3 months ago)
- Topics: elixir
- Language: Elixir
- Size: 139 KB
- Stars: 21
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - A library for dyeing your terminal output. (Miscellaneous)
- fucking-awesome-elixir - dye - A library for dyeing your terminal output. (Miscellaneous)
- awesome-elixir - dye - A library for dyeing your terminal output. (Miscellaneous)
README
Dye
===
Note: This lib uses uppercase sigil modifiers. So only works with elixir >= 1.1.0.
`use Dye` will replaces sigils: `~s` and `~S`.
## Usage
```elixir
iex(1)> use Dye
Dye
iex(2)> ~s"Red text"r
"\e[31mRed text\e[0m"
iex(3)> ~s"Bright red text"R
"\e[91mBright red text\e[0m"
iex(4)> ~s"Bright red text with green background"Rg
"\e[42;91mBright red text with green background\e[0m"
iex(5)> ~s"Underline"u
"\e[4mUnderline\e[0m"
iex(6)> ~s"Underline red text"ur
"\e[31;4mUnderline red text\e[0m"
iex(7)> ~s"Underline red text with bright green background"urG
"\e[102;31;4mUnderline red text with bright green background\e[0m"
```
## Color Modifiers
> $ mix test
The first color modifier will be used as text color. If you only want to set background, you can set text then use `I` to inverse the color.
```
d: Default
k: Black
r: Red
g: Green
y: Yellow
b: Blue
m: Magenta
c: Cyan
w: White
K: Bright Black
R: Bright Red
G: Bright Green
Y: Bright Yellow
B: Bright Blue
M: Bright Magenta
C: Bright Cyan
W: Bright White
```
## Special Modifiers
```
e: Don't reset at the end
I: Inverse text and background color
D: Bold
i: Italic
u: Underline
l: Blink slow
L: Blink rapid
```
## Call `sigil_s/sigil_S` directly
The default implementation uses macro, which limits the modifiers can only be char list literal. The following won't work:
```elixir
mods = 'Rg'
sigil_S(<<"foo">>, mods)
```
To use the function implementation, simply do:
```elixir
use Dye, func: true
```