cnxt 0.1.5

Coloring made simple, for your terminal.
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

<div align="center">
    <img src="./assets/banner-cli.gif" alt="banner">
    <p>Run <code>cargo run --example banner -r</code> to print the Banner!</p>
</div>

# Colored Next (CNXT)

[![crates.io](https://api.lance.fun/badge/cratesio/cnxt)](https://crates.io/crates/cnxt)

An enhanced fork of [colored](https://github.com/colored-rs/colored) offering superior performance and terminal handling.

Why CNXT?

1. **Optimized Performance**: Utilizes `Cow` for intelligent memory management [(Inspired by PR#135)](https://github.com/colored-rs/colored/pull/135)
2. **Modern Codebase**: Removed legacy code and streamlined implementation
3. **Advanced Terminal Support**: Sophisticated terminal capability detection with automatic color downgrading

## Usage

Coloring your terminal made simple. You already know how to do it.

![usage](./assets/usage.png)

### Essential Configuration


1. For **Windows targets**, add this to enable colors in **Windows CMD**:
    ```rust
    #[cfg(windows)]
    cnxt::control::set_virtual_terminal(true);
    ```

    Comparison showing how Windows CMD displays colors before and after enabling virtual terminal.

    ![comparison](./assets/set_virtual_terminal_comparison.png)

2. CNXT dynamically detects terminal color support across three tiers:
    - `Ansi16` (16 colors)
    - `Ansi256` (256 colors)
    - `TrueColor`
     
    When using colors beyond your terminal's capabilities, CNXT automatically **downgrades** them to the maximum supported level.

    Manual control options:
    ```rust
    use cnxt::control::{set_should_colorize, ShouldColorize};
    
    // Environment-based detection level (default)
    set_should_colorize(ShouldColorize::from_env());

    // Explicit configuration
    set_should_colorize(ShouldColorize::YesWithTrueColor);  // Force truecolor
    set_should_colorize(ShouldColorize::YesWithAnsi256);    // Force 256-color
    set_should_colorize(ShouldColorize::No);                // Disable colors
    set_should_colorize(ShouldColorize::Yes);               // Enable colors with auto-detect level

    // Manual color fallback
    use cnxt::Color;
    let truecolor = Color::TrueColor { r: 166, g: 227, b: 161 };
    let ansi16 = truecolor.fallback_to_ansi16();
    let ansi256 = truecolor.fallback_to_ansi256();
    ```

3. **Optional Terminal Detection**: By default, CNXT automatically detects terminal capabilities, but you can disable this feature:

    ```toml
    [dependencies]
    cnxt = { version = "0", default-features = false }
    ```

    This will enable TrueColor support without terminal capability detection.

## License

CNXT maintains the original [MPL-2.0 License](https://www.mozilla.org/en-US/MPL/2.0/) from the [colored](https://github.com/colored-rs/colored) project.