rona 2.24.0

A simple CLI tool to help you with your git workflow.
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
//! Branch Operations
//!
//! Git branch-related functionality including branch information retrieval
//! and branch name formatting utilities.

use crate::{
    errors::{Result, RonaError},
    git::handle_output,
};
use indicatif::{ProgressBar, ProgressDrawTarget};
use std::io::IsTerminal;
use std::process::Command;
use std::time::Duration;

/// Attempts to get the default branch name from git config.
///
/// This helper function tries to retrieve the default branch name using
/// `git config --get init.defaultBranch`. If successful, it returns the branch name.
/// If the config lookup fails, it returns a default of "main".
///
/// # Returns
///
/// * `Ok(String)` - The default branch name if successfully retrieved, or "main" as fallback
fn try_get_default_branch() -> Result<String> {
    let output = Command::new("git")
        .args(["config", "--get", "init.defaultBranch"])
        .output()
        .map_err(RonaError::Io)?;

    if output.status.success() {
        let branch = String::from_utf8_lossy(&output.stdout).trim().to_string();
        if !branch.is_empty() {
            return Ok(branch);
        }
    }

    Ok("main".to_string())
}

/// Gets the current branch name.
///
/// This function returns the name of the currently checked out branch.
/// For detached HEAD states, it returns "HEAD".
/// For fresh repositories with no commits, it returns the configured default branch.
///
/// # Errors
///
/// Returns an error if:
/// - Not currently in a git repository
/// - Unable to determine the current branch (e.g., in a corrupted repository)
///
/// # Returns
///
/// The name of the current branch as a `String`
///
/// # Examples
///
/// ```no_run
/// use rona::git::branch::get_current_branch;
///
/// let branch = get_current_branch()?;
/// println!("Current branch: {}", branch);
///
/// // Use in conditional logic
/// if branch == "main" {
///     println!("On main branch");
/// }
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn get_current_branch() -> Result<String> {
    // Primary: git symbolic-ref --short HEAD
    // Works for normal branches and fresh repositories (returns default branch name).
    // Fails with non-zero exit code for detached HEAD state.
    let output = Command::new("git")
        .args(["symbolic-ref", "--short", "HEAD"])
        .output()
        .map_err(RonaError::Io)?;

    if output.status.success() {
        let branch = String::from_utf8_lossy(&output.stdout).trim().to_string();
        if !branch.is_empty() {
            return Ok(branch);
        }
    }

    // Fallback: git rev-parse --abbrev-ref HEAD
    // Returns "HEAD" for detached HEAD state.
    let output = Command::new("git")
        .args(["rev-parse", "--abbrev-ref", "HEAD"])
        .output()
        .map_err(RonaError::Io)?;

    if output.status.success() {
        let branch = String::from_utf8_lossy(&output.stdout).trim().to_string();
        if !branch.is_empty() {
            return Ok(branch);
        }
    }

    // Last resort: look up the configured default branch name
    try_get_default_branch()
}

/// Returns all local branch names.
///
/// The current-branch marker (`* `) is stripped so every entry is a plain name.
/// Returns an empty `Vec` on failure rather than propagating errors, matching the
/// soft-failure convention used elsewhere for non-critical git reads.
///
/// # Errors
/// Returns an error only if the git process cannot be spawned.
pub fn get_all_branches() -> Result<Vec<String>> {
    let output = Command::new("git")
        .args(["branch", "--list"])
        .output()
        .map_err(RonaError::Io)?;

    if !output.status.success() {
        return Ok(vec![]);
    }

    Ok(String::from_utf8_lossy(&output.stdout)
        .lines()
        .map(|line| line.trim_start_matches(['*', ' ']).to_string())
        .filter(|name| !name.is_empty())
        .collect())
}

