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

//! `git status` — show the working tree status.

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

/// Porcelain v2 formats and friends.
#[derive(Debug, Clone, Copy)]
pub enum StatusFormat {
    /// Short `-s` format.
    Short,
    /// Long (default) format.
    Long,
    /// `--porcelain=v1`.
    PorcelainV1,
    /// `--porcelain=v2`.
    PorcelainV2,
}

/// Builder for `git status`.
#[derive(Debug, Clone, Default)]
pub struct StatusCommand {
    /// Shared executor.
    pub executor: CommandExecutor,
    /// Output format override.
    pub format: Option<StatusFormat>,
    /// `--branch` / `-b`.
    pub branch: bool,
    /// `--show-stash`.
    pub show_stash: bool,
    /// NUL-terminate entries (`-z`).
    pub null_terminate: bool,
    /// `--untracked-files=<mode>`.
    pub untracked_files: Option<String>,
    /// `--ignored`.
    pub ignored: bool,
    /// Pathspec filters.
    pub paths: Vec<String>,
}

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

    /// Set output format.
    pub fn format(&mut self, f: StatusFormat) -> &mut Self {
        self.format = Some(f);
        self
    }

    /// Include branch info.
    pub fn branch(&mut self) -> &mut Self {
        self.branch = true;
        self
    }

    /// Show stash count.
    pub fn show_stash(&mut self) -> &mut Self {
        self.show_stash = true;
        self
    }

    /// NUL-separate entries.
    pub fn null_terminate(&mut self) -> &mut Self {
        self.null_terminate = true;
        self
    }

    /// Set untracked-file mode (`no`, `normal`, `all`).
    pub fn untracked_files(&mut self, mode: impl Into<String>) -> &mut Self {
        self.untracked_files = Some(mode.into());
        self
    }

    /// Also show ignored files.
    pub fn ignored(&mut self) -> &mut Self {
        self.ignored = true;
        self
    }

    /// Filter by path.
    pub fn path(&mut self, p: impl Into<String>) -> &mut Self {
        self.paths.push(p.into());
        self
    }
}

#[async_trait]
impl GitCommand for StatusCommand {
    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!["status".to_string()];
        match self.format {
            Some(StatusFormat::Short) => args.push("--short".into()),
            Some(StatusFormat::Long) => args.push("--long".into()),
            Some(StatusFormat::PorcelainV1) => args.push("--porcelain=v1".into()),
            Some(StatusFormat::PorcelainV2) => args.push("--porcelain=v2".into()),
            None => {}
        }
        if self.branch {
            args.push("--branch".into());
        }
        if self.show_stash {
            args.push("--show-stash".into());
        }
        if self.null_terminate {
            args.push("-z".into());
        }
        if let Some(m) = &self.untracked_files {
            args.push(format!("--untracked-files={m}"));
        }
        if self.ignored {
            args.push("--ignored".into());
        }
        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
    }
}