unreact 0.7.0

A static site generation framework for Rust using Handlebars and Scss.
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

use crate::{Port, DEFAULT_PORT, DEFAULT_PORT_WS};

/// Configuration struct for `Unreact`
///
/// Use `Config::default()` for default values
///
/// ## Summary
///
/// - `strict`: Whether [`Handlebars`](handlebars) uses 'strict mode'
/// - `minify`: Whether output files should be minified
///
/// Folders:
///
/// - `build`: Output folder for built files
/// - `templates`: Source folder for template files
/// - `styles`: Source folder for style files
/// - `public`: Source folder for static public files
///
/// > Note that `styles` and `public` folders in *build directory* **cannot** be configured.
///
/// Development Options:
///
/// - `port`: Port to serve *dev server* on - Only used with `"dev"` feature
/// - `port_ws`: Port to serve *dev server* **websockets** on - Only used with `"watch"` feature
/// - `watch_logs`: Whether to log update information - Only used with `"watch"` feature
#[derive(Debug)]
pub struct Config {
    /// Output folder for built files
    ///
    /// Overridden with DEV_BUILD_DIR if in dev mode
    ///
    /// Subfolders of build directory cannot be configured
    ///
    /// Default: `build` (or `.devbuild` in dev mode)
    pub build: String,
    /// Source folder for template files
    ///
    /// Default: `templates`
    pub templates: String,
    /// Source folder for style files
    ///
    /// Default: `styles`
    pub styles: String,
    /// Source folder for static public files
    ///
    /// Default: `public`
    pub public: String,

    /// Whether [`Handlebars`](handlebars) uses 'strict mode'
    ///
    /// If `true`, undefined variables and partials throw an error
    pub strict: bool,
    /// Whether output files should be minified
    ///
    /// Only affects `html` and `css` output files
    pub minify: bool,

    /// Port for main *dev server* to be hosted on
    ///
    /// Only used with `"dev"` feature, but must be defined always
    pub port: Port,
    /// Port for websocket server to be hosted on
    ///
    /// Only used with `"watch"` feature, but must be defined always
    pub port_ws: Port,
}

impl Default for Config {
    fn default() -> Self {
        Self {
            //? Move to const in lib.rs ?
            build: "build".to_string(),
            templates: "assets/templates".to_string(),
            styles: "assets/styles".to_string(),
            public: "assets/public".to_string(),

            strict: false,
            minify: true,

            port: DEFAULT_PORT,
            port_ws: DEFAULT_PORT_WS,
        }
    }
}