git-plumber 0.1.3

Explore git internals, the plumbing
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
124
125
126
127
128
129
130
131
132
133

use std::fmt;

// Include the generated build information
pub mod built_info {
    include!(concat!(env!("OUT_DIR"), "/built.rs"));
}

pub struct VersionInfo {
    pub version: &'static str,
    pub commit_hash: Option<&'static str>,
    pub commit_hash_short: Option<&'static str>,
    pub git_version: Option<&'static str>,
    pub is_dirty: bool,
    pub target: &'static str,
    pub profile: &'static str,
    pub rustc_version: &'static str,
}

impl Default for VersionInfo {
    fn default() -> Self {
        Self::new()
    }
}

impl VersionInfo {
    pub fn new() -> Self {
        Self {
            version: built_info::PKG_VERSION,
            commit_hash: built_info::GIT_COMMIT_HASH,
            commit_hash_short: built_info::GIT_COMMIT_HASH_SHORT,
            git_version: built_info::GIT_VERSION,
            is_dirty: built_info::GIT_DIRTY.unwrap_or(false),
            target: built_info::TARGET,
            profile: built_info::PROFILE,
            rustc_version: built_info::RUSTC_VERSION,
        }
    }

    pub fn is_development_build(&self) -> bool {
        // Consider it a dev build if:
        // 1. The working directory is dirty, OR
        // 2. We have commits after the last release tag, OR
        // 3. Building in debug mode
        self.is_dirty
            || self.profile == "debug"
            || self.git_version.is_some_and(|git_ver| {
                // Parse git version like "v0.1.0-15-ge1c9641" to detect commits after tag
                git_ver.contains('-') && !git_ver.ends_with("-0-g")
            })
    }

    pub fn short_version(&self) -> String {
        if self.is_development_build() {
            if let Some(git_version) = self.git_version {
                // Parse the git version string like "v0.1.0-15-ge1c9641"
                if git_version.contains('-') {
                    let parts: Vec<&str> = git_version.split('-').collect();
                    if parts.len() >= 3 {
                        let commits_after = parts[parts.len() - 2];
                        let commit_hash = parts[parts.len() - 1]
                            .strip_prefix('g')
                            .unwrap_or(parts[parts.len() - 1]);
                        if self.is_dirty {
                            format!(
                                "v{}-dev+{}.{}.dirty",
                                self.version, commits_after, commit_hash
                            )
                        } else {
                            format!("v{}-dev+{}.{}", self.version, commits_after, commit_hash)
                        }
                    } else if self.is_dirty {
                        format!("v{}-dev+dirty", self.version)
                    } else {
                        format!("v{}-dev", self.version)
                    }
                } else if let Some(hash) = self.commit_hash_short {
                    if self.is_dirty {
                        format!("v{}-dev+dirty.{}", self.version, hash)
                    } else {
                        format!("v{}-dev+{}", self.version, hash)
                    }
                } else {
                    format!("v{}-dev", self.version)
                }
            } else if let Some(hash) = self.commit_hash_short {
                if self.is_dirty {
                    format!("v{}-dev+dirty.{}", self.version, hash)
                } else {
                    format!("v{}-dev+{}", self.version, hash)
                }
            } else {
                format!("v{}-dev", self.version)
            }
        } else {
            format!("v{}", self.version)
        }
    }
}

impl fmt::Display for VersionInfo {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        writeln!(f, "git-plumber\n\nVersion: {}", self.short_version())?;

        if self.is_development_build() {
            if let Some(git_version) = self.git_version {
                writeln!(f, "Git version notation: {git_version}")?;
            }
            if let Some(commit_hash) = self.commit_hash {
                writeln!(f, "Commit hash: {commit_hash}")?;
            }
            if let Some(commits_ahead) = self
                .git_version
                .and_then(|v| v.split('-').nth(1).and_then(|n| n.parse::<u32>().ok()))
            {
                writeln!(f, "Commits since last tag: {commits_ahead}")?;
            }

            if self.is_dirty {
                writeln!(f, "Working directory: dirty")?;
            }

            writeln!(f, "Profile: {}", self.profile)?;
            writeln!(f, "Target: {}", self.target)?;
            writeln!(f, "Rust: {}", self.rustc_version)?;
        }

        Ok(())
    }
}

pub fn get_version_info() -> VersionInfo {
    VersionInfo::new()
}