vcs-runner 0.7.0

Subprocess runner for jj and git with retry, repo detection, and structured jj output parsing
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

mod detect;
mod error;
#[cfg(feature = "jj-parse")]
mod parse;
mod runner;
mod types;

pub use detect::{VcsBackend, detect_vcs};
pub use error::RunError;
#[cfg(feature = "jj-parse")]
pub use parse::{
    BOOKMARK_TEMPLATE, LOG_TEMPLATE, BookmarkParseResult, LogParseResult, parse_bookmark_output,
    parse_log_output, parse_remote_list,
};
pub use runner::{
    RunOutput, binary_available, binary_version, is_transient_error, run_cmd, run_cmd_in,
    run_cmd_in_with_env, run_cmd_inherited, run_git, run_git_with_retry, run_jj,
    run_jj_with_retry, run_with_retry,
};
#[cfg(feature = "jj-parse")]
pub use types::{
    Bookmark, ConflictState, ContentState, GitRemote, LogEntry, RemoteStatus, WorkingCopy,
};

/// Check whether the `jj` binary is available on PATH.
pub fn jj_available() -> bool {
    binary_available("jj")
}

/// Get the jj version string, if available.
pub fn jj_version() -> Option<String> {
    binary_version("jj")
}

/// Check whether the `git` binary is available on PATH.
pub fn git_available() -> bool {
    binary_available("git")
}

/// Get the git version string, if available.
pub fn git_version() -> Option<String> {
    binary_version("git")
}

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

    #[test]
    fn jj_available_returns_bool() {
        let _ = jj_available();
    }

    #[test]
    fn jj_version_returns_option() {
        let version = jj_version();
        if jj_available() {
            let v = version.expect("should have version when jj is available");
            assert!(v.contains("jj"));
        } else {
            assert!(version.is_none());
        }
    }

    #[test]
    fn git_available_returns_bool() {
        let _ = git_available();
    }

    #[test]
    fn git_version_returns_option() {
        let version = git_version();
        if git_available() {
            let v = version.expect("should have version when git is available");
            assert!(v.contains("git"));
        } else {
            assert!(version.is_none());
        }
    }
}