Files
Graphite/tools/cargo-run/src/requirements.rs
Timon f798b48b83 Move branding and package install into cargo-run (#4266)
* Move branding asset fetch into cargo-run

* Move frontend npm install into cargo-run

* Rename branding::ensure to branding::setup

* Wording nits

---------

Co-authored-by: Keavon Chambers <keavon@keavon.com>
2026-06-22 20:21:46 +00:00

331 lines
9.6 KiB
Rust

use semver::{Version, VersionReq};
use std::io::IsTerminal;
use crate::cmd::prelude::*;
use crate::*;
mod wasm_opt;
#[derive(Default, Clone)]
pub struct Requirement {
command: &'static str,
args: &'static [&'static str],
name: &'static str,
check: Check,
version: Option<&'static str>,
install: InstallAction,
skip: Option<&'static dyn Fn(&Task) -> bool>,
}
fn requirements(task: &Task) -> Vec<Requirement> {
[
Requirement {
command: "rustc",
args: &["--version"],
name: "Rust",
..Default::default()
},
Requirement {
command: "rustc",
args: &["--print", "target-libdir", "--target", "wasm32-unknown-unknown"],
check: Check::Matches(&|out| std::path::Path::new(out.trim()).is_dir()),
name: "Rust - Wasm Target",
install: "rustup target add wasm32-unknown-unknown".into(),
skip: Some(&|task| matches!(task.target, Target::Cli)),
..Default::default()
},
Requirement {
command: "wasm-opt",
args: &["--version"],
name: "Wasm Opt",
version: Some(">=130"),
install: wasm_opt::install_action(),
skip: Some(&|task| {
matches!(task.target, Target::Cli)
|| match task.profile {
Profile::Debug => true,
Profile::Release => false,
Profile::Default => matches!(task.action, Action::Run),
}
}),
..Default::default()
},
Requirement {
command: "wasm-bindgen",
args: &["--version"],
name: "Wasm Bindgen",
version: Some("=0.2.121"),
install: "cargo install -f wasm-bindgen-cli@0.2.121".into(),
skip: Some(&|task| matches!(task.target, Target::Cli)),
..Default::default()
},
Requirement {
command: "cargo-about",
args: &["--version"],
name: "Cargo About",
install: "cargo install cargo-about".into(),
skip: Some(&|task| matches!(task.target, Target::Cli)),
..Default::default()
},
Requirement {
command: "node",
args: &["--version"],
name: "Node.js",
skip: Some(&|task| matches!(task.target, Target::Cli)),
..Default::default()
},
Requirement {
command: "cmake",
args: &["--version"],
name: "CMake",
install: InstallAction::ManualInstructions("https://cmake.org/download/ or find it in your system's package manager"),
skip: Some(&|task| !matches!(task.target, Target::Desktop) || cfg!(target_os = "linux")),
..Default::default()
},
Requirement {
command: "ninja",
args: &["--version"],
name: "Ninja",
install: InstallAction::ManualInstructions("https://github.com/ninja-build/ninja/releases or find it in your system's package manager"),
skip: Some(&|task| !matches!(task.target, Target::Desktop) || cfg!(target_os = "linux")),
..Default::default()
},
]
.iter()
.filter(|d| if let Some(skip) = d.skip { !skip(task) } else { true })
.cloned()
.collect()
}
pub fn check(task: &Task) -> Result<(), Error> {
eprintln!();
eprintln!("Checking Requirements:");
let mut installable: Vec<Requirement> = Vec::new();
let mut manual: Vec<(Requirement, String)> = Vec::new();
for dep in requirements(task) {
match cmd(dep.command, dep.args.iter().copied()).output_unchecked() {
Ok(output) if output.status.success() => {
let stdout = String::from_utf8_lossy(&output.stdout);
match dep.check {
Check::PrintsVersion => {
let line = stdout.lines().next().unwrap_or_default().trim();
match dep.version {
None => eprintln!("{} ({line})", dep.name),
Some(req_str) => {
let req = VersionReq::parse(req_str).expect("invalid semver requirement");
match extract_version(line) {
Some(version) if req.matches(&version) => eprintln!("{} ({version})", dep.name),
Some(version) => {
eprintln!("{} (found {version}, requires {req_str})", dep.name);
if dep.install.is_auto_installable() {
installable.push(dep);
} else {
manual.push((dep, format!("version mismatch (found {version}, requires {req_str})")));
}
}
None => {
eprintln!("{} (could not parse version from '{line}')", dep.name);
manual.push((dep, format!("could not parse version from '{line}'")));
}
}
}
}
}
Check::Matches(check) => {
if !check(stdout.to_string()) {
eprintln!("{} - check failed", dep.name);
if dep.install.is_auto_installable() {
installable.push(dep);
} else {
manual.push((dep, "check failed".into()));
}
} else {
eprintln!("{}", dep.name);
}
}
}
}
Ok(output) => {
let stderr = String::from_utf8_lossy(&output.stderr);
eprintln!("{} - command failed: {}", dep.name, stderr.trim());
if dep.install.is_auto_installable() {
installable.push(dep);
} else {
manual.push((dep.clone(), format!("`{}` not installed or not working", dep.command)));
}
}
Err(_) => {
eprintln!("{} - not found", dep.name);
if dep.install.is_auto_installable() {
installable.push(dep);
} else {
manual.push((dep.clone(), format!("`{}` not found in PATH", dep.command)));
}
}
}
}
eprintln!();
if installable.is_empty() && manual.is_empty() {
return Ok(());
}
let total = installable.len() + manual.len();
eprintln!("{total} requirement{} not met:", if total > 1 { "s" } else { "" });
for dep in &installable {
eprintln!(" - {}", dep.name);
}
for (dep, msg) in &manual {
eprintln!(" - {}: {msg}", dep.name);
}
if !manual.is_empty() {
eprintln!();
eprintln!("See: https://graphite.art/volunteer/guide/project-setup/");
}
let is_interactive = std::io::stdout().is_terminal() && std::io::stderr().is_terminal() && std::io::stdin().is_terminal();
// Don't prompt for automatic installation if we're not interactive session
if !is_interactive {
return Ok(());
}
if installable.is_empty() && manual.is_empty() {
return Ok(());
}
if !installable.is_empty() {
eprintln!();
eprintln!("The following can be installed automatically:");
for dep in &installable {
match &dep.install {
InstallAction::Command(cmd) => eprintln!(" - {}: {}", dep.name, cmd),
InstallAction::Expression { description, .. } => eprintln!(" - {description}"),
InstallAction::None | InstallAction::ManualInstructions(_) => unreachable!(),
}
}
eprintln!();
if installable.len() == 1 {
eprint!("Install it now? [y/N] ");
} else {
eprint!("Install them now? [y/N] ");
}
let mut input = String::new();
std::io::stdin().read_line(&mut input).map_err(|e| Error::Io(e, "Failed to read from stdin".into()))?;
let input = input.trim();
if input.eq_ignore_ascii_case("y") || input.eq_ignore_ascii_case("yes") {
for dep in installable.into_iter() {
eprintln!("Installing {}...", dep.name);
match &dep.install {
InstallAction::Command(install_cmd) => {
let parts: Vec<&str> = install_cmd.split_whitespace().collect();
let expr = cmd(parts[0], parts[1..].iter().copied()).unchecked();
match Expression::run(&expr) {
Ok(output) if !output.status.success() => {
let stderr = String::from_utf8_lossy(&output.stderr);
manual.push((dep, format!("installation command failed: {}", stderr.trim())));
}
Err(e) => return Err(Error::Command(e)),
_ => {}
}
}
InstallAction::Expression { expression, .. } => {
if let Err(e) = expression.clone().run() {
eprintln!("{e}");
eprintln!("Failed to install {}", dep.name);
manual.push((dep, format!("failed to install ({e})")));
}
}
InstallAction::None | InstallAction::ManualInstructions(_) => unreachable!(),
}
}
}
}
if !manual.is_empty() {
eprintln!();
eprintln!("Please install the following dependenc{}:", if manual.len() == 1 { "y" } else { "ies" });
for (dep, msg) in &manual {
match dep.install {
InstallAction::ManualInstructions(instructions) => eprintln!(" - {}: {}", dep.name, instructions),
_ => eprintln!(" - {}: {}", dep.name, msg),
}
}
}
if (!manual.is_empty()) && is_interactive {
eprintln!();
eprintln!("Attempt to continue regardless of unmet requirements? [y/N]");
let mut input = String::new();
std::io::stdin().read_line(&mut input).map_err(|e| Error::Io(e, "Failed to read from stdin".into()))?;
let input = input.trim();
if !input.eq_ignore_ascii_case("y") && !input.eq_ignore_ascii_case("yes") {
return Err(Error::RequirementsNotMet);
}
}
Ok(())
}
fn extract_version(line: &str) -> Option<Version> {
line.split_whitespace().find_map(|token| {
let token = token.trim_start_matches('v').trim_end_matches(|c: char| !c.is_ascii_alphanumeric());
if token.is_empty() {
return None;
}
if let Ok(version) = Version::parse(token) {
return Some(version);
}
let (core, suffix) = match token.find(['-', '+']) {
Some(i) => token.split_at(i),
None => (token, ""),
};
let parts: Vec<&str> = core.split('.').collect();
if parts.iter().any(|p| p.is_empty() || !p.chars().all(|c| c.is_ascii_digit())) {
return None;
}
let major = parts[0];
let minor = parts.get(1).copied().unwrap_or("0");
let patch = parts.get(2).copied().unwrap_or("0");
Version::parse(&format!("{major}.{minor}.{patch}{suffix}")).ok()
})
}
#[derive(Clone, Default)]
enum Check {
#[default]
PrintsVersion,
Matches(&'static dyn Fn(String) -> bool),
}
#[derive(Clone, Default)]
enum InstallAction {
#[default]
None,
Command(&'static str),
Expression {
description: String,
expression: Expression,
},
ManualInstructions(&'static str),
}
impl InstallAction {
fn is_auto_installable(&self) -> bool {
!matches!(self, InstallAction::None | InstallAction::ManualInstructions(_))
}
}
impl From<&'static str> for InstallAction {
fn from(value: &'static str) -> Self {
InstallAction::Command(value)
}
}