communique 1.4.0

Editorialized release notes powered by AI
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

use crate::cli::Cli;

/// Generates a usage spec for the CLI
///
/// https://usage.jdx.dev
#[derive(Debug, usage_rs::Args)]
#[usage(effect = "read")]
pub struct Usage;

/// The spec written to communique.usage.kdl, shared by `communique usage` and
/// the test that keeps the checked-in copy in sync.
fn generate_to_string() -> String {
    format!(
        "// @generated by `communique usage`\n{}",
        Cli::to_kdl().trim_end()
    )
}

impl Usage {
    pub fn run(&self) -> miette::Result<()> {
        println!("{}", generate_to_string());
        Ok(())
    }
}

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

    /// `run` is thin, but it is the only path that actually emits the spec —
    /// leaving it untested meant nothing checked that `communique usage`
    /// succeeds at all.
    #[test]
    fn run_succeeds() {
        assert!(Usage {}.run().is_ok());
    }

    #[test]
    fn test_usage_kdl_in_sync() {
        let generated = generate_to_string();
        let on_disk = std::fs::read_to_string(
            std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("communique.usage.kdl"),
        )
        .expect("communique.usage.kdl should exist");
        assert_eq!(
            generated.trim(),
            on_disk.trim(),
            "communique.usage.kdl is out of sync — run `cargo run -- usage > communique.usage.kdl` to update"
        );
    }

    /// The facade metadata is the source of the emitted spec, so inspect that
    /// metadata directly instead of reparsing KDL through usage-lib.
    #[test]
    fn the_spec_is_a_spec() {
        let spec = Cli::spec();
        assert_eq!(spec.bin, Some("communique"));
        let command = |name: &str| {
            spec.root
                .subcommands
                .iter()
                .copied()
                .find(|command| command.cmd.name == name)
                .unwrap()
        };

        assert_eq!(command("init").effect, Some(usage_rs::spec::Effect::Write));
        assert_eq!(
            command("generate").effect,
            Some(usage_rs::spec::Effect::Read)
        );
        assert_eq!(
            command("sponsors").effect,
            Some(usage_rs::spec::Effect::Read)
        );

        let generate = command("generate");
        let init = command("init");
        assert_eq!(
            generate
                .flags
                .iter()
                .find(|flag| flag.flag.longs.contains(&"github-release"))
                .expect("--github-release")
                .effect,
            Some(usage_rs::spec::Effect::Write),
            "a flag raises what its command does"
        );
        assert_eq!(
            init.flags
                .iter()
                .find(|flag| flag.flag.longs.contains(&"force"))
                .expect("--force")
                .effect,
            Some(usage_rs::spec::Effect::Destructive)
        );
    }
}