vcs_runner/
lib.rs

1//! VCS-specific helpers built on [`procpilot`]. Adds jj/git shorthand
2//! wrappers, repo detection, and output parsers.
3//!
4//! For generic subprocess execution (stdin, retry, timeout, custom envs),
5//! use [`procpilot::Cmd`] directly — it's re-exported here for convenience.
6
7mod detect;
8mod error;
9#[cfg(feature = "git-parse")]
10mod parse_git;
11#[cfg(feature = "jj-parse")]
12mod parse_jj;
13mod runner;
14mod types;
15
16pub use detect::{VcsBackend, detect_vcs};
17pub use error::RunError;
18#[cfg(feature = "git-parse")]
19pub use parse_git::parse_git_diff_name_status;
20#[cfg(feature = "jj-parse")]
21pub use parse_jj::{
22    BOOKMARK_TEMPLATE, LOG_TEMPLATE, BookmarkParseResult, LogParseResult, parse_bookmark_output,
23    parse_diff_summary, parse_log_output, parse_remote_list,
24};
25pub use runner::{
26    git_merge_base, is_transient_error, jj_current_operation_id, jj_divergent_change_ids,
27    jj_is_divergent_at_operation, jj_merge_base, jj_op_restore, jj_operation_log, run_git,
28    run_git_cancellable, run_git_utf8, run_git_utf8_cancellable, run_git_utf8_with_retry,
29    run_git_utf8_with_retry_cancellable, run_git_utf8_with_timeout, run_git_with_retry,
30    run_git_with_retry_cancellable, run_git_with_timeout, run_jj, run_jj_cancellable, run_jj_utf8,
31    run_jj_utf8_cancellable, run_jj_utf8_ignore_wc, run_jj_utf8_with_retry,
32    run_jj_utf8_with_retry_cancellable, run_jj_utf8_with_timeout, run_jj_with_retry,
33    run_jj_with_retry_cancellable, run_jj_with_timeout,
34};
35
36// Re-export procpilot's generic subprocess API so vcs-runner consumers have
37// one dependency. Prefer these for anything non-VCS-specific.
38pub use procpilot::{
39    Cmd, CmdDisplay, DefaultRunner, Redirection, RetryPolicy, RunOutput, Runner,
40    STREAM_SUFFIX_SIZE, SpawnedProcess, StdinData, binary_available, binary_version,
41    default_transient,
42};
43
44pub use types::JjOperation;
45#[cfg(any(feature = "jj-parse", feature = "git-parse"))]
46pub use types::{FileChange, FileChangeKind};
47#[cfg(feature = "jj-parse")]
48pub use types::{Bookmark, ConflictState, ContentState, GitRemote, LogEntry, RemoteStatus, WorkingCopy};
49
50/// Common types and helpers for everyday VCS subprocess work.
51///
52/// `use vcs_runner::prelude::*;` brings in procpilot's standard set
53/// (`Cmd`, `RunError`, `RunOutput`, `Redirection`, `RetryPolicy`,
54/// `StdinData`, `SpawnedProcess`) plus the VCS-specific helpers
55/// (`run_jj`, `run_git`, retry/timeout variants, `jj_merge_base`,
56/// `git_merge_base`, `is_transient_error`, and the binary-availability
57/// checks).
58///
59/// Parser types and constants (`LogEntry`, `BOOKMARK_TEMPLATE`, …) stay
60/// out of the prelude — those callers know they need them and can
61/// import explicitly.
62pub mod prelude {
63    pub use procpilot::prelude::*;
64
65    pub use crate::{
66        VcsBackend, detect_vcs, git_available, git_merge_base, git_version, is_transient_error,
67        jj_available, jj_current_operation_id, jj_divergent_change_ids,
68        jj_is_divergent_at_operation, jj_merge_base, jj_op_restore, jj_operation_log, jj_version,
69        run_git, run_git_cancellable, run_git_utf8, run_git_utf8_cancellable,
70        run_git_utf8_with_retry, run_git_utf8_with_retry_cancellable, run_git_utf8_with_timeout,
71        run_git_with_retry, run_git_with_retry_cancellable, run_git_with_timeout, run_jj,
72        run_jj_cancellable, run_jj_utf8, run_jj_utf8_cancellable, run_jj_utf8_ignore_wc,
73        run_jj_utf8_with_retry, run_jj_utf8_with_retry_cancellable, run_jj_utf8_with_timeout,
74        run_jj_with_retry, run_jj_with_retry_cancellable, run_jj_with_timeout,
75    };
76}
77
78/// Check whether the `jj` binary is available on PATH.
79pub fn jj_available() -> bool {
80    binary_available("jj")
81}
82
83/// Get the jj version string, if available.
84pub fn jj_version() -> Option<String> {
85    binary_version("jj")
86}
87
88/// Check whether the `git` binary is available on PATH.
89pub fn git_available() -> bool {
90    binary_available("git")
91}
92
93/// Get the git version string, if available.
94pub fn git_version() -> Option<String> {
95    binary_version("git")
96}
97
98#[cfg(test)]
99mod tests {
100    use super::*;
101
102    #[test]
103    fn jj_available_returns_bool() {
104        let _ = jj_available();
105    }
106
107    #[test]
108    fn jj_version_matches_availability() {
109        if jj_available() {
110            let v = jj_version().expect("jj is installed");
111            assert!(v.contains("jj"));
112        } else {
113            assert!(jj_version().is_none());
114        }
115    }
116
117    #[test]
118    fn git_available_returns_bool() {
119        let _ = git_available();
120    }
121
122    #[test]
123    fn git_version_matches_availability() {
124        if git_available() {
125            let v = git_version().expect("git is installed");
126            assert!(v.contains("git"));
127        } else {
128            assert!(git_version().is_none());
129        }
130    }
131}
vcs_runner/lib.rs

vcs_runner/
lib.rs
