Skip to main content

git_workflow/git/
mutation.rs

1//! State-changing git operations
2
3use std::process::Command;
4
5use crate::error::{GwError, Result};
6use crate::output;
7
8/// Execute a git command, showing the command if verbose
9fn git_run(args: &[&str], verbose: bool) -> Result<()> {
10    if verbose {
11        output::action(&format!("git {}", args.join(" ")));
12    }
13
14    let output = Command::new("git")
15        .args(args)
16        .output()
17        .map_err(|e| GwError::GitCommandFailed(format!("Failed to execute git: {e}")))?;
18
19    if output.status.success() {
20        Ok(())
21    } else {
22        let stderr = String::from_utf8_lossy(&output.stderr).trim().to_string();
23        Err(GwError::GitCommandFailed(stderr))
24    }
25}
26
27/// Execute a git command and return stdout
28fn git_output(args: &[&str], verbose: bool) -> Result<String> {
29    if verbose {
30        output::action(&format!("git {}", args.join(" ")));
31    }
32
33    let output = Command::new("git")
34        .args(args)
35        .output()
36        .map_err(|e| GwError::GitCommandFailed(format!("Failed to execute git: {e}")))?;
37
38    if output.status.success() {
39        Ok(String::from_utf8_lossy(&output.stdout).trim().to_string())
40    } else {
41        let stderr = String::from_utf8_lossy(&output.stderr).trim().to_string();
42        Err(GwError::GitCommandFailed(stderr))
43    }
44}
45
46/// Fetch from origin with prune
47pub fn fetch_prune(verbose: bool) -> Result<()> {
48    git_run(&["fetch", "--prune", "--quiet"], verbose)
49}
50
51/// Checkout an existing branch
52pub fn checkout(branch: &str, verbose: bool) -> Result<()> {
53    git_run(&["checkout", branch, "--quiet"], verbose).map_err(|e| map_checkout_error(branch, e))
54}
55
56/// Create and checkout a new branch from a starting point
57pub fn checkout_new_branch(branch: &str, start_point: &str, verbose: bool) -> Result<()> {
58    git_run(&["checkout", "-b", branch, start_point, "--quiet"], verbose)
59        .map_err(|e| map_checkout_error(branch, e))
60}
61
62/// Turn git's raw "already checked out / used by worktree" failure into a
63/// typed, actionable error. In a worktree setup the same branch can't be
64/// checked out in two places, and git's bare fatal message doesn't tell the
65/// user what to do; `BranchCheckedOutElsewhere` carries the conflicting path
66/// and lets the CLI suggest next steps.
67fn map_checkout_error(branch: &str, err: GwError) -> GwError {
68    let GwError::GitCommandFailed(ref msg) = err else {
69        return err;
70    };
71    if msg.contains("already checked out") || msg.contains("already used by worktree") {
72        return GwError::BranchCheckedOutElsewhere {
73            branch: branch.to_string(),
74            path: extract_worktree_path(msg),
75        };
76    }
77    err
78}
79
80/// Pull the worktree path out of git's message, e.g.
81/// `fatal: 'main' is already checked out at '/path/to/wt'`.
82fn extract_worktree_path(msg: &str) -> Option<String> {
83    let start = msg.find("at '")? + "at '".len();
84    let rest = &msg[start..];
85    let end = rest.find('\'')?;
86    Some(rest[..end].to_string())
87}
88
89/// Pull from a remote branch (fast-forward only, safe)
90///
91/// Returns an error if the pull cannot be done as a fast-forward,
92/// which happens when the local branch has diverged from the remote.
93pub fn pull_ff_only(remote: &str, branch: &str, verbose: bool) -> Result<()> {
94    git_run(&["pull", remote, branch, "--ff-only", "--quiet"], verbose)
95}
96
97/// Delete a local branch (safe delete, requires merge)
98pub fn delete_branch(branch: &str, verbose: bool) -> Result<()> {
99    git_run(&["branch", "-d", branch], verbose)
100}
101
102/// Force delete a local branch
103pub fn force_delete_branch(branch: &str, verbose: bool) -> Result<()> {
104    git_run(&["branch", "-D", branch], verbose)
105}
106
107/// Delete a remote branch
108#[allow(dead_code)]
109pub fn delete_remote_branch(branch: &str, verbose: bool) -> Result<()> {
110    git_run(&["push", "origin", "--delete", branch], verbose)
111}
112
113/// Get commits that are in `to` but not in `from`
114pub fn log_commits(from: &str, to: &str, verbose: bool) -> Result<Vec<String>> {
115    let output = git_output(&["log", &format!("{from}..{to}"), "--oneline"], verbose)?;
116    Ok(output.lines().map(String::from).collect())
117}
118
119/// Stage all changes (including untracked files)
120pub fn add_all(verbose: bool) -> Result<()> {
121    git_run(&["add", "-A"], verbose)
122}
123
124/// Create a commit with the given message
125pub fn commit(message: &str, verbose: bool) -> Result<()> {
126    git_run(&["commit", "-m", message], verbose)
127}
128
129/// Soft reset to target (keeps changes in working directory as staged)
130pub fn reset_soft(target: &str, verbose: bool) -> Result<()> {
131    git_run(&["reset", "--soft", target], verbose)
132}
133
134/// Discard all uncommitted changes (both staged and unstaged, including untracked files)
135pub fn discard_all_changes(verbose: bool) -> Result<()> {
136    // Reset staged changes
137    git_run(&["reset", "--hard", "HEAD"], verbose)?;
138    // Remove untracked files and directories
139    git_run(&["clean", "-fd"], verbose)
140}
141
142/// Rebase current branch onto a target
143pub fn rebase(target: &str, verbose: bool) -> Result<()> {
144    git_run(&["rebase", target], verbose)
145}
146
147/// Force push with lease (safer than --force)
148pub fn force_push_with_lease(branch: &str, verbose: bool) -> Result<()> {
149    git_run(&["push", "--force-with-lease", "origin", branch], verbose)
150}
151
152/// Add a new worktree at the given path with a new branch from a start point
153pub fn worktree_add(path: &str, branch: &str, start_point: &str, verbose: bool) -> Result<()> {
154    git_run(
155        &["worktree", "add", "-b", branch, path, start_point],
156        verbose,
157    )
158}
159
160/// Remove a worktree (with --force)
161pub fn worktree_remove(path: &str, verbose: bool) -> Result<()> {
162    git_run(&["worktree", "remove", "--force", path], verbose)
163}
164
165/// Prune stale worktree entries
166pub fn worktree_prune(verbose: bool) -> Result<()> {
167    git_run(&["worktree", "prune"], verbose)
168}
169
170/// Execute a git command in a specific directory.
171/// Sets the process working directory (not just `git -C`) so it works
172/// even if the caller's cwd has been deleted.
173pub fn git_run_in_dir(dir: &str, args: &[&str], verbose: bool) -> Result<()> {
174    if verbose {
175        output::action(&format!("git -C {} {}", dir, args.join(" ")));
176    }
177
178    let output = Command::new("git")
179        .args(args)
180        .current_dir(dir)
181        .output()
182        .map_err(|e| GwError::GitCommandFailed(format!("Failed to execute git: {e}")))?;
183
184    if output.status.success() {
185        Ok(())
186    } else {
187        let stderr = String::from_utf8_lossy(&output.stderr).trim().to_string();
188        Err(GwError::GitCommandFailed(stderr))
189    }
190}