ddoc 0.18.0

doc site generator
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

mod cargo;
mod init_hjson;
mod init_src;
mod init_values;

pub use {
    cargo::*,
    init_hjson::*,
    init_src::*,
    init_values::*,
};

use {
    crate::*,
    std::{
        fs,
        path::Path,
    },
    termimad::crossterm::style::Stylize,
};

pub fn init_ddoc_project(dir: &Path) -> DdResult<()> {
    // first check the directory is suitable
    if dir.exists() {
        if CargoToml::in_dir(dir).is_some() {
            return Err(DdError::InitNotPossible(format!(
                "Directory {} looks busy, you should probably init ddoc in a subdirectory",
                dir.display()
            )));
        }
    } else {
        fs::create_dir_all(dir).map_err(|e| {
            DdError::InitNotPossible(format!(
                "Failed to create directory {}: {}",
                dir.display(),
                e
            ))
        })?;
    }
    let dir = dir.canonicalize()?;

    eprintln!(
        "Initializing ddoc project in {}",
        dir.display().to_string().yellow().bold()
    );

    let init_values = InitValues::guess(&dir)?;

    // plugins
    let plugins_dir = dir.join("plugins");
    if !plugins_dir.exists() {
        fs::create_dir_all(&plugins_dir)?;
        eprintln!("Initialized default plugins {}", plugins_dir.display());
        for plugin in &init_values.plugins {
            plugin.init(&dir)?;
        }
    }

    // ddoc.hjson
    let config = match init_hjson_in_dir(&dir, &init_values) {
        Err(DdError::InvalidConfig) => {
            return Err(DdError::InitNotPossible(
                "ddoc.hjson already exists but is invalid. Please delete or fix it first"
                    .to_string(),
            ));
        }
        res => res?,
    };

    // .gitignore
    let gitignore_path = dir.join(".gitignore");
    if !gitignore_path.exists() {
        fs::write(&gitignore_path, "/site\n")?;
        eprintln!("Created {}", gitignore_path.display());
    }

    // src/
    init_src_in_dir(&dir, &init_values, &config)?;

    // print some instructions
    eprintln!(
        "Head to {} for the guide on site edition",
        "https://dystroy.org/ddoc/edit".yellow().bold()
    );
    eprintln!("Run {} to try your site", "ddoc --serve".green().bold());

    Ok(())
}