italic 0.1.0

A static site generator for creatives
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
113
114
115
116
117

use anyhow::{Context, Result, bail};
use std::fs;
use std::path::Path;

/// Files written by `italic new <dir>`. Sourced from `scaffold/` at the crate
/// root and embedded at compile time. Add a row here to ship a new file.
const SCAFFOLD_FILES: &[(&str, &str)] = &[
    ("config.yaml", include_str!("../../scaffold/config.yaml")),
    // Content: a small interlinked digital garden. Each note links to others
    // with [[wikilinks]] so the obsidian theme's backlinks have something to show.
    (
        "content/index.md",
        include_str!("../../scaffold/content/index.md"),
    ),
    (
        "content/digital-garden.md",
        include_str!("../../scaffold/content/digital-garden.md"),
    ),
    (
        "content/wikilinks.md",
        include_str!("../../scaffold/content/wikilinks.md"),
    ),
    (
        "content/backlinks.md",
        include_str!("../../scaffold/content/backlinks.md"),
    ),
    (
        "content/sitemap.html",
        include_str!("../../scaffold/content/sitemap.html"),
    ),
    (
        "static/.gitkeep",
        include_str!("../../scaffold/static/.gitkeep"),
    ),
    // The bundled "obsidian" theme: templates, styles, and config defaults for a
    // wiki / digital garden. Activated by `theme: themes/obsidian` in config.yaml.
    (
        "themes/obsidian/config.yaml",
        include_str!("../../scaffold/themes/obsidian/config.yaml"),
    ),
    (
        "themes/obsidian/templates/base.html",
        include_str!("../../scaffold/themes/obsidian/templates/base.html"),
    ),
    (
        "themes/obsidian/templates/note.html",
        include_str!("../../scaffold/themes/obsidian/templates/note.html"),
    ),
    (
        "themes/obsidian/templates/index.html",
        include_str!("../../scaffold/themes/obsidian/templates/index.html"),
    ),
    (
        "themes/obsidian/templates/sitemap.xml",
        include_str!("../../scaffold/themes/obsidian/templates/sitemap.xml"),
    ),
    (
        "themes/obsidian/static/style.css",
        include_str!("../../scaffold/themes/obsidian/static/style.css"),
    ),
];

/// Scaffold a starter site into `target`. Errors if `target` already exists at
/// all (even an empty dir): there is no merge or overwrite path in v1.
pub fn run(target: &Path) -> Result<()> {
    if target.exists() {
        bail!("path already exists: {}", target.display());
    }
    fs::create_dir_all(target).with_context(|| format!("creating {}", target.display()))?;

    for (rel, contents) in SCAFFOLD_FILES {
        let dest = target.join(rel);
        if let Some(parent) = dest.parent() {
            fs::create_dir_all(parent).with_context(|| format!("creating {}", parent.display()))?;
        }
        fs::write(&dest, contents).with_context(|| format!("writing {}", dest.display()))?;
    }

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::test_util::temp_path;

    #[test]
    fn errors_when_target_exists() {
        let dir = temp_path("exists");
        fs::create_dir_all(&dir).unwrap();
        let err = run(&dir).unwrap_err();
        assert!(err.to_string().contains("already exists"));
        fs::remove_dir_all(&dir).unwrap();
    }

    #[test]
    fn writes_all_scaffold_files() {
        let dir = temp_path("writes");
        run(&dir).unwrap();
        for (rel, _) in SCAFFOLD_FILES {
            let path = dir.join(rel);
            assert!(path.exists(), "missing {}", path.display());
        }
        fs::remove_dir_all(&dir).unwrap();
    }

    #[test]
    fn creates_nested_parent_dirs() {
        // themes/obsidian/templates/base.html requires nested-dir creation.
        let dir = temp_path("nested");
        run(&dir).unwrap();
        assert!(dir.join("content/index.md").exists());
        assert!(dir.join("themes/obsidian/templates/base.html").exists());
        assert!(dir.join("themes/obsidian/static/style.css").exists());
        fs::remove_dir_all(&dir).unwrap();
    }
}