git-spawn 0.1.0

Async wrapper around the git CLI: builder commands, typed parsers, high-level workflow helpers
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
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

//! `git checkout` — switch branches or restore working tree files.

use crate::command::{CommandExecutor, CommandOutput, GitCommand};
use crate::error::Result;
use async_trait::async_trait;

/// Builder for `git checkout`.
#[derive(Debug, Clone, Default)]
pub struct CheckoutCommand {
    /// Shared executor.
    pub executor: CommandExecutor,
    /// Target branch, commit, or tree-ish.
    pub target: Option<String>,
    /// `-b` create branch.
    pub create: Option<String>,
    /// `-B` create/reset branch.
    pub create_or_reset: Option<String>,
    /// `--force` / `-f`.
    pub force: bool,
    /// `--track`.
    pub track: bool,
    /// `--no-track`.
    pub no_track: bool,
    /// `--orphan`.
    pub orphan: Option<String>,
    /// `--detach`.
    pub detach: bool,
    /// Pathspecs.
    pub paths: Vec<String>,
    /// `--quiet`.
    pub quiet: bool,
}

impl CheckoutCommand {
    /// New `checkout` command.
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// Switch to the named branch/commit.
    pub fn target(&mut self, t: impl Into<String>) -> &mut Self {
        self.target = Some(t.into());
        self
    }

    /// Create a new branch (`-b`).
    pub fn create(&mut self, name: impl Into<String>) -> &mut Self {
        self.create = Some(name.into());
        self
    }

    /// Create or reset a branch (`-B`).
    pub fn create_or_reset(&mut self, name: impl Into<String>) -> &mut Self {
        self.create_or_reset = Some(name.into());
        self
    }

    /// `--force`.
    pub fn force(&mut self) -> &mut Self {
        self.force = true;
        self
    }

    /// `--track`.
    pub fn track(&mut self) -> &mut Self {
        self.track = true;
        self
    }

    /// `--no-track`.
    pub fn no_track(&mut self) -> &mut Self {
        self.no_track = true;
        self
    }

    /// Create an orphan branch.
    pub fn orphan(&mut self, name: impl Into<String>) -> &mut Self {
        self.orphan = Some(name.into());
        self
    }

    /// Detach HEAD.
    pub fn detach(&mut self) -> &mut Self {
        self.detach = true;
        self
    }

    /// Restore a path from the index or tree.
    pub fn path(&mut self, p: impl Into<String>) -> &mut Self {
        self.paths.push(p.into());
        self
    }

    /// Suppress output.
    pub fn quiet(&mut self) -> &mut Self {
        self.quiet = true;
        self
    }
}

#[async_trait]
impl GitCommand for CheckoutCommand {
    type Output = CommandOutput;
    fn get_executor(&self) -> &CommandExecutor {
        &self.executor
    }
    fn get_executor_mut(&mut self) -> &mut CommandExecutor {
        &mut self.executor
    }
    fn build_command_args(&self) -> Vec<String> {
        let mut args = vec!["checkout".to_string()];
        if self.force {
            args.push("--force".into());
        }
        if self.track {
            args.push("--track".into());
        }
        if self.no_track {
            args.push("--no-track".into());
        }
        if self.detach {
            args.push("--detach".into());
        }
        if self.quiet {
            args.push("--quiet".into());
        }
        if let Some(o) = &self.orphan {
            args.push("--orphan".into());
            args.push(o.clone());
        }
        if let Some(b) = &self.create {
            args.push("-b".into());
            args.push(b.clone());
        }
        if let Some(b) = &self.create_or_reset {
            args.push("-B".into());
            args.push(b.clone());
        }
        if let Some(t) = &self.target {
            args.push(t.clone());
        }
        if !self.paths.is_empty() {
            args.push("--".into());
            args.extend(self.paths.iter().cloned());
        }
        args
    }
    async fn execute(&self) -> Result<CommandOutput> {
        self.execute_raw().await
    }
}