term_ansi 0.2.4

A super lightweight macros crates to add ANSI Codes to your project
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

# 🌈 term_ansi

[![Crates.io](https://img.shields.io/crates/v/term_ansi.svg)](https://crates.io/crates/term_ansi)
[![Documentation](https://docs.rs/term_ansi/badge.svg)](https://docs.rs/term_ansi)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

> Colorize your terminal output with ease! 🎨✨

`term_ansi` is a super-light weight Rust crate that provides a simple and intuitive way to add colors and formatting to your terminal output using ANSI escape codes. With support for various predefined colors and custom RGB values, you can make your CLI applications more visually appealing and user-friendly.

## ⚠️ Important Version Notice

**Versions before v0.2.2 are unstable.**

**v0.2.2 and above are fully tested and stable. We strongly recommend using this version or later for production use.**

## 📚 Table of Contents

- [Features](#-features)
- [Installation](#-installation)
- [Usage](#-usage)
  - [Basic Colors](#basic-colors)
  - [Nested Colors](#nested-colors)
  - [Custom RGB Colors](#custom-rgb-colors)
- [Available Macros](#-available-macros)
- [Examples](#-examples)
- [Contributing](#-contributing)
- [License](#-license)

## ✨ Features

- 🎨 Easy-to-use macros for applying colors
- 🌈 Support for 8 predefined colors
- 🔢 Custom RGB color support
- 🪆 Nested color application
- 🧵 Thread-safe color context management

## 📦 Installation

Add `term_ansi` to your `Cargo.toml`:

```toml
[dependencies]
term_ansi = "0.2.2"  # Make sure to use version 0.2.2 or later
```

## 🚀 Usage

First, import the crate in your Rust file:

```rust
use term_ansi::*;
```

### Basic Colors

Apply colors to your text using the provided macros:

```rust
println!("{}", red!("This is red text"));
println!("{}", green!("This is green text"));
println!("{}", blue!("This is blue text"));
```

### Nested Colors

You can nest color macros for more complex formatting:

```rust
println!("{}", white!("This is {} with {} color", red!("red"), green!("green")));
```

### Custom RGB Colors

Use the `colour!` macro to apply custom RGB colors:

```rust
println!("{}", colour!(255, 128, 0, "This is orange text"));
```

## 📚 Available Macros

- `red!`: Apply red color
- `green!`: Apply green color
- `blue!`: Apply blue color
- `white!`: Apply white color
- `black!`: Apply black color
- `yellow!`: Apply yellow color
- `magenta!`: Apply magenta color
- `cyan!`: Apply cyan color
- `colour!`: Apply a custom RGB color

## 💡 Examples

### Simple Error Message

```rust
println!("{}", red!("Error: {}", "File not found"));
```

### Colorful Status Message

```rust
println!("{} {} {}", green!("✓"), blue!("Building project:"), yellow!("in progress"));
```

### Nested Color Formatting

```rust
println!("{}", white!("Status: {} | {}", green!("OK"), red!("Failed: {}", 3)));
```

### Custom Color Gradient

```rust
for i in 0..=255 {
    print!("{}", colour!(i, 0, 255 - i, "█"));
}
println!();
```

## 🤝 Contributing

Contributions are welcome! Do discuss any improvements in the Issues first : )
Please make sure to update tests as appropriate and adhere to the existing coding style.

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---

Happy coding! Hope it helps 🦀