yog_cli/
lib.rs

1//! The `yog` CLI's internals: `yog.toml` parsing, the generated
2//! `.yog-build/` workspace, `.yres` resources, `content/` blocks and items,
3//! `.yui` screens and `#[yog_export]` crates.
4//!
5//! Not for external use — a library only so the `yog` binary, its tests and
6//! its benches share the code. No API stability, not published separately.
7
8// What the binary, tests and benches reach is documented (the rest is `pub(crate)`).
9#![warn(missing_docs)]
10
11pub(crate) mod audio;
12pub mod bench;
13pub(crate) mod book_page;
14pub mod cargo_toml;
15mod consts;
16pub mod content;
17pub mod design;
18pub mod diagnostics;
19pub mod exports;
20pub(crate) mod ffmpeg;
21pub mod files;
22pub mod manifest;
23pub mod mappings;
24pub(crate) mod media;
25pub(crate) mod mix;
26pub(crate) mod recipe_area;
27pub(crate) mod rust_code;
28pub mod serve;
29pub(crate) mod video;
30pub mod yres;
31pub mod yui;
32pub mod yui_component;
33pub mod yui_grid;
34pub(crate) mod yui_resources;
35pub(crate) mod yui_vm;
36
37/// `path` with `/` between its parts, whatever the system's separator.
38pub fn slash_path(path: &std::path::Path) -> String {
39    path.to_string_lossy().replace('\\', yog_ids::sep::PATH)
40}
41
42/// `path` as a project shows it: relative to its `root`, `/`-separated.
43pub(crate) fn shown_path(root: &std::path::Path, path: &std::path::Path) -> String {
44    slash_path(path.strip_prefix(root).unwrap_or(path))
45}
46
47/// Writes generated `code` to `path` (creating its directory) unless it's
48/// already there — unchanged files keep their mtime, so cargo doesn't
49/// rebuild for nothing.
50pub(crate) fn write_if_changed(
51    path: &std::path::Path,
52    code: impl AsRef<[u8]>,
53) -> Result<(), String> {
54    let code = code.as_ref();
55    if std::fs::read(path).ok().as_deref() == Some(code) {
56        return Ok(());
57    }
58    if let Some(dir) = path.parent() {
59        std::fs::create_dir_all(dir).map_err(|e| format!("{}: {e}", dir.display()))?;
60    }
61    std::fs::write(path, code).map_err(|e| format!("{}: {e}", path.display()))
62}
yog_cli/lib.rs

yog_cli/
lib.rs
