shadow-rs 0.11.0

A build-time information stored in your rust project
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
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

macro_rules! gen_const {
    ($fn_name:ident,$fn_desc:expr,$fn_body:expr) => {
        pub fn $fn_name() -> String {
            format!("{}\n{}", $fn_desc, $fn_body)
        }
    };
}

const VERSION_BRANCH_CONST: &str = r##"#[allow(dead_code)]
pub const VERSION:&str = shadow_rs::formatcp!(r#"
pkg_version:{}
branch:{}
commit_hash:{}
build_time:{}
build_env:{},{}"#,PKG_VERSION, BRANCH, SHORT_COMMIT, BUILD_TIME, RUST_VERSION, RUST_CHANNEL
);"##;

const VERSION_TAG_CONST: &str = r##"#[allow(dead_code)]
pub const VERSION:&str = shadow_rs::formatcp!(r#"
pkg_version:{}
tag:{}
commit_hash:{}
build_time:{}
build_env:{},{}"#,PKG_VERSION, TAG, SHORT_COMMIT, BUILD_TIME, RUST_VERSION, RUST_CHANNEL
);"##;

const CLAP_VERSION_BRANCH_CONST: &str = r##"#[allow(dead_code)]
#[deprecated = "Replaced with `CLAP_LONG_VERSION`"]
pub const CLAP_VERSION:&str = shadow_rs::formatcp!(r#"{}
branch:{}
commit_hash:{}
build_time:{}
build_env:{},{}"#,PKG_VERSION, BRANCH, SHORT_COMMIT, BUILD_TIME, RUST_VERSION, RUST_CHANNEL
);"##;

const CLAP_VERSION_TAG_CONST: &str = r##"#[allow(dead_code)]
#[deprecated = "Replaced with `CLAP_LONG_VERSION`"]
pub const CLAP_VERSION:&str = shadow_rs::formatcp!(r#"{}
tag:{}
commit_hash:{}
build_time:{}
build_env:{},{}"#,PKG_VERSION, TAG, SHORT_COMMIT, BUILD_TIME, RUST_VERSION, RUST_CHANNEL
);"##;

const CLAP_LONG_VERSION_BRANCH_CONST: &str = r##"#[allow(dead_code)]
pub const CLAP_LONG_VERSION:&str = shadow_rs::formatcp!(r#"{}
branch:{}
commit_hash:{}
build_time:{}
build_env:{},{}"#,PKG_VERSION, BRANCH, SHORT_COMMIT, BUILD_TIME, RUST_VERSION, RUST_CHANNEL
);"##;

const CLAP_LONG_VERSION_TAG_CONST: &str = r##"#[allow(dead_code)]
pub const CLAP_LONG_VERSION:&str = shadow_rs::formatcp!(r#"{}
tag:{}
commit_hash:{}
build_time:{}
build_env:{},{}"#,PKG_VERSION, TAG, SHORT_COMMIT, BUILD_TIME, RUST_VERSION, RUST_CHANNEL
);"##;

const VERSION_CONST_DESC: &str = r#"/// The common version const. It's so easy to use this const."#;

const CLAP_VERSION_CONST_DESC: &str =
    r#"/// The common version const. It's so easy to use this const with CLAP_VERSION."#;

const CLAP_LONG_VERSION_CONST_DESC: &str =
    r#"/// The common version const. It's so easy to use this const with CLAP_VERSION."#;

gen_const!(
    version_branch_const,
    VERSION_CONST_DESC,
    VERSION_BRANCH_CONST
);

gen_const!(version_tag_const, VERSION_CONST_DESC, VERSION_TAG_CONST);

gen_const!(
    clap_version_branch_const,
    CLAP_VERSION_CONST_DESC,
    CLAP_VERSION_BRANCH_CONST
);
gen_const!(
    clap_version_tag_const,
    CLAP_VERSION_CONST_DESC,
    CLAP_VERSION_TAG_CONST
);

gen_const!(
    clap_long_version_branch_const,
    CLAP_LONG_VERSION_CONST_DESC,
    CLAP_LONG_VERSION_BRANCH_CONST
);
gen_const!(
    clap_long_version_tag_const,
    CLAP_LONG_VERSION_CONST_DESC,
    CLAP_LONG_VERSION_TAG_CONST
);

pub(crate) const BUILD_CONST_VERSION: &str = "VERSION";
pub(crate) const BUILD_CONST_CLAP_LONG_VERSION: &str = "CLAP_LONG_VERSION";

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

    #[test]
    fn test_version_fn() {
        assert!(version_branch_const().contains(VERSION_CONST_DESC));
        assert!(version_tag_const().contains(VERSION_TAG_CONST));
        assert!(clap_version_branch_const().contains(CLAP_VERSION_BRANCH_CONST));
        assert!(clap_version_tag_const().contains(CLAP_VERSION_CONST_DESC));
        assert!(clap_long_version_branch_const().contains(CLAP_LONG_VERSION_BRANCH_CONST));
        assert!(clap_long_version_tag_const().contains(CLAP_LONG_VERSION_CONST_DESC));
    }
}