term_colr 0.1.0

A super fast short one-liner about your crate
Documentation 
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

# term_colr

A simple Rust library for adding color to your terminal output using ASCII escape codes.

## Features

- Easy to use macros for coloring text.
- Supports foreground and background colors.
- Supports text formatting like bold, underline and italic.
- Supports RGB, HSL, and HSV colors.
- Nestable colors.

## Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
term_colr = "0.1.0"
```

And then in your code:

```rust
use term_colr::{red, blue, green, bg_yellow, bold, italic, underline, rgb, hsl, hsv, bg_rgb, bg_hsl, bg_hsv};

fn main() {
    println!("This is the default color.");
    println!("{}", red!("This is red!"));
    println!("{}", blue!("This is blue!"));
    println!("{}", green!("This is green!"));
    println!("{}", bg_yellow!("This has a yellow background!"));
    println!("{} and this is also red!", red!("This is red"));
    println!("{}", blue!("This is blue {}!", green!("and this is green")));
    println!("{}", bold!("This is bold text."));
    println!("{}", italic!("This is italic text."));
    println!("{}", underline!("This is underlined text."));
    println!("{}", rgb!(255, 0, 0, "This is bright red using RGB!"));
    println!("{}", hsl!(120.0, 1.0, 0.5, "This is green using HSL!"));
    println!("{}", hsv!(240.0, 1.0, 1.0, "This is blue using HSV!"));
    println!("{}", bg_rgb!(100, 150, 200, "Custom background color using RGB!"));
    println!("{}", bg_hsl!(180.0, 0.5, 0.5, "Custom background color using HSL!"));
    println!("{}", bg_hsv!(270.0, 0.7, 0.9, "Custom background color using HSV!"));
}
```

## Available Macros and Functions

### Foreground Colors

- `black!(...)`
- `red!(...)`
- `green!(...)`
- `yellow!(...)`
- `blue!(...)`
- `white!(...)`

### Background Colors

- `bg_red!(...)`
- `bg_green!(...)`
- `bg_blue!(...)`
- `bg_yellow!(...)`
- `bg_gray!(...)`

### Formatting

- `bold!(...)`
- `italic!(...)`
- `underline!(...)`

### Advanced Colors

#### RGB
- `rgb!(r, g, b, ...)`: Applies a foreground color using RGB values.
- `bg_rgb!(r, g, b, ...)`: Applies a background color using RGB values.

*Example:*
```rust
println!("{}", rgb!(255, 0, 0, "This is bright red"));
println!("{}", bg_rgb!(0, 0, 255, "This has a blue background"));
```

#### HSL
- `hsl!(h, s, l, ...)`: Applies a foreground color using HSL values.
- `bg_hsl!(h, s, l, ...)`: Applies a background color using HSL values.

*Example:*
```rust
println!("{}", hsl!(120.0, 1.0, 0.5, "This is green"));
println!("{}", bg_hsl!(0.0, 0.0, 0.5, "This has a gray background"));
```

#### HSV
- `hsv!(h, s, v, ...)`: Applies a foreground color using HSV values.
- `bg_hsv!(h, s, v, ...)`: Applies a background color using HSV values.

*Example:*
```rust
println!("{}", hsv!(240.0, 1.0, 1.0, "This is blue"));
println!("{}", bg_hsv!(300.0, 0.5, 0.7, "This has a purple background"));
```

### Utility Functions

These functions are public and can be used for color conversions if needed.

- `hsl_to_rgb(h: f64, s: f64, l: f64) -> (u8, u8, u8)`: Converts HSL color values to RGB.
- `hsv_to_rgb(h: f64, s: f64, v: f64) -> (u8, u8, u8)`: Converts HSV color values to RGB.
- `reset_all() -> &'static str`: Returns the ANSI code to reset all terminal formatting.