concinnity_dev/command/
explain.rs

1// src/cli/explain.rs
2// Print one asset's effective entry from the expanded world: the full JSONL
3// line as the build sees it, pasteable into world.jsonl verbatim. This is the
4// override path for injected defaults and expanded assets, which have no line
5// in the authored file to copy from.
6
7use crate::command::{provenance, resolve_world_path};
8
9/// Print one asset's effective entry from the expanded world, with where
10/// each value came from.
11pub fn explain(name: &str, json_path: Option<&str>) -> std::io::Result<()> {
12    let json_path = resolve_world_path(json_path)?;
13    let content = std::fs::read_to_string(&json_path)?;
14
15    let loaded = concinnity_cook::prepare_world(&content, crate::project::assets_dir().as_deref())
16        .map_err(|errs| concinnity_cook::check::report_validation_errors(&errs))?;
17
18    let Some(asset) = loaded.assets.iter().find(|a| a.name == name) else {
19        let mut close: Vec<&str> = loaded
20            .assets
21            .iter()
22            .map(|a| a.name.as_str())
23            .filter(|n| n.contains(name))
24            .take(5)
25            .collect();
26        close.sort_unstable();
27        let hint = if close.is_empty() {
28            String::new()
29        } else {
30            format!("; close matches: {}", close.join(", "))
31        };
32        return Err(std::io::Error::new(
33            std::io::ErrorKind::NotFound,
34            format!("no asset named '{}' in the expanded world{}", name, hint),
35        ));
36    };
37
38    let line = serde_json::json!({
39        "name": asset.name,
40        "type": asset.asset_type,
41        "args": asset.args,
42    });
43
44    println!("// {}", provenance(&loaded, &asset.name));
45    println!("{}", serde_json::to_string(&line)?);
46    Ok(())
47}
48
49#[cfg(test)]
50mod tests {
51    use super::*;
52
53    fn write_world(content: &str) -> (tempfile::TempDir, String) {
54        let dir = tempfile::tempdir().unwrap();
55        let path = dir.path().join("world.jsonl");
56        std::fs::write(&path, content).unwrap();
57        (dir, path.to_string_lossy().into_owned())
58    }
59
60    #[test]
61    fn explain_prints_a_known_asset() {
62        let (_dir, path) =
63            write_world("{\"name\":\"gfx\",\"type\":\"GraphicsConfig\",\"args\":{}}\n");
64        explain("gfx", Some(&path)).unwrap();
65    }
66
67    #[test]
68    fn explain_of_an_unknown_name_offers_close_matches() {
69        let (_dir, path) =
70            write_world("{\"name\":\"gfx\",\"type\":\"GraphicsConfig\",\"args\":{}}\n");
71        let err = explain("gf", Some(&path)).unwrap_err();
72        assert_eq!(err.kind(), std::io::ErrorKind::NotFound);
73        let msg = err.to_string();
74        assert!(msg.contains("close matches"), "got: {msg}");
75        assert!(msg.contains("gfx"), "got: {msg}");
76    }
77
78    #[test]
79    fn explain_of_an_unknown_name_without_matches_has_no_hint() {
80        let (_dir, path) =
81            write_world("{\"name\":\"gfx\",\"type\":\"GraphicsConfig\",\"args\":{}}\n");
82        let err = explain("zzz_nothing", Some(&path)).unwrap_err();
83        assert_eq!(err.kind(), std::io::ErrorKind::NotFound);
84        assert!(!err.to_string().contains("close matches"), "got: {err}");
85    }
86
87    #[test]
88    fn explain_surfaces_validation_failures() {
89        let (_dir, path) =
90            write_world("{\"name\":\"odd\",\"type\":\"NotARealAssetType\",\"args\":{}}\n");
91        assert!(explain("odd", Some(&path)).is_err());
92    }
93}
concinnity_dev/command/explain.rs

concinnity_dev/command/
explain.rs
