mdsh 0.7.0

Markdown shell pre-processor
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

//! Command line interface
use std::path::{Path, PathBuf};
use std::str::FromStr;
use structopt::StructOpt;

/// Markdown shell pre-processor.
/// Never let your READMEs and tutorials get out of sync again.
///
/// Exits non-zero if a sub-command failed.
#[derive(Debug, StructOpt)]
#[structopt(name = "mdsh")]
pub struct Opt {
    /// Path to the markdown files. `-` for stdin.
    #[structopt(
        short = "i",
        long = "inputs",
        alias = "input",
        default_value = "./README.md"
    )]
    pub inputs: Vec<FileArg>,

    /// Path to the output file, `-` for stdout [defaults to updating the input file in-place].
    #[structopt(short = "o", long = "output")]
    pub output: Option<FileArg>,

    /// Directory to execute the scripts under [defaults to the input file’s directory].
    #[structopt(long = "work_dir", parse(from_os_str))]
    pub work_dir: Option<PathBuf>,

    /// Fail if the output is different from the input. Useful for CI.
    ///
    /// Using `--frozen`, you can guarantee that developers update
    /// documentation when they make a change. Just add `mdsh --frozen`
    /// as a check to your continuous integration setup.
    #[structopt(long = "frozen", conflicts_with = "clean")]
    pub frozen: bool,

    /// Remove all generated blocks.
    #[structopt(long = "clean")]
    pub clean: bool,
}

/// Possible file input (either a file name or `-`)
#[derive(Debug, Clone)]
pub enum FileArg {
    /// equal to - (so stdin or stdout)
    StdHandle,
    File(PathBuf),
}

impl FileArg {
    /// Return the parent, if it is a `StdHandle` use the current directory.
    /// Returns `None` if there is no parent (that is we are `/`).
    pub fn parent(&self) -> Option<Parent> {
        match self {
            FileArg::StdHandle => Some(Parent::current_dir()),
            FileArg::File(buf) => Parent::of(buf),
        }
    }

    /// return a `FileArg::File`, don’t parse
    pub fn from_str_unsafe(s: &str) -> Self {
        FileArg::File(PathBuf::from(s))
    }
}

impl FromStr for FileArg {
    type Err = std::string::ParseError;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "-" => Ok(FileArg::StdHandle),
            p => Ok(FileArg::File(PathBuf::from(p))),
        }
    }
}

/// Parent path, gracefully handling relative path inputs
#[derive(Debug, Clone)]
pub struct Parent(PathBuf);

impl Parent {
    /// Create from a `Path`, falling back to the
    /// `current_dir()` if necessary.
    /// Returns `None` if there is no parent (that is we are `/`).
    pub fn of(p: &Path) -> Option<Self> {
        let prnt = p.parent()?;
        if prnt.as_os_str().is_empty() {
            Some(Self::current_dir())
        } else {
            Some(Parent(prnt.to_path_buf()))
        }
    }

    /// Creates a `Parent` that is the current directory.
    /// Asks the operating system for the path.
    pub fn current_dir() -> Self {
        Parent(
            std::env::current_dir().expect(
                "fatal: current working directory not accessible and `--work_dir` not given",
            ),
        )
    }

    /// Convert from a `PathBuf` that is already a parent.
    pub fn from_parent_path_buf(buf: PathBuf) -> Self {
        Parent(buf)
    }

    pub fn as_path_buf(&self) -> &PathBuf {
        &self.0
    }
}