colors 0.0.1

A library that helps you color and style your text
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

#![crate_id = "colors"]
#![crate_type="lib"]

//! Colors
//! ======
//!
//!   Colors is a library that helps you color and style your text. It's a port of the colors
//!   library from [NodeJS/NPM][NPM colors], mostly undertaken as a learning exercise :).
//!
//! Examples
//! --------
//!     
//!     use colors::Style; // Import this to add colors to your string types
//!
//!     println!("{}", "I'm now magically printed in green!".green());
//!
//!   If you prefer to not have the traits added to your &str and strings then just call style
//!   directly, like so:
//!
//!     use colors::{Styles,style};
//!
//!     println!("{}", style(Styles::Blue, "I'm now blue!"))
//! 
//!   Although with the former style you get a nifty chaining syntax:
//!
//!     use colors::Style;
//!     println!("{}", "Bolded, underlined, and red!".bold().underline().red());
//!   
//! Issues
//! ------
//!
//! - You may have noticed a problem in the examples, we lose the native string substitution that
//!   Rusts "println!" macro comes with. This is pretty unfortunate and it looks like it's
//!   unavoidable. According to the [documentation][format], the compiler requires that the passed
//!   value be a string literal in order to enforce validity checking. If you know of a work around
//!   please submit a pull request.
//!
//! - This whole technique is also pretty un-rusty. Dynamically allocating a bunch Strings in order
//!   to wrap them in fancy Unicode characters isn't going to be very efficient. As an alternative
//!   you can use the nifty [TerminfoTerminal][] from Rusts standard library.
//!
//! Missing from Port / Todo
//! ------------------------
//! 
//! - Extra (silly) styles
//! - Color themes
//! - String substitution, for reasons given above
//!
//! [NPM colors]: https://www.npmjs.org/package/colors
//! [format]: http://doc.rust-lang.org/std/fmt/index.html#usage
//! [TerminfoTerminal]: http://doc.rust-lang.org/term/terminfo/struct.TerminfoTerminal.html

#![feature(phase)]
#[phase(plugin)]
extern crate regex_macros;
extern crate regex;
extern crate libc;

pub use styles::StylePoint;
pub use styles::Styles;
pub use traits::Style;

mod styles;
mod traits;
mod env;

pub fn style(style: Styles, original: &str) -> String {
    let should_style = env::supports_colors();

    style_maybe(style, original, should_style)
}

pub fn style_maybe(style: Styles, original: &str, should_style: bool) -> String {
    if !should_style { return String::new() }

    let points = StylePoint::new(style);
    
    points.get_prefix() + original + points.get_suffix()
}