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
use super::{Builder, sorted_keys};
use crate::color;
use anyhow::Result;
use serde::Serialize;
use std::process::Command;
#[derive(Serialize)]
struct DoctorCheck {
name: String,
status: &'static str,
category: &'static str,
#[serde(skip_serializing_if = "Option::is_none")]
detail: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
install_hint: Option<String>,
}
impl Builder {
/// Run diagnostic checks on the build environment.
pub fn doctor(&self, ctx: &crate::build_context::BuildContext) -> Result<()> {
let json_mode = crate::json_output::is_json_mode();
let mut ok_count = 0usize;
let mut fail_count = 0usize;
let mut warn_count = 0usize;
let mut checks: Vec<DoctorCheck> = Vec::new();
let mut record = |name: String,
status: &'static str,
category: &'static str,
detail: Option<String>,
install_hint: Option<String>,
ok: &mut usize,
fail: &mut usize,
warn: &mut usize| {
match status {
"ok" => *ok += 1,
"fail" => *fail += 1,
"warn" => *warn += 1,
_ => {}
}
if !json_mode {
let detail_str = detail
.as_deref()
.map(|d| format!(" ({d})"))
.unwrap_or_default();
let hint_str = install_hint
.as_deref()
.map(|h| format!(" install: {h}"))
.unwrap_or_default();
let tag: String = match status {
"ok" => color::green("[ok]").to_string(),
"fail" => color::red("[FAIL]").to_string(),
"warn" => color::yellow("[warn]").to_string(),
_ => status.to_string(),
};
println!("{tag} {name}{detail_str}{hint_str}");
}
checks.push(DoctorCheck {
name,
status,
category,
detail,
install_hint,
});
};
// Check rsconstruct.toml
if std::path::Path::new("rsconstruct.toml").exists() {
record(
"rsconstruct.toml found and valid".to_string(),
"ok",
"config",
None,
None,
&mut ok_count,
&mut fail_count,
&mut warn_count,
);
} else {
record(
"rsconstruct.toml not found".to_string(),
"fail",
"config",
None,
None,
&mut ok_count,
&mut fail_count,
&mut warn_count,
);
}
// Check .rsconstructignore
if std::path::Path::new(".rsconstructignore").exists() {
record(
".rsconstructignore found".to_string(),
"ok",
"config",
None,
None,
&mut ok_count,
&mut fail_count,
&mut warn_count,
);
} else {
record(
".rsconstructignore not found (optional)".to_string(),
"warn",
"config",
None,
None,
&mut ok_count,
&mut fail_count,
&mut warn_count,
);
}
// Check tools for enabled processors
let processors = self.create_processors()?;
let mut checked_tools = std::collections::HashSet::new();
for name in sorted_keys(&processors) {
let processor = &processors[name];
for tool in processor.required_tools() {
if !checked_tools.insert(tool.clone()) {
continue;
}
if let Some(version) = tool_version(ctx, &tool) {
record(
format!("{tool} available"),
"ok",
"tool",
Some(version),
None,
&mut ok_count,
&mut fail_count,
&mut warn_count,
);
} else {
let install_hint = crate::tools::tool_install_command(&tool);
record(
format!("{tool} not found"),
"fail",
"tool",
None,
install_hint,
&mut ok_count,
&mut fail_count,
&mut warn_count,
);
}
}
}
// Check declared dependencies. The Python set comes from uv.lock by
// default (pyproject.toml in pyproject mode) plus [dependencies].pip.
let deps = &self.config.dependencies;
let pip_deps = deps.effective_pip(std::path::Path::new("."))?;
if !deps.is_empty() || !pip_deps.is_empty() {
if !json_mode {
println!();
println!("{}:", color::bold("Declared dependencies"));
}
for pkg in &deps.system {
// A system dependency is a package, not a tool: ask the
// package manager whether it is installed. which() is wrong
// here — packages like aspell-en (a dictionary) ship no
// binary named after themselves, so which() reported them
// as missing even right after install-deps put them on.
if super::tools::is_system_package_installed(ctx, pkg) {
record(
format!("{pkg} (system)"),
"ok",
"dependency",
None,
None,
&mut ok_count,
&mut fail_count,
&mut warn_count,
);
} else {
record(
format!("{pkg} not found"),
"fail",
"dependency",
Some("system".to_string()),
Some("rsconstruct tools install-deps".to_string()),
&mut ok_count,
&mut fail_count,
&mut warn_count,
);
}
}
for pkg in &pip_deps {
let name = crate::config::normalized_distribution_name(pkg);
let found = package_installed(ctx, "pip", &["show", "--quiet", name.as_str()]);
if found {
record(
format!("{pkg} (pip)"),
"ok",
"dependency",
None,
None,
&mut ok_count,
&mut fail_count,
&mut warn_count,
);
} else {
record(
format!("{pkg} not installed"),
"fail",
"dependency",
Some("pip".to_string()),
Some(format!("pip install {pkg}")),
&mut ok_count,
&mut fail_count,
&mut warn_count,
);
}
}
for pkg in &deps.npm {
let found = package_installed(ctx, "npm", &["list", "--depth=0", pkg]);
if found {
record(
format!("{pkg} (npm)"),
"ok",
"dependency",
None,
None,
&mut ok_count,
&mut fail_count,
&mut warn_count,
);
} else {
record(
format!("{pkg} not installed"),
"fail",
"dependency",
Some("npm".to_string()),
Some(format!("npm install {pkg}")),
&mut ok_count,
&mut fail_count,
&mut warn_count,
);
}
}
for pkg in &deps.gem {
let found = package_installed(ctx, "gem", &["list", "--installed", "--exact", pkg]);
if found {
record(
format!("{pkg} (gem)"),
"ok",
"dependency",
None,
None,
&mut ok_count,
&mut fail_count,
&mut warn_count,
);
} else {
record(
format!("{pkg} not installed"),
"fail",
"dependency",
Some("gem".to_string()),
Some(format!("gem install {pkg}")),
&mut ok_count,
&mut fail_count,
&mut warn_count,
);
}
}
}
let total = ok_count + fail_count;
if json_mode {
let out = serde_json::json!({
"checks": checks,
"summary": {
"ok": ok_count,
"fail": fail_count,
"warn": warn_count,
"total": total,
},
});
println!("{}", serde_json::to_string_pretty(&out)?);
} else {
println!();
let summary = format!("Summary: {ok_count}/{total} checks passed");
if fail_count == 0 {
println!("{}", color::green(&summary));
} else {
println!("{}", color::yellow(&summary));
}
}
Ok(())
}
}
/// Whether a package manager reports `pkg` as installed. One helper for the
/// pip/npm/gem probes, which were three copies of the same block.
fn package_installed(
ctx: &crate::build_context::BuildContext,
program: &str,
args: &[&str],
) -> bool {
let mut cmd = Command::new(program);
cmd.args(args);
crate::processors::run_command_capture(ctx, &cmd).is_ok_and(|o| o.status.success())
}
/// Try to get the version string of a tool by running `tool --version`.
fn tool_version(ctx: &crate::build_context::BuildContext, tool: &str) -> Option<String> {
let mut cmd = Command::new(tool);
cmd.arg("--version");
let output = crate::processors::run_command_capture(ctx, &cmd).ok()?;
if !output.status.success() {
return None;
}
let version = String::from_utf8_lossy(&output.stdout);
let version = version.trim();
if version.is_empty() {
let version = String::from_utf8_lossy(&output.stderr);
let first_line = version.lines().next().unwrap_or("").trim();
if first_line.is_empty() {
return Some("ok".to_string());
}
return Some(first_line.to_string());
}
Some(version.lines().next().unwrap_or(version).to_string())
}