scriba 0.4.0

CLI text rendering, prompts, and terminal output utilities
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

//! Custom envelope field names.
//!
//! Override the default `ok`, `format`, `content`, and `meta` field names to
//! match your existing API conventions.
//!
//! Run with:
//! ```sh
//! cargo run --example envelope_custom_fields
//! ```

use scriba::{
    Format, Output,
    Ui,
    envelope::{EnvelopeConfig, EnvelopeFields, EnvelopeLayout, EnvelopeMode, Meta},
};

fn main() -> scriba::Result<()> {
    let output = Output::new()
        .title("Users")
        .data("count", 42u64)
        .paragraph("Query executed successfully.");

    // --- Custom flat field names ---
    let flat_ui = Ui::new()
        .with_format(Format::Json)
        .with_envelope(
            EnvelopeConfig::default()
                .with_mode(EnvelopeMode::Json)
                .with_layout(EnvelopeLayout::Flat)
                .with_fields(EnvelopeFields {
                    ok_field: "success".into(),
                    format_field: "type".into(),
                    content_field: "result".into(),
                    meta_field: "context".into(),
                }),
        );

    println!("=== Custom field names, flat ===");
    println!(r#"  fields: success / type / result / context"#);
    flat_ui.print(&output)?;

    // --- Custom nested field names ---
    let nested_ui = Ui::new()
        .with_format(Format::Json)
        .with_envelope(
            EnvelopeConfig::default()
                .with_mode(EnvelopeMode::Json)
                .with_layout(EnvelopeLayout::Nested)
                .with_fields(EnvelopeFields {
                    ok_field: "success".into(),
                    format_field: "type".into(),
                    content_field: "data".into(),
                    meta_field: "header".into(),
                }),
        );

    let meta = Meta::default()
        .with_command("users list".into())
        .with_extra("region", "eu-west-1");

    println!("\n=== Custom field names, nested ===");
    println!(r#"  fields: success / type / data / header"#);
    nested_ui.print_with_meta(&output, Some(&meta), true)?;

    // --- Omit ok and format fields entirely ---
    let minimal_ui = Ui::new()
        .with_format(Format::Json)
        .with_envelope(
            EnvelopeConfig::default()
                .with_mode(EnvelopeMode::Json)
                .with_show_ok(false)
                .with_show_format(false),
        );

    println!("\n=== Envelope without ok or format fields ===");
    minimal_ui.print(&output)?;

    Ok(())
}