yog-cli 0.41.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

//! A mod's own kinds of book page: `.yui` components with `book_page`,
//! compiled into `yog_book::page_type::PageType`s for the books that use
//! them (see that module).
//!
//! ```xml
//! <Component name="PatternPage" book_page="hexcasting:pattern">
//!     <Property name="name" type="book_text"/>
//!     <Property name="patterns" type="data" default="[]"/>
//!     <BookHeader text="{x:Bind name}"/>
//!     <Drawn drawer="hexcasting:pattern" h="64" data="{x:Bind patterns}" visible="{x:Bind patterns}"/>
//! </Component>
//! ```

use std::path::Path;

use yog_book::page_type::{PageType, compile, is_book_page};

use crate::yui::{self, Element};

/// Whether `root` is a book's own UI — a kind of page (`book_page`) or a
/// recipe layout (`recipe_layout`) — not a screen or a component.
pub fn is_book_ui(root: &Element) -> bool {
    is_book_page(root) || yog_book::layout::is_recipe_layout(root)
}

/// The mod's page types: every `book_page` component under `src/`.
pub fn find(root: &Path, ns: &str, errors: &mut Vec<String>) -> Vec<PageType> {
    let mut out = Vec::new();
    for file in yui::find_yui_files(&root.join("src")) {
        let Ok(text) = std::fs::read_to_string(&file) else { continue };
        let Ok(el) = yui::parse_xml(&text) else { continue };
        if !is_book_page(&el) {
            continue;
        }
        let shown = file.strip_prefix(root).unwrap_or(&file).display().to_string();
        match compile(&el, ns) {
            Ok(t) => out.push(t),
            Err(e) => errors.push(format!("{shown}: {e}")),
        }
    }
    out
}

/// The mod's recipe layouts: every `recipe_layout` component under `src/`.
pub fn find_layouts(root: &Path, ns: &str, errors: &mut Vec<String>) -> Vec<(String, yog_book::layout::RecipeLayout)> {
    let mut out = Vec::new();
    for file in yui::find_yui_files(&root.join("src")) {
        let Ok(text) = std::fs::read_to_string(&file) else { continue };
        let Ok(el) = yui::parse_xml(&text) else { continue };
        if !yog_book::layout::is_recipe_layout(&el) {
            continue;
        }
        let shown = file.strip_prefix(root).unwrap_or(&file).display().to_string();
        match yog_book::layout::compile(&el, ns) {
            Ok(l) => out.push((shown, l)),
            Err(e) => errors.push(format!("{shown}: {e}")),
        }
    }
    out
}