rulewright 0.1.1

Executable engineering standards for Rust workspaces
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

//! Compact terminal presentation for the Rulewright CLI.

use console::style;
use tabled::Tabled;

/// Print a section heading to standard error.
pub fn header(text: &str) {
    eprintln!("{}", style(format!("▸ {text}")).bold().cyan());
}

/// Print a subsection heading to standard error.
pub fn subheader(text: &str) {
    eprintln!("{}", style(text).bold().underlined());
}

/// Print a key-value detail.
pub fn kv(key: &str, value: &str) {
    eprintln!(
        "  {} {}",
        style(format!("{key}:")).dim(),
        style(value).bold()
    );
}

/// Print a successful outcome.
pub fn success(message: &str) {
    eprintln!("{} {message}", style("✓").green().bold());
}

/// Print an error outcome.
pub fn error(message: &str) {
    eprintln!("{} {message}", style("✗").red().bold());
}

/// Print a warning outcome.
pub fn warning(message: &str) {
    eprintln!("{} {message}", style("!").yellow().bold());
}

/// Print secondary information.
pub fn detail(text: &str) {
    eprintln!("  {}", style(text).dim());
}

/// Print a blank line.
pub fn blank() {
    eprintln!();
}

/// Print a visual separator.
pub fn separator() {
    eprintln!("{}", style("─".repeat(50)).dim());
}

/// Render tabular data to standard error.
pub fn table<I, T>(data: I)
where
    I: IntoIterator<Item = T>,
    T: Tabled,
{
    eprintln!("{}", tabled::Table::new(data));
}

/// Print the CLI name and version unless quiet output was requested.
pub fn banner(name: &str, version: &str) {
    eprintln!(
        "{} {}\n",
        style(name).bold().cyan(),
        style(format!("v{version}")).dim()
    );
}