taboc 0.2.105

A table of contents generator for markdown documents.
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

use crate::prelude::*;
use std::{path::Path, process::Command};

/// Utility functions that check for git information.
#[repr(transparent)]
pub struct Git();

impl Git {
    const GIT: &str = "git";

    /// Check if `git` is installed.
    pub fn installed() -> Result<bool, std::io::Error> {
        Command::new(Self::GIT)
            .arg("--version")
            .output()
            .map(|output| output.status.success())
    }

    /// Check if a file path is modified based on the git repository in `pwd`.
    pub fn is_file_modified<P>(f: P) -> Result<bool, Error>
    where
        P: AsRef<Path>,
    {
        let output = Command::new(Self::GIT)
            .args(["status", "--porcelain"])
            .arg(f.as_ref())
            .output()?;

        if output.status.success() {
            let stdout = String::from_utf8_lossy(&output.stdout);
            Ok(!stdout.trim().is_empty())
        } else {
            Err(anyhow!("Not in a git repository.\n{:?}", output))
        }
    }

    /// # `--allow-dirty` checks.
    ///
    /// Run all the necessary checks for `--allow-dirty` and returning an error if the file is
    /// uncommited and `git` is installed and the flag isn't set.
    pub fn run_allow_dirty_checks<P>(args: &Opt, f: P) -> Result<(), Error>
    where
        P: AsRef<Path>,
    {
        if !args.allow_dirty && Git::installed()? && Git::is_file_modified(f)? {
            return Err(anyhow!(
                "The file has uncommited changes and the `--allow-dirty` flag isn't set.",
            ));
        }

        Ok(())
    }
}