yog-cli 0.47.0

Yog build tool — `yog build` compiles a mod and packages it as .yog.
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

//! `.yui` screen files (the screen designer's format) — regenerating their
//! code (`.yog-build/generated/**/*.g.rs`, what the code-behind pulls in
//! with `yog_api::ui_include!`) when one is saved, through `yog ui gen` —
//! and the same for `.yres` resource files (`resources/<Set>.g.rs`,
//! through `yog res check`).

use yog_ids::Format;
use std::path::PathBuf;

/// Runs `yog ui gen <path>` in the file's folder, so a saved screen's
/// generated `foo.g.rs` is current without a full build (`yog` finds the
/// project from the `yog.toml` above the file). The result carries what
/// `yog` printed either way — its errors and warnings go to the Error List;
/// `Err` only when `yog` couldn't run at all.
pub fn codegen(path: &str) -> Result<Codegen, String> {
    let file = PathBuf::from(path);
    let args: &[&str] = match Format::of_path(&file) {
        Some(Format::Ui) => &["ui", "gen"],
        // Regenerates `.yog-build/generated/resources/<Set>.g.rs` (and checks the set).
        Some(Format::Res) => &["res", "check"],
        // Regenerates `.yog-build/generated/yog-content.g.rs` and its parts (and checks every content file).
        Some(Format::Block | Format::Item) => &["content", "check"],
        _ => return Err(format!("not a .yui, .yres, .yblock or .yitem file: {path}")),
    };
    let mut command = crate::design::this_cli();
    command.args(args);
    if args[0] == "ui" {
        command.arg(&file);
    }
    // `yog res check` / `yog content check` work on the project in the current folder.
    let project = file
        .ancestors()
        .skip(1)
        .find(|d| crate::design::project::path(d).is_file());
    let dir = (if args[0] != "ui" { project } else { None })
        .or(file.parent())
        .filter(|d| d.is_dir());
    if let Some(dir) = dir {
        command.current_dir(dir);
    }
    let output = command
        .output()
        .map_err(|e| format!("failed to run yog: {e}"))?;
    let log = String::from_utf8_lossy(&output.stderr).into_owned();
    let ok = output.status.success();
    Ok(Codegen {
        // "==> src/foo.yui -> /project/.yog-build/generated/foo.g.rs"
        generated: log
            .lines()
            .find_map(|l| l.rsplit_once(" -> ").map(|(_, out)| out.trim().to_string()))
            .filter(|_| ok)
            .unwrap_or_default(),
        error: (!ok).then(|| {
            let message = log
                .lines()
                .map(|l| l.trim_start_matches("yog: error: "))
                .collect::<Vec<_>>()
                .join("\n");
            if message.trim().is_empty() {
                format!("yog {} failed ({})", args.join(" "), output.status)
            } else {
                message.trim().to_string()
            }
        }),
        root: dir.map(|d| d.to_string_lossy().into_owned()).unwrap_or_default(),
        log,
    })
}

/// One regeneration: the generated file (empty on failure), the failure's
/// message, and `yog`'s full output with the folder it ran in — what the
/// Error List reads the file's errors and warnings from.
#[derive(serde::Serialize)]
pub struct Codegen {
    pub generated: String,
    pub error: Option<String>,
    pub log: String,
    pub root: String,
}