standout 9.0.0

Styled CLI template rendering with automatic terminal detection
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

use clap::Command;
use console::Style;
use serde_json::json;
use serial_test::serial;
use standout::cli::FnHandler;
use standout::cli::{App, Output};
use standout::views::list_view;
use standout::EmbeddedTemplates;
use standout::{OutputMode, Theme};
use standout_test::TestHarness;

const TEMPLATES: &[(&str, &str)] = &[("say", "[missing_style]hello[/missing_style]")];

#[test]
#[serial]
fn app_template_unknown_tag_degrades_to_text_and_warns() {
    let app = App::builder()
        .templates(EmbeddedTemplates::new(TEMPLATES, ""))
        .command_with(
            "say",
            FnHandler::new(|_m, _ctx| Ok(Output::Render(json!({})))),
            |cfg| cfg,
        )
        .unwrap()
        .build()
        .unwrap();

    let result = TestHarness::new().output_mode(OutputMode::Term).run(
        &app,
        Command::new("app").subcommand(Command::new("say")),
        ["app", "say"],
    );

    result.assert_success();
    assert_eq!(result.stdout(), "hello");
    assert!(!result.stdout().contains("?]"));
    assert_eq!(
        result.warnings(),
        ["Unresolved style tag(s) degraded to unstyled text: missing_style"]
    );
}

#[test]
fn framework_templates_fail_build_when_the_resolved_theme_lacks_their_tags() {
    let result = App::builder()
        .templates(EmbeddedTemplates::new(TEMPLATES, ""))
        .include_framework_styles(false)
        .build();

    let err = match result {
        Ok(_) => panic!("build should reject framework templates without framework styles"),
        Err(err) => err.to_string(),
    };

    assert!(err.contains("framework template"), "{err}");
    assert!(err.contains("standout-muted"), "{err}");
    assert!(err.contains(".include_framework_styles(true)"), "{err}");
    assert!(err.contains(".theme(...)"), "{err}");
    assert!(err.contains(".include_framework_templates(false)"), "{err}");
}

#[test]
fn missing_default_theme_names_builder_calls_that_supply_it() {
    let err = match App::builder()
        .templates(EmbeddedTemplates::new(TEMPLATES, ""))
        .default_theme("missing")
        .build()
    {
        Ok(_) => panic!("default_theme without configured styles must fail"),
        Err(error) => error.to_string(),
    };

    assert!(err.contains("theme `missing` not found"), "{err}");
    assert!(err.contains(".styles(embed_styles!"), "{err}");
    assert!(err.contains(".styles_dir(\"path/to/styles\")"), "{err}");
    assert!(err.contains(".default_theme(...)"), "{err}");
    assert!(err.contains(".theme(...)"), "{err}");
}

#[test]
#[serial]
fn app_theme_overlays_framework_styles_per_tag() {
    let app = App::builder()
        .templates(EmbeddedTemplates::new(TEMPLATES, ""))
        .theme(Theme::new().add("standout-muted", Style::new().red().force_styling(true)))
        .command_with(
            "list",
            FnHandler::new(|_m, _ctx| {
                Ok(Output::Render(
                    list_view(vec!["one"])
                        .total_count(3)
                        .filter_summary("status=pending")
                        .build(),
                ))
            }),
            |config| config.template_name("standout/list-view"),
        )
        .unwrap()
        .build()
        .unwrap();

    let result = TestHarness::new().output_mode(OutputMode::Term).run(
        &app,
        Command::new("app").subcommand(Command::new("list")),
        ["app", "list"],
    );

    result.assert_success();
    assert!(
        result.stdout().contains("\x1b[31m"),
        "app override for framework tag should win:\n{}",
        result.stdout()
    );
    assert!(!result.stdout().contains("?]"));
}