/// Formats a branch name by removing commit type prefixes.
///
/// This function cleans up branch names that follow conventional naming patterns
/// like `feat/feature-name`, `fix/bug-name`, etc., by removing the commit type
/// prefix and slash, leaving just the descriptive part of the branch name.
///
/// # Arguments
///
/// * `commit_types` - A slice of commit type prefixes to remove (e.g., `&["feat", "fix", "chore", "test"]`)
/// * `branch` - The branch name to format
///
/// # Returns
///
/// A formatted branch name with commit type prefixes removed
///
/// # Examples
///
/// ```
/// use rona::git::branch::format_branch_name;
///
/// let commit_types = ["feat", "fix", "chore", "test"];
///
/// assert_eq!(
///     format_branch_name(&commit_types, "feat/user-authentication"),
///     "user-authentication"
/// );
///
/// assert_eq!(
///     format_branch_name(&commit_types, "fix/memory-leak"),
///     "memory-leak"
/// );
///
/// // Branch names without prefixes are unchanged
/// assert_eq!(
///     format_branch_name(&commit_types, "main"),
///     "main"
/// );
///
/// // Multiple prefixes are handled
/// assert_eq!(
///     format_branch_name(&commit_types, "feat/fix/complex-branch"),
///     "fix/complex-branch"  // Only first matching prefix is removed
/// );
///
/// // Works with any number of commit types
/// assert_eq!(
///     format_branch_name(&["feat", "fix"], "fix/bug"),
///     "bug"
/// );
/// ```
///
/// # Use Cases
///
/// This is particularly useful for:
/// - Generating clean commit messages
/// - Creating readable branch displays in UI
/// - Normalizing branch names for processing
#[must_use]
pub fn format_branch_name(commit_types: &[&str], branch: &str) -> String {
    let mut formatted_branch = branch.to_owned();

    for commit_type in commit_types {
        if formatted_branch.contains(commit_type) {
            // Remove the `/commit_type` from the branch name
            formatted_branch = formatted_branch.replace(&format!("{commit_type}/"), "");
        }
    }

    formatted_branch
}

/// Sanitizes a string into a valid git branch name segment.
///
/// Applies these transformations:
/// - Lowercases all characters
/// - Replaces spaces and unsupported characters with `-`
/// - Collapses consecutive `-` into a single `-`
/// - Collapses consecutive `/` into a single `/`
/// - Removes leading/trailing `-` from each `/`-separated segment
/// - Removes a trailing `/`
#[must_use]
pub fn sanitize_branch_name(name: &str) -> String {
    let sanitized: String = name
        .chars()
        .map(|c| {
            if matches!(c, 'a'..='z' | 'A'..='Z' | '0'..='9' | '/' | '_' | '-') {
                c
            } else {
                '-'
            }
        })
        .collect();

    // Collapse consecutive dashes and slashes
    let mut result = String::with_capacity(sanitized.len());
    let mut prev = '\0';
    for c in sanitized.chars() {
        if c == '-' && prev == '-' {
            continue;
        }
        if c == '/' && prev == '/' {
            continue;
        }
        result.push(c);
        prev = c;
    }

    // Clean each segment (between `/`) of leading/trailing `-`
    let result: String = result
        .split('/')
        .map(|seg| seg.trim_matches('-'))
        .filter(|seg| !seg.is_empty())
        .collect::<Vec<_>>()
        .join("/");

    result
}

/// Creates a branch without switching to it using `git branch`.
///
/// # Arguments
/// * `branch_name` - The name of the branch to create
///
/// # Errors
/// * If a branch with that name already exists
/// * If the operation fails
#[tracing::instrument]
pub fn git_branch_only(branch_name: &str) -> Result<()> {
    tracing::debug!("Creating branch without switching: {branch_name}");

    let output = Command::new("git")
        .args(["branch", branch_name])
        .output()
        .map_err(RonaError::Io)?;

    handle_output("branch", &output)
}

/// Switches to a different branch using `git switch`.
///
/// # Arguments
/// * `branch_name` - The name of the branch to switch to
///
/// # Errors
/// * If the branch doesn't exist
/// * If there are uncommitted changes that would be lost
/// * If the switch operation fails
#[tracing::instrument]
pub fn git_switch(branch_name: &str) -> Result<()> {
    tracing::debug!("Switching to branch: {branch_name}");

    let output = Command::new("git")
        .args(["switch", branch_name])
        .output()
        .map_err(RonaError::Io)?;

    handle_output("switch", &output)
}

