git-proc 0.5.0

Process-based git CLI wrapper with rich types
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
84
85
86
87
88
89
90

use std::path::Path;

use crate::CommandError;

/// Create a new `git clean` command builder.
#[must_use]
pub fn new() -> Clean<'static> {
    Clean::new()
}

/// Builder for `git clean` command.
///
/// See `git clean --help` for full documentation.
#[derive(Debug)]
pub struct Clean<'a> {
    repo_path: Option<&'a Path>,
    directories: bool,
    force: bool,
    include_ignored: bool,
}

crate::impl_repo_path!(Clean);

impl<'a> Clean<'a> {
    #[must_use]
    fn new() -> Self {
        Self {
            repo_path: None,
            directories: false,
            force: false,
            include_ignored: false,
        }
    }

    crate::flag_methods! {
        /// Recurse into untracked directories.
        ///
        /// Corresponds to `-d` (no long form).
        pub fn directories / directories_if, directories, "Conditionally recurse into untracked directories."
    }

    crate::flag_methods! {
        /// Force removal even when `clean.requireForce` is set.
        ///
        /// Corresponds to `--force`.
        pub fn force / force_if, force, "Conditionally force removal."
    }

    crate::flag_methods! {
        /// Also remove files ignored by `.gitignore`.
        ///
        /// Corresponds to `-x` (no long form).
        pub fn include_ignored / include_ignored_if, include_ignored, "Conditionally also remove ignored files."
    }

    /// Execute the command and return the exit status.
    pub async fn status(self) -> Result<(), CommandError> {
        crate::Build::build(self).status().await
    }
}

impl Default for Clean<'_> {
    fn default() -> Self {
        Self::new()
    }
}

impl crate::Build for Clean<'_> {
    fn build(self) -> cmd_proc::Command {
        crate::base_command(self.repo_path)
            .argument("clean")
            .optional_flag(self.directories, "-d")
            .optional_flag(self.force, "--force")
            .optional_flag(self.include_ignored, "-x")
    }
}

#[cfg(feature = "test-utils")]
impl Clean<'_> {
    /// Compare the built command with another command using debug representation.
    pub fn test_eq(&self, other: &cmd_proc::Command) {
        let command = crate::Build::build(Self {
            repo_path: self.repo_path,
            directories: self.directories,
            force: self.force,
            include_ignored: self.include_ignored,
        });
        command.test_eq(other);
    }
}