espforge 0.6.0

a scaffolding++ tool for creating esp32 no_std esphal without the hassle
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

//! `--format`: whether a command talks to a person or to a program.
//!
//! The flag and the JSON writer live here rather than in `check.rs`, so a
//! command that grows a machine mode reuses the same spelling, the same
//! document printing and the same trailing newline. A command only offers the
//! flag when a machine consumer exists for it (`check` today); the default is
//! always [`Format::Human`], so adding the flag never changes existing output.

use clap::ValueEnum;
use serde_json::Value;

#[derive(ValueEnum, Debug, Clone, Copy, Default, PartialEq, Eq)]
pub enum Format {
    /// Snippets on stderr, `✓ ... is valid` on stdout.
    #[default]
    Human,
    /// One JSON document on stdout: diagnostics and the board.
    Json,
}

/// Write one JSON document to stdout, pretty-printed, one trailing newline.
pub fn emit(document: &Value) {
    println!(
        "{}",
        serde_json::to_string_pretty(document).expect("a serde_json::Value is serializable")
    );
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn the_default_format_is_human() {
        assert_eq!(Format::default(), Format::Human);
    }

    #[test]
    fn the_cli_spellings_are_human_and_json() {
        assert_eq!(
            Format::value_variants()
                .iter()
                .map(|f| f.to_possible_value().unwrap().get_name().to_string())
                .collect::<Vec<_>>(),
            ["human", "json"]
        );
    }
}