shipflow 0.1.0

A minimalist, git-aware CLI for tracking what you ship
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
134
135
136
137
138
139
140
141
142
143
144

use std::path::{Path, PathBuf};
use std::process::Command;

use crate::error::Result;
use crate::task::LinkedCommit;

#[derive(Debug, Clone)]
pub struct GitContext {
    pub is_repo: bool,
    pub repo_root: Option<PathBuf>,
    pub branch: Option<String>,
}

#[derive(Debug, Clone)]
pub struct CommitSummary {
    pub sha: String,
    pub message: String,
}

pub fn detect(cwd: &Path) -> GitContext {
    let repo_root = repo_root_from(cwd).ok().flatten();
    let branch = repo_root
        .as_ref()
        .and_then(|root| current_branch(root).ok().flatten());

    GitContext {
        is_repo: repo_root.is_some(),
        repo_root,
        branch,
    }
}

pub fn repo_root_from(cwd: &Path) -> Result<Option<PathBuf>> {
    let output = Command::new("git")
        .args(["rev-parse", "--show-toplevel"])
        .current_dir(cwd)
        .output()?;

    if !output.status.success() {
        return Ok(None);
    }

    let root = String::from_utf8_lossy(&output.stdout).trim().to_owned();
    if root.is_empty() {
        Ok(None)
    } else {
        Ok(Some(PathBuf::from(root)))
    }
}

fn current_branch(repo_root: &Path) -> Result<Option<String>> {
    let output = Command::new("git")
        .args(["rev-parse", "--abbrev-ref", "HEAD"])
        .current_dir(repo_root)
        .output()?;

    if !output.status.success() {
        return Ok(None);
    }

    let branch = String::from_utf8_lossy(&output.stdout).trim().to_owned();
    if branch.is_empty() || branch == "HEAD" {
        Ok(None)
    } else {
        Ok(Some(branch))
    }
}

pub fn recent_commits(repo_root: &Path, n: usize) -> Result<Vec<CommitSummary>> {
    let output = Command::new("git")
        .args(["log", &format!("-{n}"), "--pretty=format:%h|%s"])
        .current_dir(repo_root)
        .output()?;

    if !output.status.success() {
        return Ok(Vec::new());
    }

    let text = String::from_utf8_lossy(&output.stdout);
    let commits = text
        .lines()
        .filter_map(|line| {
            let (sha, message) = line.split_once('|')?;
            Some(CommitSummary {
                sha: sha.to_owned(),
                message: message.to_owned(),
            })
        })
        .collect();

    Ok(commits)
}

pub fn validate_commit(repo_root: &Path, sha: &str) -> Result<bool> {
    let output = Command::new("git")
        .args(["cat-file", "-e", &format!("{sha}^{{commit}}")])
        .current_dir(repo_root)
        .output()?;

    Ok(output.status.success())
}

pub fn commit_message(repo_root: &Path, sha: &str) -> Result<Option<String>> {
    let output = Command::new("git")
        .args(["log", "-1", "--pretty=format:%s", sha])
        .current_dir(repo_root)
        .output()?;

    if !output.status.success() {
        return Ok(None);
    }

    let message = String::from_utf8_lossy(&output.stdout).trim().to_owned();
    if message.is_empty() {
        Ok(None)
    } else {
        Ok(Some(message))
    }
}

pub fn linked_commit_from_sha(
    repo_root: &Path,
    sha: &str,
    branch: Option<&str>,
) -> Result<Option<LinkedCommit>> {
    if !validate_commit(repo_root, sha)? {
        return Ok(None);
    }

    let message = commit_message(repo_root, sha)?.unwrap_or_else(|| "(no message)".to_owned());
    Ok(Some(LinkedCommit {
        sha: sha.to_owned(),
        message,
        branch: branch.map(ToOwned::to_owned),
    }))
}

pub fn git_available() -> bool {
    Command::new("git")
        .arg("--version")
        .output()
        .map(|o| o.status.success())
        .unwrap_or(false)
}