a4-cli 0.52.0

CLI tool for generating TypeScript SDKs from Arete stream specifications
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
use anyhow::{Context, Result};
use colored::Colorize;
use dialoguer::{theme::ColorfulTheme, Input, Select};
use std::fs;
use std::path::Path;
use std::process::{Command, Stdio};

use crate::telemetry;
use crate::templates::{
    customize_project, detect_package_manager, dev_command, install_command, start_command,
    Template, TemplateManager,
};
use crate::ui;

const TEMPLATE_CHOICES: &str = "protocol|protocol-app|react-ore|rust-ore|typescript-ore|python-ore";

/// Human progress goes to stdout in normal mode and is suppressed with
/// `--json`, where stdout carries exactly one JSON object.
macro_rules! say {
    ($json:expr, $($arg:tt)*) => {
        if !$json {
            println!($($arg)*);
        }
    };
}

pub fn create(
    name: Option<String>,
    template: Option<String>,
    offline: bool,
    force_refresh: bool,
    skip_install: bool,
    json: bool,
) -> Result<()> {
    let start = std::time::Instant::now();
    let theme = ColorfulTheme::default();

    if !ui::interactive() && (name.is_none() || template.is_none()) {
        let mut missing = Vec::new();
        if name.is_none() {
            missing.push("<name>");
        }
        if template.is_none() {
            missing.push("--template");
        }
        anyhow::bail!(
            "Missing {} and no terminal to prompt on. Pass: a4 create <name> --template {}",
            missing.join(" and "),
            TEMPLATE_CHOICES
        );
    }

    let project_name = match name {
        Some(n) => n,
        None => Input::with_theme(&theme)
            .with_prompt("Project name")
            .default("my-arete-app".to_string())
            .interact_text()
            .context("Failed to read project name")?,
    };

    let selected_template = match template {
        Some(t) => Template::from_str(&t).ok_or_else(|| {
            anyhow::anyhow!("Unknown template: {}. Available: {}", t, TEMPLATE_CHOICES)
        })?,
        None => {
            let items: Vec<String> = Template::ALL
                .iter()
                .map(|t| format!("{} - {}", t.display_name(), t.description()))
                .collect();

            let selection = Select::with_theme(&theme)
                .with_prompt("Select a template")
                .items(&items)
                .default(0)
                .interact()
                .context("Failed to select template")?;

            Template::ALL[selection]
        }
    };

    telemetry::record_template_selected(selected_template.display_name());

    let project_dir = Path::new(&project_name);

    if project_dir.exists() {
        anyhow::bail!(
            "Directory '{}' already exists. Choose a different name or remove it first.",
            project_name
        );
    }

    if selected_template.is_protocol() {
        return create_protocol(&project_name, selected_template, skip_install, json, start);
    }

    let manager = TemplateManager::new()?;

    if force_refresh {
        if !json {
            ui::print_step("Clearing template cache...");
        }
        manager.clear_cache()?;
    }

    if !manager.is_cached() {
        if offline {
            anyhow::bail!(
                "Templates not cached and --offline specified. Run without --offline first."
            );
        }

        if !json {
            ui::print_step("Downloading templates...");
        }
        manager.fetch_templates()?;
        say!(json, "  {} Templates cached", ui::symbols::SUCCESS.green());
    }

    if !json {
        ui::print_step(&format!(
            "Creating {} from {}...",
            project_name.bold(),
            selected_template.display_name().cyan()
        ));
    }

    fs::create_dir_all(project_dir)
        .with_context(|| format!("Failed to create directory: {}", project_name))?;

    manager.copy_template(selected_template, project_dir)?;
    customize_project(project_dir, &project_name)?;

    say!(
        json,
        "  {} Project scaffolded",
        ui::symbols::SUCCESS.green()
    );

    let mut installed_dependencies = false;
    let next: Vec<String> = if selected_template.is_rust() {
        say!(json, "");
        if !json {
            print_rust_next_steps(&project_name);
        }
        vec![format!("cd {project_name}"), "cargo run".to_string()]
    } else if selected_template.is_python() {
        say!(json, "");
        if !json {
            print_python_next_steps(&project_name);
        }
        vec![format!("cd {project_name}"), "python main.py".to_string()]
    } else {
        let pm = detect_package_manager();
        installed_dependencies = if skip_install {
            false
        } else {
            run_npm_install(project_dir, pm, json)?
        };
        say!(json, "");
        let run = if selected_template.is_typescript_cli() {
            if !json {
                print_ts_cli_next_steps(&project_name, pm, installed_dependencies);
            }
            start_command(pm)
        } else {
            if !json {
                print_js_next_steps(&project_name, pm, installed_dependencies);
            }
            dev_command(pm)
        };
        let mut next = vec![format!("cd {project_name}")];
        if !installed_dependencies {
            next.push(install_command(pm).to_string());
        }
        next.push(run.to_string());
        next
    };

    if json {
        let output = serde_json::json!({
            "schemaVersion": 1,
            "path": project_dir.display().to_string(),
            "template": selected_template.display_name(),
            "installedDependencies": installed_dependencies,
            "next": next,
        });
        println!("{}", serde_json::to_string_pretty(&output)?);
    }

    telemetry::record_create_completed(selected_template.display_name(), start.elapsed());

    Ok(())
}

