termprofile 0.2.3

A library to detect and handle terminal color/styling support
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

use anstyle::{Ansi256Color, AnsiColor, Color, Effects, RgbColor, Style};
use rstest::rstest;

use super::ProfileColor;
use crate::TermProfile;

#[rstest]
#[case(RgbColor(220, 90, 90), Ansi256Color(167))]
#[case(RgbColor(20, 73, 18), Ansi256Color(22))]
#[case(RgbColor(255, 0, 0), Ansi256Color(196))]
#[case(RgbColor(255, 255, 255), Ansi256Color(231))]
#[case(RgbColor(250, 250, 250), Ansi256Color(231))]
#[case(RgbColor(0, 0, 0), Ansi256Color(16))]
fn rgb_to_ansi256(#[case] in_color: RgbColor, #[case] out_color: Ansi256Color) {
    let res = TermProfile::Ansi256
        .adapt_color(Color::Rgb(in_color))
        .unwrap();
    assert_eq!(res, Color::Ansi256(out_color));

    let res = TermProfile::Ansi256.adapt_style(
        Style::new()
            .fg_color(Some(in_color.into()))
            .bg_color(Some(in_color.into()))
            .effects(Effects::BOLD),
    );
    assert_eq!(
        res,
        Style::new()
            .fg_color(Some(out_color.into()))
            .bg_color(Some(out_color.into()))
            .effects(Effects::BOLD),
    );
}

#[rstest]
#[case(RgbColor(220, 90, 90), AnsiColor::Yellow)]
#[case(RgbColor(20, 73, 18), AnsiColor::Green)]
#[case(RgbColor(255, 0, 0), AnsiColor::BrightRed)]
#[case(RgbColor(255, 255, 255), AnsiColor::BrightWhite)]
#[case(RgbColor(0, 0, 0), AnsiColor::Black)]
fn rgb_to_ansi16(#[case] in_color: RgbColor, #[case] out_color: AnsiColor) {
    let res = TermProfile::Ansi16
        .adapt_color(Color::Rgb(in_color))
        .unwrap();
    assert_eq!(res, Color::Ansi(out_color));

    let res = TermProfile::Ansi16.adapt_style(
        Style::new()
            .fg_color(Some(in_color.into()))
            .bg_color(Some(in_color.into()))
            .effects(Effects::BOLD),
    );
    assert_eq!(
        res,
        Style::new()
            .fg_color(Some(out_color.into()))
            .bg_color(Some(out_color.into()))
            .effects(Effects::BOLD),
    );
}

#[rstest]
#[case(Ansi256Color(167), AnsiColor::Yellow)]
#[case(Ansi256Color(0), AnsiColor::Black)]
fn ansi256_to_ansi(#[case] in_color: Ansi256Color, #[case] out_color: AnsiColor) {
    let res = TermProfile::Ansi16
        .adapt_color(Color::Ansi256(in_color))
        .unwrap();
    assert_eq!(res, Color::Ansi(out_color));

    let res = TermProfile::Ansi16.adapt_style(
        Style::new()
            .fg_color(Some(in_color.into()))
            .bg_color(Some(in_color.into()))
            .effects(Effects::BOLD),
    );
    assert_eq!(
        res,
        Style::new()
            .fg_color(Some(out_color.into()))
            .bg_color(Some(out_color.into()))
            .effects(Effects::BOLD),
    );
}

#[test]
fn ratatui_reset() {
    let res = TermProfile::Ansi16
        .adapt_color(ratatui::style::Color::Reset)
        .unwrap();
    assert_eq!(res, ratatui::style::Color::Reset);
}

#[test]
fn ascii() {
    let color = Color::Rgb(RgbColor(0, 0, 0));
    let res = TermProfile::NoColor.adapt_color(color);
    assert!(res.is_none());

    let res =
        TermProfile::NoColor.adapt_style(Style::new().fg_color(Some(color)).effects(Effects::BOLD));
    assert_eq!(res, Style::new().effects(Effects::BOLD));
}

#[test]
fn no_tty() {
    let color = Color::Rgb(RgbColor(0, 0, 0));
    let res = TermProfile::NoTty.adapt_color(color);
    assert!(res.is_none());

    let res =
        TermProfile::NoTty.adapt_style(Style::new().fg_color(Some(color)).effects(Effects::BOLD));
    assert_eq!(res, Style::new());
}

#[rstest]
#[case(TermProfile::TrueColor, Color::Rgb(RgbColor(0, 0, 0)))]
#[case(TermProfile::Ansi256, Color::Ansi256(Ansi256Color(0)))]
#[case(TermProfile::Ansi16, Color::Ansi(AnsiColor::Black))]
fn no_change(#[case] profile: TermProfile, #[case] color: Color) {
    let res = profile.adapt_color(color).unwrap();
    assert_eq!(res, color);
}

#[test]
fn profile_color_no_change() {
    let color = ProfileColor::new(Color::Rgb(RgbColor(0, 0, 0)), TermProfile::TrueColor);
    assert_eq!(color.adapt(), Some(RgbColor(0, 0, 0).into()));
}

#[test]
fn profile_color_adapt() {
    let color = ProfileColor::new(Color::Rgb(RgbColor(0, 0, 0)), TermProfile::Ansi256);
    assert_eq!(color.adapt(), Some(Ansi256Color(16).into()));
}

#[test]
fn profile_color_256_override() {
    let color = ProfileColor::new(Color::Rgb(RgbColor(0, 0, 0)), TermProfile::Ansi256).ansi_256(0);
    assert_eq!(color.adapt(), Some(Ansi256Color(0).into()));
}

#[test]
fn profile_color_16_override() {
    let color = ProfileColor::new(Color::Rgb(RgbColor(0, 0, 0)), TermProfile::Ansi16)
        .ansi_16(AnsiColor::BrightBlack);
    assert_eq!(color.adapt(), Some(AnsiColor::BrightBlack.into()));
}

#[test]
fn profile_color_downsample_priority() {
    let color = ProfileColor::new(Color::Rgb(RgbColor(0, 0, 0)), TermProfile::Ansi16).ansi_256(8);
    assert_eq!(color.adapt(), Some(AnsiColor::BrightBlack.into()));
}