exor 0.1.1

Batteries included cli tool for generating git fork diff documentation websites via YAML configuration 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

use serde::{Deserialize, Serialize};

/// The exor Fork Config YAML
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(default)]
pub struct ForkConfig {
    /// The site title.
    /// If the title is not provided, the default value
    /// `EXOR Generated Fork Diff Site` will be used.
    pub title: String,
    /// The site logo.
    /// If the logo is not provided, the default value
    /// `https://raw.githubusercontent.com/refcell/exor/main/etc/logo.png` will be used.
    /// The logo must be a valid URL.
    #[serde(skip_serializing_if = "String::is_empty")]
    pub logo: String,
    /// The site footer. An optional value.
    /// If no footer is specified, the generated site will not have a footer.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub footer: Option<String>,
    /// The Base [Source] Object.
    #[serde(skip_serializing_if = "Source::is_default")]
    pub base: Source,
    /// The Fork [Source] Object.
    #[serde(skip_serializing_if = "Source::is_default")]
    pub fork: Source,
    /// The fork diff site definition.
    #[serde(skip_serializing_if = "Section::is_default")]
    pub def: Section,
    /// Glob paths to exclude from the diff.
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub ignore: Vec<String>,
}

/// A Site Definition Section
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(default)]
pub struct Section {
    /// The site title
    pub title: String,
    /// Description
    pub description: String,
    /// Globs
    pub globs: Vec<String>,
    /// Sub-sections
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub sub: Vec<Box<Section>>,
}

impl Section {
    /// Returns true if the section is default.
    pub fn is_default(&self) -> bool {
        self == &Section::default()
    }
}

/// A Source Object
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(default)]
pub struct Source {
    /// The source name.
    pub name: String,
    /// The source description.
    pub description: String,
    /// The source config.
    #[serde(flatten)]
    pub config: SourceConfig,
}

impl Source {
    /// Returns true if the source is default.
    pub fn is_default(&self) -> bool {
        self == &Source::default()
    }
}

/// Git Source
///
/// A git source is an enum with internal fields that hold configuration
/// for the git source.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(untagged)]
pub enum SourceConfig {
    /// A git source that is a local git repository.
    Local(String),
    /// A git source that is a remote git repository.
    Git(GitSource),
}

impl Default for SourceConfig {
    fn default() -> Self {
        SourceConfig::Git(GitSource::default())
    }
}

/// A Git Repository Source
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(default)]
pub struct GitSource {
    /// The name of the git
    /// The git repository URL.
    pub url: String,
    /// The git reference.
    pub r#ref: String,
    /// The git repository branch.
    pub branch: String,
}