/// The protocol templates, built into the CLI: `a4 protocol init`'s
/// scaffold, and for `protocol-app` the app and server on top of it.
fn create_protocol(
    project_name: &str,
    template: Template,
    skip_install: bool,
    json: bool,
    start: std::time::Instant,
) -> Result<()> {
    let project_dir = Path::new(project_name);
    if !json {
        ui::print_step(&format!(
            "Creating {} from {}...",
            project_name.bold(),
            template.display_name().cyan()
        ));
    }
    let args = crate::commands::protocol::init::InitArgs {
        dir: project_dir.to_path_buf(),
        ..Default::default()
    };
    let outcome = if template == Template::ProtocolApp {
        crate::commands::protocol::app::scaffold(&args)?
    } else {
        crate::commands::protocol::init::scaffold(&args)?
    };
    for warning in &outcome.warnings {
        if !json {
            ui::print_warning(warning);
        }
    }
    say!(
        json,
        "  {} Protocol {} scaffolded",
        ui::symbols::SUCCESS.green(),
        outcome.name.bold()
    );

    let pm = detect_package_manager();
    let installed_dependencies = if skip_install {
        false
    } else {
        run_npm_install(project_dir, pm, json)?
    };
    let mut next = vec![format!("cd {project_name}")];
    if !installed_dependencies {
        next.push(install_command(pm).to_string());
    }
    next.push("a4 dev up".to_string());
    if template == Template::ProtocolApp {
        next.push(format!("{} app", run_script(pm)));
    }

    if json {
        let output = serde_json::json!({
            "schemaVersion": 1,
            "path": project_dir.display().to_string(),
            "template": template.display_name(),
            "protocol": outcome.name,
            "installedDependencies": installed_dependencies,
            "next": next,
        });
        println!("{}", serde_json::to_string_pretty(&output)?);
    } else {
        println!();
        println!(
            "{} {}",
            ui::symbols::SUCCESS.green().bold(),
            "Ready!".bold()
        );
        println!();
        println!("Deploy it to a dev environment and iterate (see README.md):");
        println!();
        println!("  {} {}", "$".dimmed(), next.join(" && ").cyan());
        println!();
    }
    telemetry::record_create_completed(template.display_name(), start.elapsed());
    Ok(())
}

/// How a package manager runs a package.json script.
fn run_script(pm: &str) -> &'static str {
    match pm {
        "yarn" => "yarn",
        "pnpm" => "pnpm",
        "bun" => "bun run",
        _ => "npm run",
    }
}

