garden-tools 2.6.0

Garden grows and cultivates collections of Git trees Garden lets you define and run commands over collections of configuration-defined multi-worktree Git environments.
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

use crate::{constants, errors};

/// Return the current directory as a PathBuf.
pub fn current_dir() -> std::path::PathBuf {
    std::env::current_dir().unwrap_or_else(|_| std::path::PathBuf::from(constants::DOT))
}

/// Return the current directory as a string.
pub(crate) fn current_dir_string() -> String {
    current_dir().to_string_lossy().to_string()
}

/// Return the home directory for the current user.
pub(crate) fn home_dir() -> std::path::PathBuf {
    dirs::home_dir().unwrap_or_else(|| std::path::PathBuf::from("/tmp"))
}

/// Canonicalize a path while avoiding problematic UNC paths on Windows.
pub(crate) fn canonicalize<P: AsRef<std::path::Path>>(
    path: P,
) -> std::io::Result<std::path::PathBuf> {
    dunce::canonicalize(path)
}

/// Convert a Path into an absolute path. Return the original path if it cannot be canonicalized.
pub fn abspath<P: AsRef<std::path::Path> + std::marker::Copy>(path: P) -> std::path::PathBuf {
    canonicalize(path).unwrap_or(path.as_ref().to_path_buf())
}

/// Return the basename of a path-like string.
pub(crate) fn str_basename(path: &str) -> &str {
    let basename = if path.contains('/') {
        path.split('/').next_back().unwrap_or(path)
    } else if path.contains('\\') {
        path.split('\\').next_back().unwrap_or(path)
    } else {
        path
    };

    basename
}

/// Return true if the basename is a known shell.
pub(crate) fn is_shell(basename: &str) -> bool {
    matches!(
        basename,
        constants::SHELL_BASH
            | constants::SHELL_DASH
            | constants::SHELL_KSH
            | constants::SHELL_SH
            | constants::SHELL_ZSH
    )
}

/// Strip a prefix from a path.
pub(crate) fn strip_prefix(
    root: &std::path::Path,
    path: &std::path::Path,
) -> Result<std::path::PathBuf, errors::GardenError> {
    let stripped_path = if path.starts_with(root) {
        // Is the path a child of the current garden root?
        path.strip_prefix(root)
            .map_err(|err| {
                errors::GardenError::ConfigurationError(format!(
                    "{path:?} is not a child of {root:?}: {err:?}"
                ))
            })?
            .to_path_buf()
    } else {
        path.to_path_buf()
    };

    Ok(stripped_path)
}

/// Strip a prefix from a path. Returns a path as a string.
pub(crate) fn strip_prefix_into_string(
    root: &std::path::Path,
    path: &std::path::Path,
) -> Result<String, errors::GardenError> {
    let path_str = strip_prefix(root, path)?.to_string_lossy().to_string();
    Ok(path_str)
}