gex 0.6.4

Git workflow improvement CLI tool inspired by Magit
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
#![warn(clippy::pedantic, clippy::nursery)]
#![allow(
    clippy::cast_possible_truncation,
    clippy::too_many_lines,
    clippy::missing_errors_doc,
    clippy::redundant_closure_for_method_calls,
    clippy::module_name_repetitions,
    clippy::let_underscore_untyped
)]

use std::{
    cmp, env,
    io::{stdin, stdout, BufRead, Write},
    panic,
    process::{self, Command, Output},
    rc::Rc,
    sync::atomic::Ordering,
};

use anyhow::{Context, Result};
use clap::Parser;
use config::Clargs;
use crossterm::{
    cursor,
    event::{self, Event, KeyCode, KeyEventKind},
    style::{Attribute, SetForegroundColor},
    terminal::{self, ClearType},
};
use git2::Repository;

use crate::{
    command::GexCommand,
    config::{Action, Config, CONFIG},
    minibuffer::{Callback, MessageType, MiniBuffer},
    render::{Clear, Render, ResetAttributes},
};

mod branch;
mod command;
mod config;
mod debug;
mod minibuffer;
mod parse;
mod render;
mod status;

use branch::BranchList;
use render::Renderer;
use status::Status;

pub struct State {
    view: View,
    minibuffer: MiniBuffer,
    status: Status,
    branch_list: BranchList,
    repo: Repository,
    renderer: Renderer,
}

#[derive(Clone)]
pub enum View {
    Status,
    BranchList,
    Command(GexCommand),
    Input(Callback, Box<View>),
}

pub fn git_process(args: &[&str]) -> Result<Output> {
    use std::fmt::Write;
    Command::new("git").args(args).output().with_context(|| {
        format!(
            "failed to run `git{}`",
            args.iter().fold(String::new(), |mut acc, arg| {
                let _ = write!(acc, " {arg}");
                acc
            })
        )
    })
}

