readmer 0.0.1

Compose README.md files from Jinja2 or Liquid templates.
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

// This is free and unencumbered software released into the public domain.

use crate::Utf8PathBuf;
use alloc::string::{FromUtf8Error, String};
use std::{io::Error, process::Command};

/// An error that can occur when running Git commands.
#[derive(Debug)]
pub enum GitError {
    /// Git is not installed or couldn't be executed.
    IoError(Error),
    /// The command ran but returned a non-zero exit status (e.g., not a Git repo).
    CommandFailed { code: Option<i32>, stderr: String },
    /// The output from Git was not valid UTF-8.
    InvalidUtf8(FromUtf8Error),
}

#[derive(Clone, Debug)]
pub struct Git(Utf8PathBuf);

impl Default for Git {
    fn default() -> Self {
        Self("git".into())
    }
}

impl Git {
    pub fn at(path: impl Into<Utf8PathBuf>) -> Self {
        Self(path.into())
    }

    pub fn show_toplevel(&self) -> Result<Utf8PathBuf, GitError> {
        self.rev_parse("--show-toplevel")
    }

    pub fn show_prefix(&self) -> Result<Utf8PathBuf, GitError> {
        self.rev_parse("--show-prefix")
    }

    pub fn rev_parse(&self, option: &str) -> Result<Utf8PathBuf, GitError> {
        let output = Command::new(&self.0)
            .args(["rev-parse", option])
            .output()
            .map_err(GitError::IoError)?;
        if !output.status.success() {
            let stderr = String::from_utf8_lossy(&output.stderr).into_owned();
            return Err(GitError::CommandFailed {
                code: output.status.code(),
                stderr,
            });
        }
        let stdout = String::from_utf8(output.stdout).map_err(GitError::InvalidUtf8)?;
        Ok(stdout.trim().into())
    }
}