/// Creates a new branch and switches to it using `git switch -c`.
///
/// This is equivalent to `git switch -c <branch_name>`. It creates a new branch
/// at the current HEAD commit and checks it out.
///
/// # Arguments
/// * `branch_name` - The name of the branch to create
///
/// # Errors
/// * If a branch with that name already exists
/// * If there is no HEAD commit (empty repository)
/// * If the operation fails
#[tracing::instrument]
pub fn git_create_branch(branch_name: &str) -> Result<()> {
    tracing::debug!("Creating new branch: {branch_name}");

    let output = Command::new("git")
        .args(["switch", "-c", branch_name])
        .output()
        .map_err(RonaError::Io)?;

    handle_output("create branch", &output)
}

/// Pulls changes from the remote repository.
///
/// # Arguments
/// * `verbose` - Whether to print verbose output during the operation
///
/// # Errors
/// * If there's no remote repository configured
/// * If the git pull command fails
/// * If there are merge conflicts
///
/// # Panics
/// * If the internal git pull thread panics (should not happen in normal use)
pub fn git_pull(verbose: bool) -> Result<()> {
    tracing::debug!("Pulling latest changes...");

    let show_spinner = !verbose && std::io::stderr().is_terminal();
    let output = if show_spinner {
        let pb = ProgressBar::new_spinner();
        pb.set_draw_target(ProgressDrawTarget::stderr());
        pb.set_message("Pulling...");
        pb.enable_steady_tick(Duration::from_millis(80));
        let handle = std::thread::spawn(|| Command::new("git").arg("pull").output());
        let result = handle.join().map_err(|_| RonaError::CommandFailed {
            command: "git pull".to_string(),
        })?;
        pb.finish_and_clear();
        result?
    } else {
        Command::new("git").arg("pull").output()?
    };

    handle_output("pull", &output)
}

/// Merges a branch into the current branch.
///
/// # Arguments
/// * `branch_name` - The name of the branch to merge
/// * `verbose` - Whether to print verbose output during the operation
///
/// # Errors
/// * If there are merge conflicts
/// * If the git merge command fails
///
/// # Panics
/// * If the internal git merge thread panics (should not happen in normal use)
pub fn git_merge(branch_name: &str, verbose: bool) -> Result<()> {
    tracing::debug!("Merging {branch_name} into current branch...");

    let show_spinner = !verbose && std::io::stderr().is_terminal();
    let branch_owned = branch_name.to_string();
    let output = if show_spinner {
        let pb = ProgressBar::new_spinner();
        pb.set_draw_target(ProgressDrawTarget::stderr());
        pb.set_message(format!("Merging {branch_name}..."));
        pb.enable_steady_tick(Duration::from_millis(80));
        let handle = std::thread::spawn(move || {
            Command::new("git").arg("merge").arg(&branch_owned).output()
        });
        let result = handle.join().map_err(|_| RonaError::CommandFailed {
            command: "git merge".to_string(),
        })?;
        pb.finish_and_clear();
        result?
    } else {
        Command::new("git").arg("merge").arg(branch_name).output()?
    };

    handle_output("merge", &output)
}

/// Rebases the current branch onto another branch.
///
/// # Arguments
/// * `branch_name` - The name of the branch to rebase onto
/// * `verbose` - Whether to print verbose output during the operation
///
/// # Errors
/// * If there are rebase conflicts
/// * If the git rebase command fails
///
/// # Panics
/// * If the internal git rebase thread panics (should not happen in normal use)
pub fn git_rebase(branch_name: &str, verbose: bool) -> Result<()> {
    tracing::debug!("Rebasing onto {branch_name}...");

    let show_spinner = !verbose && std::io::stderr().is_terminal();
    let branch_owned = branch_name.to_string();
    let output = if show_spinner {
        let pb = ProgressBar::new_spinner();
        pb.set_draw_target(ProgressDrawTarget::stderr());
        pb.set_message(format!("Rebasing onto {branch_name}..."));
        pb.enable_steady_tick(Duration::from_millis(80));
        let handle = std::thread::spawn(move || {
            Command::new("git")
                .arg("rebase")
                .arg(&branch_owned)
                .output()
        });
        let result = handle.join().map_err(|_| RonaError::CommandFailed {
            command: "git rebase".to_string(),
        })?;
        pb.finish_and_clear();
        result?
    } else {
        Command::new("git")
            .arg("rebase")
            .arg(branch_name)
            .output()?
    };

    handle_output("rebase", &output)
}