spraypaint 0.1.2

Terminal string styling for Rust
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

//! # spraypaint
//!
//! Terminal string styling for Rust.
//!
//! ## Quick Start
//!
//! ```rust,no_run
//! use spraypaint::{paint, Colorize};
//!
//! // Primary API: paint! prints directly (like println!)
//! paint!("{red.bold Error:} something went wrong");
//! paint!("Hello {green.italic world}!");
//! paint!(inline, "{yellow Loading...}");   // no newline
//! paint!(stderr, "{red.bold FATAL:} disk full");
//!
//! // Extension trait: chain styles, then call .paint()
//! "Warning".yellow().on_red().italic().paint();
//!
//! // Compose styled values for format strings / loggers
//! let msg = "critical".red().bold();
//! eprintln!("status: {msg}");
//! ```
//!
//! ## Color Levels
//!
//! spraypaint auto-detects terminal color support via environment variables:
//! - `NO_COLOR` → disable all color
//! - `FORCE_COLOR=3` → force truecolor
//! - `COLORTERM=truecolor` → enable RGB
//!
//! Override programmatically:
//! ```rust,no_run
//! use spraypaint::detect::{set_color_level, ColorLevel};
//! set_color_level(ColorLevel::TrueColor);
//! ```
#![warn(missing_docs)]
#![deny(unsafe_code)]
#![allow(clippy::module_name_repetitions)]

pub(crate) mod ansi;
pub(crate) mod styled;

pub mod color;
pub mod detect;
pub mod ext;
pub mod gradient;
pub mod style;
pub mod utils;

pub use color::Color;
pub use detect::{color_level, set_color_level, ColorLevel};
pub use ext::Colorize;
pub use gradient::Gradient;
pub use style::{Attrs, Style};
pub use styled::Styled;
pub use utils::strip_ansi;

// Macros from the proc-macro crate.
pub use spraypaint_macros::paint;
pub use spraypaint_macros::styled;

/// Convenience re-export: `use spraypaint::prelude::*` brings the most common items into scope.
pub mod prelude {
    pub use crate::color::Color;
    pub use crate::ext::Colorize;
    pub use crate::paint;
    pub use crate::style::Style;
    pub use crate::styled;
}