opencode-ralph-loop-cli 0.1.0

Scaffolder CLI for OpenCode Ralph Loop plugin — one command setup
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

use rust_embed::RustEmbed;

pub const TEMPLATE_VERSION: &str = "1.0.0";

#[derive(RustEmbed)]
#[folder = "templates/"]
pub struct Assets;

pub const DEFAULT_PLUGIN_VERSION: &str = "1.4.7";

pub struct RenderContext {
    pub plugin_version: String,
}

impl Default for RenderContext {
    fn default() -> Self {
        Self {
            plugin_version: DEFAULT_PLUGIN_VERSION.to_string(),
        }
    }
}

impl RenderContext {
    pub fn with_version(version: impl Into<String>) -> Self {
        Self {
            plugin_version: version.into(),
        }
    }
}

/// Renders a template by replacing placeholders according to the context.
/// Returns None if the template does not exist.
pub fn render_template(path: &str, ctx: &RenderContext) -> Option<Vec<u8>> {
    let file = Assets::get(path)?;
    if path == "package.json.template" {
        let content = std::str::from_utf8(&file.data).ok()?;
        let rendered = content.replace("{{PLUGIN_VERSION}}", &ctx.plugin_version);
        Some(rendered.into_bytes())
    } else {
        Some(file.data.into_owned())
    }
}

/// Converts a template path to a relative output path under .opencode/
pub fn template_to_output_path(template_path: &str) -> &'static str {
    match template_path {
        "plugins/ralph.ts" => "plugins/ralph.ts",
        "commands/ralph-loop.md" => "commands/ralph-loop.md",
        "commands/cancel-ralph.md" => "commands/cancel-ralph.md",
        "commands/ralph-help.md" => "commands/ralph-help.md",
        "package.json.template" => "package.json",
        ".gitignore.template" => ".gitignore",
        _ => "",
    }
}

/// Lists the 6 canonical templates in deterministic order.
pub fn canonical_templates() -> &'static [&'static str] {
    &[
        "plugins/ralph.ts",
        "commands/ralph-loop.md",
        "commands/cancel-ralph.md",
        "commands/ralph-help.md",
        "package.json.template",
        ".gitignore.template",
    ]
}

/// Returns the SHA-256 hex of an embedded template's content (post-render for package.json).
pub fn template_canonical_hash(path: &str, ctx: &RenderContext) -> Option<String> {
    let bytes = render_template(path, ctx)?;
    Some(crate::hash::sha256_hex(&bytes))
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn all_canonical_templates_exist() {
        let ctx = RenderContext::default();
        for path in canonical_templates() {
            let result = render_template(path, &ctx);
            assert!(result.is_some(), "template not found: {path}");
        }
    }

    #[test]
    fn package_json_substitutes_version() {
        let ctx = RenderContext::with_version("9.9.9");
        let bytes = render_template("package.json.template", &ctx).unwrap();
        let content = String::from_utf8(bytes).unwrap();
        assert!(
            content.contains("9.9.9"),
            "version not substituted: {content}"
        );
        assert!(!content.contains("{{PLUGIN_VERSION}}"));
    }

    #[test]
    fn default_version_is_correct() {
        assert_eq!(DEFAULT_PLUGIN_VERSION, "1.4.7");
    }

    #[test]
    fn template_to_output_path_mappings() {
        assert_eq!(
            template_to_output_path("plugins/ralph.ts"),
            "plugins/ralph.ts"
        );
        assert_eq!(
            template_to_output_path("package.json.template"),
            "package.json"
        );
        assert_eq!(template_to_output_path(".gitignore.template"), ".gitignore");
    }
}