printable-shell-command 0.2.4

A helper library to print shell commands.
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

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum Quoting {
    /// Quote only arguments that need it for safety. This tries to be
    /// portable and safe across shells, but true safety and portability is hard
    /// to guarantee.
    Auto,

    /// Quote all arguments, even ones that don't need it. This is
    /// more likely to be safe under all circumstances.
    ExtraSafe,
}

impl Default for Quoting {
    fn default() -> Self {
        Self::Auto
    }
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum ArgumentLineWrapping {
    ByEntry,
    NestedByEntry,
    ByArgument,
    Inline,
}

impl Default for ArgumentLineWrapping {
    fn default() -> Self {
        Self::ByEntry
    }
}

#[derive(Default)]
pub struct FormattingOptions {
    pub main_indentation: Option<String>,
    pub arg_indentation: Option<String>,
    pub quoting: Option<Quoting>,
    // Line wrapping to use between arguments.
    pub argument_line_wrapping: Option<ArgumentLineWrapping>,
    pub skip_line_wrap_before_first_arg: Option<bool>,
    // TODO: text styling
}