oranda 0.6.5

🎁 generate beautiful landing pages for your projects
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

use crate::errors::Result;
use axoasset::LocalAsset;
use camino::Utf8PathBuf;
use inquire::ui::{Color, RenderConfig, Styled};
use inquire::Confirm;
use minijinja::{context, Environment};

const CI_TEMPLATE: &str = include_str!("../templates/generate/web.yml.j2");

pub fn generate_ci(path: Utf8PathBuf, site_dir: &Option<Utf8PathBuf>) -> Result<()> {
    tracing::info!("Generating a CI deploy workflow for your site...");

    let mut env = Environment::new();
    // Modify the syntax so that it doesn't clash with GitHub Actions' syntax.
    env.set_syntax(minijinja::Syntax {
        block_start: "{{%".into(),
        block_end: "%}}".into(),
        variable_start: "{{{".into(),
        variable_end: "}}}".into(),
        comment_start: "{{#".into(),
        comment_end: "#}}".into(),
    })?;
    env.add_template_owned("web.yml", CI_TEMPLATE)?;
    let prompt_prefix = Styled::new("? >o_o<").with_fg(Color::DarkGreen);
    let render_config = RenderConfig::default().with_prompt_prefix(prompt_prefix);

    // Does the file already exist? If so, prompt the user to overwrite.
    let existing_file = if path.exists() {
        let confirm_prompt = Confirm::new(&format!(
            "There's already a file at {:?}! Do you want to override it?",
            path
        ))
        .with_default(false)
        .with_render_config(render_config)
        .prompt();

        if let Ok(false) = confirm_prompt {
            tracing::info!("Ok, exiting...");
            return Ok(());
        }
        let file = LocalAsset::load_string(&path)?;
        Some(file)
    } else {
        None
    };

    // Ask whether we want to include a link checker
    let check_links_prompt =
        Confirm::new("Do you want to include a tool for checking generated hyperlinks?")
            .with_default(true)
            .with_help_message(
                "Read more about the link checker tool: https://github.com/untitaker/hyperlink",
            )
            .with_render_config(render_config)
            .prompt()
            .expect("Error while prompting!");

    let use_latest_oranda_prompt = Confirm::new("Do you want to always use the latest version of oranda?")
        .with_default(false)
        .with_help_message("Using the latest version means you don't have to rerun this command when oranda updates, but it may also break your site if you use a lot of configuration!")
        .with_render_config(render_config)
        .prompt()
        .expect("Error while prompting!");

    let context = context!(check_links => check_links_prompt, use_latest_oranda => use_latest_oranda_prompt, site_dir => site_dir);
    let template = env.get_template("web.yml")?;
    let rendered = template.render(context)?;
    if existing_file.is_some_and(|file| file == rendered) {
        tracing::warn!("File exists and is identical, aborting...");
        return Ok(());
    }

    let append_gitignore = Confirm::new("Would you like to append the default destination directory (`public`) to your .gitignore file?")
        .with_default(false)
        .with_render_config(render_config)
        .prompt()
        .expect("Error while prompting!");
    if append_gitignore {
        append_dist_dir_to_gitignore()?;
    }

    LocalAsset::write_new_all(&rendered, &path)?;
    tracing::info!(success = true, "Wrote CI file to {:?}", path);

    Ok(())
}

fn append_dist_dir_to_gitignore() -> Result<()> {
    let path = Utf8PathBuf::from(".gitignore");
    let mut contents = if path.exists() {
        LocalAsset::load_string(&path)?
    } else {
        String::new()
    };
    contents.push_str("\n# Generated by `oranda generate ci`\npublic/");
    LocalAsset::write_new(&contents, &path)?;

    Ok(())
}