cargo_emit/
pair.rs

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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
/// Emits a `$key`/`$value` pair to Cargo based on [build script outputs].
///
/// This is equivalent to:
///
/// ```
/// println!("cargo:$key=$value");
/// ```
///
/// This is the base macro upon which the other macros are built.
///
/// # Examples
///
/// This can be used to emit arbitrary user-defined metadata.
///
/// ```
/// cargo_emit::pair!("root", "/path/to/root");
/// ```
///
/// or, in case you want it to emit to a custom stream:
///
/// ```
/// let mut stdout = std::io::stdout();
/// cargo_emit::pair!(
///     to: stdout,
///     "root", "/path/to/root"
/// );
/// ```
///
/// The `$key` and `$value` parameters get concatenated into a single formatting
/// string. Formatting runtime values can be done by passing subsequent values.
///
/// ```
/// let name = "foo";
/// cargo_emit::pair!("{lib}dir", "/path/to/{lib}", lib = name);
/// ```
///
/// [build script outputs]: https://doc.rust-lang.org/cargo/reference/build-scripts.html#outputs-of-the-build-script
#[macro_export]
macro_rules! pair {
    (to: $stream:expr, $key:expr, $value:expr $(, $($args:tt)*)?) => {{
        #[allow(unused_imports)]
        use std::{fmt::Write as _, io::Write as _};

        #[allow(clippy::explicit_write)]
        writeln!($stream, concat!("cargo:", $key, "=", $value) $(, $($args)*)?).unwrap()
    }};
    ($key:expr, $value:expr $(, $($args:tt)*)?) => {
        $crate::pair!(to: std::io::stdout(), $key, $value $(, $($args)*)?);
    };
}

#[cfg(test)]
mod tests {
    #[test]
    fn single_literal() {
        insta::assert_display_snapshot!(
            crate::capture_output(|output| {
                crate::pair!(
                    to: output,
                    "KEY", "VALUE"
                );
            }),
            @"cargo:KEY=VALUE\n"
        );
    }

    #[test]
    fn single_with_key_formatted_by_index() {
        insta::assert_display_snapshot!(
            crate::capture_output(|output| {
                crate::pair!(
                    to: output,
                    "{}", "VALUE", "KEY"
                );
            }),
            @"cargo:KEY=VALUE\n"
        );
    }

    #[test]
    fn single_with_key_formatted_by_name() {
        insta::assert_display_snapshot!(
            crate::capture_output(|output| {
                crate::pair!(
                    to: output,
                    "{key}", "VALUE", key = "KEY"
                );
            }),
            @"cargo:KEY=VALUE\n"
        );
    }

    #[test]
    fn single_with_value_formatted_by_index() {
        insta::assert_display_snapshot!(
            crate::capture_output(|output| {
                crate::pair!(
                    to: output,
                    "KEY", "{}", "VALUE"
                );
            }),
            @"cargo:KEY=VALUE\n"
        );
    }

    #[test]
    fn single_with_value_formatted_by_name() {
        insta::assert_display_snapshot!(
            crate::capture_output(|output| {
                crate::pair!(
                    to: output,
                    "KEY", "{value}", value = "VALUE"
                );
            }),
            @"cargo:KEY=VALUE\n"
        );
    }

    #[test]
    fn single_with_key_and_value_formatted_by_index() {
        insta::assert_display_snapshot!(
            crate::capture_output(|output| {
                crate::pair!(
                    to: output,
                    "{}", "{}", "KEY", "VALUE"
                );
            }),
            @"cargo:KEY=VALUE\n"
        );
    }

    #[test]
    fn single_with_key_and_value_formatted_by_name() {
        insta::assert_display_snapshot!(
            crate::capture_output(|output| {
                crate::pair!(
                    to: output,
                    "{key}", "{value}", key = "KEY", value = "VALUE"
                );
            }),
            @"cargo:KEY=VALUE\n"
        );
    }
}