gitignore-template-generator 0.14.0

A binary crate to generate templates for .gitignore files
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

pub use crate::core::impls::{
    GitignoreTemplateManager, LocalGitignoreTemplateManager,
    RemoteGitignoreTemplateManager,
};

/// DTO struct representing an early or abrupt program exit.
#[derive(Clone, PartialEq, Debug)]
pub struct ProgramExit {
    /// The message linked to the program exit.
    pub message: String,

    /// The exit status code to be returned by the script.
    pub exit_status: i32,

    /// The ANSI-styled message linked to the program exit.
    ///
    /// Same as [`ProgramExit::message`] but styled.
    pub styled_message: Option<String>,

    /// The kind of program exit.
    pub kind: ExitKind,
}

#[derive(Clone, PartialEq, Debug)]
pub struct QualifiedString {
    pub value: String,
    pub kind: StringKind,
}

/// Enum for kind of program exit.
#[derive(Clone, PartialEq, Debug)]
pub enum ExitKind {
    /// Early program exit to print version infos.
    VersionInfos,

    /// Early program exit to print help infos.
    HelpInfos,

    /// Early program exit to print author infos.
    AuthorInfos,

    /// Abrupt program exit due to runtime error.
    Error,
}

#[derive(Clone, PartialEq, Debug, Copy)]
pub enum StringKind {
    Remote,
    Local,
    Mixed,
}

/// Template generator trait to generate string templates.
pub trait TemplateGenerator: TemplateLister {
    /// Generates a string template matching given template names.
    ///
    /// Template generation source is not taken into consideration here. It is
    /// up to the struct implementing this trait to take that decision.
    ///
    /// # Arguments
    ///
    /// * `template_names` - The template names to be used to generate the
    ///   actual template.
    ///
    /// # Returns
    ///
    /// A result containing the generated template on success, or a
    /// [`ProgramExit`] on error (e.g. 4xx, network issues...).
    fn generate(
        &self,
        template_names: &[String],
    ) -> Result<QualifiedString, ProgramExit>;

    /// Generates a string template matching given template names, with robust
    /// template names check.
    ///
    /// Behaves the same as [`TemplateGenerator::generate`] but will
    /// return a detailed error message in case any of provided template
    /// names are not listed in available template list (as returned by
    /// [`TemplateLister::list`]).
    ///
    /// # Arguments
    ///
    /// * `template_names` - The template names to be used to generate the
    ///   actual template.
    ///
    /// # Returns
    ///
    /// A result containing the generated template on success, or a
    /// [`ProgramExit`] on error (e.g. 4xx, network issues, template not
    /// found...).
    fn generate_with_template_check(
        &self,
        template_names: &[String],
    ) -> Result<QualifiedString, ProgramExit>;
}

/// Template lister trait to list available templates.
pub trait TemplateLister {
    /// Lists available templates.
    ///
    /// Template listing source is not taken into consideration here. It is
    /// up to the struct implementing this trait to take that decision.
    ///
    /// # Returns
    ///
    /// A result containing the list of available templates on success, or a
    /// [`ProgramExit`] on error (e.g. file system failure, insufficient
    /// privilege...).
    fn list(&self) -> Result<QualifiedString, ProgramExit>;
}