sen 0.8.1

Script to System CLI Engine - A type-safe, macro-powered CLI framework
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
116
117
118
119
120
121
122
123

//! Build information module.
//!
//! This module provides access to compile-time build information such as:
//! - Package name and version
//! - Git commit hash
//! - Build timestamp
//! - Rust compiler version
//! - Target architecture

#[cfg(feature = "build-info")]
pub mod built_info {
    include!(concat!(env!("OUT_DIR"), "/built.rs"));
}

/// Get formatted version information.
///
/// Returns a multi-line string containing:
/// - Package name and version
/// - Target architecture
/// - Build timestamp
/// - Git commit hash (if available)
/// - Rust compiler version
///
/// # Example
///
/// ```ignore
/// println!("{}", sen::build_info::version_info());
/// ```
///
/// Output:
/// ```text
/// sen 0.1.0 (x86_64-apple-darwin)
/// Built: 2024-11-24 12:34:56 UTC
/// Commit: a1b2c3d
/// Rustc: 1.75.0
/// ```
#[cfg(feature = "build-info")]
pub fn version_info() -> String {
    format!(
        "{} {} ({})\nBuilt: {}\nCommit: {}\nRustc: {}",
        built_info::PKG_NAME,
        built_info::PKG_VERSION,
        built_info::TARGET,
        built_info::BUILT_TIME_UTC,
        built_info::GIT_COMMIT_HASH.unwrap_or("unknown"),
        built_info::RUSTC_VERSION
    )
}

/// Get short version string (package version only).
///
/// # Example
///
/// ```ignore
/// println!("Version: {}", sen::build_info::version_short());
/// ```
#[cfg(feature = "build-info")]
pub fn version_short() -> &'static str {
    built_info::PKG_VERSION
}

/// Get package name.
#[cfg(feature = "build-info")]
pub fn package_name() -> &'static str {
    built_info::PKG_NAME
}

/// Get git commit hash (if available).
#[cfg(feature = "build-info")]
pub fn git_commit() -> Option<&'static str> {
    built_info::GIT_COMMIT_HASH
}

/// Get build timestamp.
#[cfg(feature = "build-info")]
pub fn build_time() -> &'static str {
    built_info::BUILT_TIME_UTC
}

/// Get target triple.
#[cfg(feature = "build-info")]
pub fn target() -> &'static str {
    built_info::TARGET
}

// Fallback implementations when build-info feature is disabled
#[cfg(not(feature = "build-info"))]
pub fn version_info() -> String {
    format!("{} {}", env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION"))
}

#[cfg(not(feature = "build-info"))]
pub fn version_short() -> &'static str {
    env!("CARGO_PKG_VERSION")
}

#[cfg(not(feature = "build-info"))]
pub fn package_name() -> &'static str {
    env!("CARGO_PKG_NAME")
}

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

    #[test]
    fn test_version_info_not_empty() {
        let info = version_info();
        assert!(!info.is_empty());
    }

    #[test]
    fn test_version_short() {
        let version = version_short();
        assert!(!version.is_empty());
    }

    #[test]
    fn test_package_name() {
        let name = package_name();
        assert_eq!(name, "sen");
    }
}