fn run(clargs: &Clargs) -> Result<()> {
    // Attempt to find a git repository at or above current path
    let repo = if let Ok(repo) = Repository::discover(&clargs.path) {
        repo
    } else {
        print!("Not a git repository. Initialise one? [y/N]");
        drop(stdout().flush());
        let input = stdin()
            .lock()
            .lines()
            .next()
            .context("couldn't read stdin")?
            .context("malformed stdin")?;
        if input.to_lowercase() != "y" {
            process::exit(0);
        }

        Repository::init(&clargs.path).context("failed to initialise git repository")?
    };

    // Set working directory in case the repository is not the current directory
    std::env::set_current_dir(repo.path().parent().context("`.git` cannot be root dir")?)
        .context("failed to set working directory")?;

    let minibuffer = MiniBuffer::new();

    let config = CONFIG.get_or_init(|| {
        Config::read_from_file(&clargs.config_file)
            .unwrap_or_else(|e| {
                MiniBuffer::push(&format!("{e:?}"), MessageType::Error);
                Some((Config::default(), Vec::new()))
            })
            .map_or_else(Config::default, |(config, unused_keys)| {
                if !unused_keys.is_empty() {
                    let mut warning = String::from("Unknown keys in config file:");
                    for key in unused_keys {
                        warning.push_str("\n    ");
                        warning.push_str(&key);
                    }
                    MiniBuffer::push(&warning, MessageType::Error);
                }
                config
            })
    });

    let status = Status::new(&repo, &config.options)?;
    let branch_list = BranchList::new()?;
    let view = View::Status;
    let renderer = Renderer::default();

    let mut state = State {
        view,
        minibuffer,
        status,
        branch_list,
        repo,
        renderer,
    };

    // Non-English locale settings are currently unsupported. See
    // https://github.com/Piturnah/gex/issues/13.
    if !env::var("LANG")
        .map(|s| s.starts_with("en"))
        .unwrap_or(true)
    {
        MiniBuffer::push("WARNING: Non-English locale detected. For now, Gex only supports English locale setting.
Set locale to English, e.g.:

        $ LANG=en_GB gex

See https://github.com/Piturnah/gex/issues/13.", MessageType::Error);
    }

    // We are about to start messing with the terminal settings. So let's update the panic hook so
    // that the panic messages will be displayed cleanly.
    let panic = panic::take_hook();
    panic::set_hook(Box::new(move |e| {
        restore_terminal();
        panic(e);
    }));

    crossterm::execute!(stdout(), terminal::EnterAlternateScreen)
        .context("failed to enter alternate screen")?;
    terminal::enable_raw_mode().context("failed to put terminal in raw mode")?;
    print!("{}", cursor::Hide);

    // Structure of the event loop
    //
    // 1. Clear the terminal
    // 2. Render status or branch list
    // 3. Render option overlay
    // 4. Render minibuffer messages
    // 5. Wait for event and update state
    //
    loop {
        let (term_width, term_height) =
            terminal::size().context("failed to query terminal dimensions")?;

        print!("{ResetAttributes}");
        match state.view {
            View::Status | View::Command(_) | View::Input(..) => {
                // If the flag is set then we need to fetch the status again before rendering.
                if status::REFRESH_FLAG.swap(false, Ordering::Acquire) {
                    state.status.fetch(&state.repo, &config.options)?;
                }
                state.status.render(&mut state.renderer)?;
            }
            View::BranchList => state.branch_list.render(&mut state.renderer)?,
        }
        state.renderer.show_and_clear(
            term_width as usize,
            term_height as usize,
            config.options.lookahead_lines,
            config.options.truncate_lines,
        );
        drop(stdout().flush());

        // Display the available subcommands
        if let View::Command(cmd) = state.view {
            use std::fmt::Write;
            let subcmds = cmd.subcommands();
            print!(
                "{}{title:═^term_width$}{}{}{}",
                cursor::MoveTo(0, term_height - 1 - subcmds.len() as u16),
                Clear(ClearType::FromCursorDown),
                subcmds.iter().fold(String::new(), |mut acc, (k, v)| {
                    let _ = write!(
                        acc,
                        "\r\n {}{}{k}{} => {v}",
                        SetForegroundColor(config.colors.key),
                        Attribute::Bold,
                        ResetAttributes
                    );
                    acc
                }),
                SetForegroundColor(config.colors.foreground),
                term_width = term_width as usize,
                title = format!(" {cmd:?} Options "),
            );

            drop(stdout().flush());
        }

        // Draw the current `debug!` window.
        debug_draw!();

        state.minibuffer.pop_message();
        state.minibuffer.render(term_width, term_height)?;

        // Handle input
        //
        // Check what event we get. If we got an event other than a key event, we don't need to
        // handle it so we break. If we got a key event with KeyEventKind::Release, we try again in
        // the loop to avoid re-rendering. If it's a key event without KeyEventKind::Release,
        // handle it and break.
        loop {
            let Event::Key(event) = event::read().context("failed to read a terminal event")?
            else {
                break;
            };
            if event.kind == KeyEventKind::Release {
                continue;
            }

            if !MiniBuffer::is_empty() {
                break;
            }

            match state.view {
                View::Status => {
                    match config.keymap.navigation.get(&event.code) {
                        Some(Action::MoveDown) => state.status.down()?,
                        Some(Action::MoveUp) => state.status.up()?,
                        Some(Action::NextFile) => state.status.file_down()?,
                        Some(Action::PreviousFile) => state.status.file_up()?,
                        Some(Action::ToggleExpand) => state.status.expand()?,
                        Some(Action::GotoBottom) => state.status.cursor_last()?,
                        Some(Action::GotoTop) => state.status.cursor_first()?,
                        _ => {}
                    };

                    match event.code {
                        KeyCode::Char('s') => {
                            if state.status.cursor
                                < state.status.count_untracked + state.status.count_unstaged
                            {
                                state.status.stage()?;
                                status::REFRESH_FLAG.store(true, Ordering::Release);
                            }
                        }
                        KeyCode::Char('S') => {
                            MiniBuffer::push_command_output(&git_process(&["add", "."])?);
                            status::REFRESH_FLAG.store(true, Ordering::Release);
                        }
                        KeyCode::Char('u') => {
                            if state.status.cursor
                                >= state.status.count_untracked + state.status.count_unstaged
                            {
                                state.status.unstage()?;
                                status::REFRESH_FLAG.store(true, Ordering::Release);
                            }
                        }
                        KeyCode::Char('U') => {
                            MiniBuffer::push_command_output(&git_process(&["reset"])?);
                            status::REFRESH_FLAG.store(true, Ordering::Release);
                        }
                        KeyCode::Char('e') => {
                            state.status.open_editor()?;
                            status::REFRESH_FLAG.store(true, Ordering::Release);
                        }
                        KeyCode::Char('F') => {
                            MiniBuffer::push_command_output(&git_process(&["pull"])?);
                            status::REFRESH_FLAG.store(true, Ordering::Release);
                        }
                        KeyCode::Char('r') => status::REFRESH_FLAG.store(true, Ordering::Release),
                        KeyCode::Char(':') => {
                            state.minibuffer.command(true, &mut state.view);
                            status::REFRESH_FLAG.store(true, Ordering::Release);
                        }
                        KeyCode::Char('!') => {
                            state.minibuffer.command(false, &mut state.view);
                            status::REFRESH_FLAG.store(true, Ordering::Release);
                        }
                        KeyCode::Char('q') => {
                            terminal::disable_raw_mode().context("failed to disable raw mode")?;
                            crossterm::execute!(
                                stdout(),
                                terminal::LeaveAlternateScreen,
                                cursor::Show,
                                cursor::MoveToColumn(0)
                            )
                            .context("failed to leave alternate screen")?;
                            process::exit(0);
                        }
                        KeyCode::Char(c1) => {
                            if let Some((_, cmd)) =
                                GexCommand::commands().iter().find(|(c2, _)| c1 == *c2)
                            {
                                state.view = View::Command(*cmd);
                            }
                        }
                        _ => {}
                    };
                }
                View::BranchList => {
                    match config.keymap.navigation.get(&event.code) {
                        Some(Action::MoveDown) => {
                            state.branch_list.cursor = cmp::min(
                                state.branch_list.cursor + 1,
                                state.branch_list.branches.len() - 1,
                            );
                        }
                        Some(Action::MoveUp) => {
                            state.branch_list.cursor = state.branch_list.cursor.saturating_sub(1);
                        }
                        Some(Action::GotoBottom) => {
                            state.branch_list.cursor = state.branch_list.branches.len() - 1;
                        }
                        Some(Action::GotoTop) => state.branch_list.cursor = 0,
                        _ => {}
                    }
                    match event.code {
                        KeyCode::Char(' ') | KeyCode::Enter => {
                            MiniBuffer::push_command_output(&state.branch_list.checkout()?);
                            status::REFRESH_FLAG.store(true, Ordering::Release);
                            state.view = View::Status;
                        }
                        KeyCode::Esc => state.view = View::Status,
                        KeyCode::Char('q') => {
                            terminal::disable_raw_mode().context("failed to disable raw mode")?;
                            crossterm::execute!(
                                stdout(),
                                terminal::LeaveAlternateScreen,
                                cursor::Show,
                                cursor::MoveToColumn(0)
                            )
                            .context("failed to leave alternate screen")?;
                            process::exit(0);
                        }
                        _ => {}
                    }
                }
                View::Command(cmd) => match event.code {
                    KeyCode::Esc => state.view = View::Status,
                    KeyCode::Char('q') => {
                        terminal::disable_raw_mode().context("failed to exit raw mode")?;
                        crossterm::execute!(
                            stdout(),
                            terminal::LeaveAlternateScreen,
                            cursor::Show,
                            cursor::MoveToColumn(0)
                        )
                        .context("failed to leave alternate screen")?;
                        process::exit(0);
                    }
                    KeyCode::Char(c) => cmd.handle_input(c, &mut state)?,
                    _ => {}
                },
                View::Input(ref callback, ref return_view) => {
                    // This clone should be very cheap as we should never be constructing a
                    // View::Input with the return view as View::Input.
                    //
                    // NOTE: This all indicates there is probably a better way to represent the
                    // View type, as it never actually needs to be recursive -- then we would also
                    // be able to just #[derive(Copy)].
                    debug_assert!(!matches!(**return_view, View::Input(..)));
                    state.minibuffer.handle_input(
                        event,
                        &Rc::clone(callback),
                        (**return_view).clone(),
                        &mut state.view,
                    )?;
                }
            };
            break;
        }
    }
}

/// Restore the terminal to its original state from before we messed with it.
fn restore_terminal() {
    drop(terminal::disable_raw_mode());
    drop(crossterm::execute!(
        stdout(),
        terminal::LeaveAlternateScreen,
        cursor::Show,
        cursor::MoveToColumn(0)
    ));
}

fn main() -> Result<()> {
    run(&Clargs::parse()).map_err(|e| {
        restore_terminal();
        e
    })
}