fn run_npm_install(project_dir: &Path, pm: &str, json: bool) -> Result<bool> {
    if !json {
        ui::print_step("Installing dependencies...");
    }

    let (cmd, args) = match pm {
        "yarn" => ("yarn", vec!["install"]),
        "pnpm" => ("pnpm", vec!["install"]),
        "bun" => ("bun", vec!["install"]),
        _ => ("npm", vec!["install"]),
    };

    // With --json stdout must carry only our JSON object; package-manager
    // chatter goes to stderr. stdin is never inherited so the child cannot
    // block on a prompt.
    let status = Command::new(cmd)
        .args(&args)
        .current_dir(project_dir)
        .stdin(Stdio::null())
        .stdout(if json {
            Stdio::null()
        } else {
            Stdio::inherit()
        })
        .stderr(Stdio::inherit())
        .status()
        .with_context(|| format!("Failed to run {}", install_command(pm)))?;

    if status.success() {
        say!(
            json,
            "  {} Dependencies installed",
            ui::symbols::SUCCESS.green()
        );
        Ok(true)
    } else {
        if json {
            eprintln!(
                "Install failed (exit code: {}); retry with: {}",
                status.code().unwrap_or(-1),
                install_command(pm)
            );
        } else {
            println!(
                "  {} Install failed (exit code: {})",
                ui::symbols::FAILURE.red(),
                status.code().unwrap_or(-1)
            );
            println!(
                "    You can retry manually with: {}",
                install_command(pm).dimmed()
            );
        }
        Ok(false)
    }
}

fn print_js_next_steps(project_name: &str, pm: &str, install_succeeded: bool) {
    println!(
        "{} {}",
        ui::symbols::SUCCESS.green().bold(),
        "Ready!".bold()
    );
    println!();

    if install_succeeded {
        println!("Start the dev server:");
        println!();
        println!(
            "  {} {} && {}",
            "$".dimmed(),
            format!("cd {}", project_name).cyan(),
            dev_command(pm).cyan()
        );
    } else {
        println!("Install dependencies and start:");
        println!();
        println!(
            "  {} {} && {} && {}",
            "$".dimmed(),
            format!("cd {}", project_name).cyan(),
            install_command(pm).cyan(),
            dev_command(pm).cyan()
        );
    }

    println!();
}

fn print_rust_next_steps(project_name: &str) {
    println!(
        "{} {}",
        ui::symbols::SUCCESS.green().bold(),
        "Ready!".bold()
    );
    println!();
    println!("Build and run:");
    println!();
    println!(
        "  {} {} && {}",
        "$".dimmed(),
        format!("cd {}", project_name).cyan(),
        "cargo run".cyan()
    );
    println!();
}

fn print_python_next_steps(project_name: &str) {
    println!(
        "{} {}",
        ui::symbols::SUCCESS.green().bold(),
        "Ready!".bold()
    );
    println!();
    println!("Run the client:");
    println!();
    println!(
        "  {} {} && {}",
        "$".dimmed(),
        format!("cd {}", project_name).cyan(),
        "python main.py".cyan()
    );
    println!();
}

fn print_ts_cli_next_steps(project_name: &str, pm: &str, install_succeeded: bool) {
    println!(
        "{} {}",
        ui::symbols::SUCCESS.green().bold(),
        "Ready!".bold()
    );
    println!();

    if install_succeeded {
        println!("Run the CLI:");
        println!();
        println!(
            "  {} {} && {}",
            "$".dimmed(),
            format!("cd {}", project_name).cyan(),
            start_command(pm).cyan()
        );
    } else {
        println!("Install dependencies and run:");
        println!();
        println!(
            "  {} {} && {} && {}",
            "$".dimmed(),
            format!("cd {}", project_name).cyan(),
            install_command(pm).cyan(),
            start_command(pm).cyan()
        );
    }

    println!();
}