dev_prune/setup.rs
1// Copyright 2026 VKrishna04
2// SPDX-License-Identifier: Apache-2.0
3
4// Idempotent installation of dev-prune's integrations.
5//
6// dev-prune is only really installed once the parts that let it work without being
7// thought about are in place: the `devp` alias, the managed pair on the user's PATH,
8// the exported `SKILL.md` that AI assistants read (installed into the agent's own
9// skills directory where one exists), the Git hooks that keep the registry current,
10// and the OS scheduler that runs the passes. Each one here is created **only when it
11// is missing**, which is
12// what makes it safe to run on every install, reinstall and upgrade — and it does run
13// on each of those, through the version stamp written at the end of a completed pass.
14//
15// Nothing in here is fatal. A machine without `git`, a `core.hooksPath` that belongs to
16// husky, a locked-down scheduler: each is reported and stepped over, because none of
17// them should stop `devp init` from registering repositories.
18
19use std::fs;
20use std::path::PathBuf;
21
22use anyhow::Result;
23
24use crate::commands::hook::{self, HookState};
25use crate::commands::skill::EMBEDDED_SKILL_MD;
26use crate::config::Registry;
27use crate::constants;
28use crate::daemon;
29use crate::output;
30
31/// File in the config directory recording the version whose last integration pass
32/// completed. A missing or older stamp is what triggers the automatic pass, so a fresh
33/// install and an upgrade both self-heal exactly once.
34const STAMP_FILE: &str = "setup-stamp";
35
36pub use crate::constants::ENV_NO_AUTO_SETUP;
37
38/// Whether the suppression variable is set — by presence, so `=1`, `=true` and even an
39/// empty value all count.
40///
41/// The one predicate every consumer must share. The doctor note used to answer only for
42/// the literal `=1`, so a machine with `=true` had setup switched off with nothing
43/// anywhere saying so.
44pub fn no_auto_setup_requested() -> bool {
45 std::env::var_os(ENV_NO_AUTO_SETUP).is_some()
46}
47
48/// Whether every network call is switched off for this process — same by-presence rule
49/// as [`no_auto_setup_requested`], and for the same reason.
50pub fn offline_requested() -> bool {
51 std::env::var_os(crate::constants::ENV_OFFLINE).is_some()
52}
53
54/// What one integration did during a pass.
55#[derive(Debug, Clone, PartialEq, Eq)]
56pub enum Outcome {
57 /// It was missing and is now in place.
58 Installed,
59 /// It was already in place and was left alone.
60 AlreadyPresent,
61 /// It could not be installed for a reason that is the user's call, not an error.
62 Skipped(String),
63 /// It failed. The pass continues; the reason is reported.
64 Failed(String),
65}
66
67/// The result of one integration pass.
68#[derive(Debug, Default)]
69pub struct SetupReport {
70 items: Vec<(&'static str, Outcome)>,
71}
72
73impl SetupReport {
74 fn push(&mut self, name: &'static str, outcome: Outcome) {
75 self.items.push((name, outcome));
76 }
77
78 /// Whether anything at all was created by this pass.
79 pub fn changed_anything(&self) -> bool {
80 self.items
81 .iter()
82 .any(|(_, o)| matches!(o, Outcome::Installed))
83 }
84
85 /// Whether anything needs the user's attention.
86 pub fn needs_attention(&self) -> bool {
87 self.items
88 .iter()
89 .any(|(_, o)| matches!(o, Outcome::Skipped(_) | Outcome::Failed(_)))
90 }
91
92 /// Print the report.
93 ///
94 /// `verbose` is for the explicit `devp setup`, where "already installed" is the
95 /// answer the user asked for. The automatic pass passes `false` and stays silent
96 /// about everything that was already fine.
97 pub fn print(&self, verbose: bool) {
98 for (name, outcome) in &self.items {
99 match outcome {
100 Outcome::Installed => output::print_success(&format!("{name}: installed.")),
101 Outcome::AlreadyPresent if verbose => {
102 output::print_info(&format!("{name}: already installed."));
103 }
104 Outcome::AlreadyPresent => {}
105 Outcome::Skipped(why) => {
106 output::print_warning(&format!("{name}: skipped — {why}"));
107 }
108 Outcome::Failed(why) => {
109 output::print_error(&format!("{name}: failed — {why}"));
110 }
111 }
112 }
113 }
114}
115
116/// Where the installers put the binary, and the one directory nothing else owns.
117///
118/// Public because it is also what the PATH step registers and what `uninstall` must
119/// take back out again.
120pub fn managed_bin_dir() -> Result<PathBuf> {
121 Ok(Registry::config_dir()?.join("bin"))
122}
123
124pub(crate) fn managed_exe_path() -> Result<PathBuf> {
125 let name = if cfg!(windows) {
126 "dev-prune.exe"
127 } else {
128 "dev-prune"
129 };
130 Ok(managed_bin_dir()?.join(name))
131}
132
133/// Absolute path to a copy of this binary that will still be there next week.
134///
135/// Anything that writes a path down for later — the OS scheduler, the git hooks — has to
136/// use this instead of [`std::env::current_exe`]. dev-prune ships through npm and PyPI as
137/// well as the installers, so the running executable is often somewhere a package manager
138/// owns and will delete: npm's `_npx` cache, uv's ephemeral tool environment, or
139/// `target/debug` during development. An entry recorded there breaks the moment that
140/// directory goes, and neither of these has anywhere to complain — the scheduled task
141/// fails silently every interval, and the hook discards its own output by design. The
142/// only symptom is that nothing ever happens again.
143///
144/// `<config>/bin` is where `install.sh` and `install.ps1` put the binary and nothing else
145/// deletes, so prefer the copy there. When there is none, put one there: the binary that
146/// is running right now is precisely the one that is going to be missing later.
147pub fn stable_exe_path() -> PathBuf {
148 let current = std::env::current_exe().unwrap_or_else(|_| PathBuf::from("dev-prune"));
149 let Ok(managed) = managed_exe_path() else {
150 return current;
151 };
152 if managed == current {
153 return managed;
154 }
155 if managed.is_file() {
156 refresh_managed_copy_if_stale(¤t, &managed);
157 return managed;
158 }
159
160 // Only ever clone something that is actually this CLI. `current_exe()` under `cargo
161 // test` is the test harness, and copying that into the config directory would be both
162 // wrong and slow.
163 if !is_this_cli(¤t) {
164 return current;
165 }
166
167 let Some(parent) = managed.parent() else {
168 return current;
169 };
170 if fs::create_dir_all(parent).is_err() {
171 return current;
172 }
173 // Hard link where the filesystem allows it — that also keeps the bytes alive when the
174 // package manager deletes the directory the original came from.
175 if fs::hard_link(¤t, &managed).is_ok() {
176 return managed;
177 }
178
179 // The same hazard `ensure_alias` documents, through a narrower window: the check at the
180 // top of this function saw no managed copy, but another process created one — as a hard
181 // link to `current` — before the link above ran. `fs::copy` opens its destination with
182 // O_TRUNC, and truncating a hard link empties the shared inode, so the copy would
183 // destroy the very binary it is copying.
184 if managed.is_file() {
185 return managed;
186 }
187
188 // Stage beside and rename into place. A copy straight onto the final name has a
189 // window where the file exists but is incomplete — and this path is what the
190 // scheduler and hooks get registered against, so a process killed mid-copy would
191 // leave a torn binary that every later pass happily points at.
192 let staging = managed.with_extension("new");
193 if fs::copy(¤t, &staging).is_ok() && fs::rename(&staging, &managed).is_ok() {
194 return managed;
195 }
196 let _ = fs::remove_file(&staging);
197 // The rename loses only to a concurrent invocation that installed its own copy,
198 // which serves exactly as well.
199 if managed.is_file() { managed } else { current }
200}
201
202/// Whether this path names one of the CLI's own binaries, by file stem.
203fn is_this_cli(path: &std::path::Path) -> bool {
204 path.file_stem()
205 .and_then(|s| s.to_str())
206 .is_some_and(|stem| stem == "dev-prune" || stem == "devp")
207}
208
209/// Replace the managed copy when it is an older release than the binary running now.
210///
211/// The scheduler and the hooks point at the managed copy precisely because it outlives
212/// package-manager caches — which also means an upgrade through cargo, npm or uv changes
213/// the running binary but not the one the integrations run, and the machine quietly
214/// keeps pruning with the previous version forever.
215///
216/// Staleness is decided by asking the copy its version, not by mtime or content: an
217/// *older* binary running out of a stale npx cache must not overwrite a newer managed
218/// copy, and content inequality cannot say which of the two is the upgrade. A copy that
219/// cannot state a version at all is replaced too — whatever it is, it is not a working
220/// build of this CLI.
221fn refresh_managed_copy_if_stale(current: &std::path::Path, managed: &std::path::Path) {
222 if !is_this_cli(current) || same_contents(managed, current) {
223 return;
224 }
225 match (binary_version(managed), parse_version(constants::VERSION)) {
226 (Some(theirs), Some(ours)) if theirs >= ours => return,
227 _ => {}
228 }
229 // Write beside and rename into place, so a scheduler firing mid-copy never runs a
230 // torn binary. A managed copy that is itself running cannot be renamed over on
231 // Windows; the refresh simply waits for a pass when it is not.
232 let staging = managed.with_extension("new");
233 if fs::copy(current, &staging).is_ok() && fs::rename(&staging, managed).is_err() {
234 let _ = fs::remove_file(&staging);
235 }
236}
237
238/// The `major.minor.patch` a binary reports for itself, if it can.
239pub(crate) fn binary_version(exe: &std::path::Path) -> Option<(u64, u64, u64)> {
240 let output = crate::spawn::command(exe).arg("--version").output().ok()?;
241 if !output.status.success() {
242 return None;
243 }
244 version_in_output(&String::from_utf8_lossy(&output.stdout))
245}
246
247/// The first `x.y.z` in a `--version` output, with or without the `v` this CLI prints.
248///
249/// Split out so it can be tested against real output. It has to accept `v1.7.0` because
250/// that is the only spelling `print_version_info` produces — the banner ends `v1.7.0`
251/// and the line under it reads `dev-prune (devp) v1.7.0`, and a bare `1.7.0` appears
252/// nowhere. Parsing the tokens without stripping that `v` answered `None` for every real
253/// dev-prune on the machine, and `doctor`'s "Other copies" check reads `None` as "not a
254/// dev-prune at all" — so it reported "none on PATH running a different version" however
255/// many stale copies were sitting there.
256fn version_in_output(text: &str) -> Option<(u64, u64, u64)> {
257 text.split_whitespace()
258 .find_map(|token| parse_version(token.strip_prefix('v').unwrap_or(token)))
259}
260
261/// Parse `x.y.z` into an orderable triple. Anything else — including the pre-release
262/// and build suffixes this project never publishes — answers `None`.
263pub(crate) fn parse_version(text: &str) -> Option<(u64, u64, u64)> {
264 let mut parts = text.split('.');
265 let triple = (
266 parts.next()?.parse().ok()?,
267 parts.next()?.parse().ok()?,
268 parts.next()?.parse().ok()?,
269 );
270 parts.next().is_none().then_some(triple)
271}
272
273/// Keep `dev-prune` and `devp` beside each other, whichever of the two is running.
274///
275/// The pair is one binary under two names, and either one can be the survivor. An upgrade
276/// that could not replace a running `devp` leaves a stale alias; an antivirus quarantine,
277/// a half-finished uninstall or a `Remove-Item` aimed at the wrong name leaves only
278/// `devp`. So this restores *the other* name in whichever direction is missing, rather
279/// than only ever creating `devp` — running either one puts the pair back.
280pub fn ensure_alias() -> Outcome {
281 // WinGet, Scoop and Homebrew each install into a directory they version and replace
282 // whole on upgrade, and each ships both names in the package itself — so there is
283 // nothing to create here, and creating it would be actively wrong twice over. The
284 // twin would be orphaned by the next upgrade, still on PATH, still running the old
285 // release; and writing a second executable beside a freshly downloaded unsigned
286 // binary on its first run is a behavioural malware signature. WinGet's own
287 // post-install validation flags exactly that, which is how this was found.
288 if crate::channel::Channel::detect().replaces_its_directory() {
289 return Outcome::AlreadyPresent;
290 }
291 let Ok(current_exe) = std::env::current_exe() else {
292 return Outcome::Failed("could not locate the running executable".to_string());
293 };
294 let Some(parent_dir) = current_exe.parent() else {
295 return Outcome::Failed("the running executable has no parent directory".to_string());
296 };
297
298 ensure_twin_of(¤t_exe, parent_dir)
299}
300
301/// The half of [`ensure_alias`] that takes its paths as arguments, so tests can drive both
302/// directions without being the binary they are testing.
303fn ensure_twin_of(current_exe: &std::path::Path, parent_dir: &std::path::Path) -> Outcome {
304 let running_as_alias = current_exe
305 .file_stem()
306 .and_then(|s| s.to_str())
307 .is_some_and(|stem| stem == "devp");
308
309 // `dev-prune` is the canonical name, and only it may overwrite its twin.
310 //
311 // Installers write `dev-prune` first and upgrades replace it first, so it is never the
312 // older of the two — a stale `devp` is worth replacing, because otherwise it silently
313 // runs the previous version. The reverse is not safe: an upgrade that replaced
314 // `dev-prune` and then failed on a running `devp` leaves exactly the state where the
315 // alias is the *older* binary, and refreshing from there would quietly reinstall the
316 // version the user just upgraded away from. So `devp` may only create a `dev-prune`
317 // that is missing outright.
318 let (twin_name, may_refresh) = if running_as_alias {
319 (
320 if cfg!(windows) {
321 "dev-prune.exe"
322 } else {
323 "dev-prune"
324 },
325 false,
326 )
327 } else {
328 (if cfg!(windows) { "devp.exe" } else { "devp" }, true)
329 };
330 let twin_exe = parent_dir.join(twin_name);
331
332 if twin_exe.exists() {
333 if !may_refresh || same_contents(&twin_exe, current_exe) {
334 return Outcome::AlreadyPresent;
335 }
336 // Replacing a running executable fails on Windows; that is fine, the alias is
337 // simply refreshed by the next invocation that is not itself `devp`.
338 if fs::remove_file(&twin_exe).is_err() {
339 return Outcome::Skipped(format!(
340 "`{twin_name}` is in use and could not be refreshed — re-run `devp setup` \
341 from a terminal that is not running it"
342 ));
343 }
344 }
345
346 if fs::hard_link(current_exe, &twin_exe).is_ok() {
347 return Outcome::Installed;
348 }
349
350 // The copy is the fallback for filesystems without hard links — but it must never
351 // run when the alias already exists, because the reason `hard_link` usually fails is
352 // that another process created it a moment ago, as a hard link to this very
353 // executable. `fs::copy` opens its destination with O_TRUNC, and truncating a hard
354 // link truncates the shared inode: the copy would empty the running binary and then
355 // copy zero bytes from it.
356 //
357 // That is not hypothetical. It is what turned every macOS CI run red. The 28
358 // integration tests launch at once, one wins the link, the losers fall through to
359 // here, and `target/debug/dev-prune` becomes a zero-byte file. macOS `posix_spawn`
360 // answers ENOEXEC by handing the file to `/bin/sh`, so every later invocation
361 // "succeeded" with exit 0 and printed nothing — for two hours the tests looked like
362 // 27 unrelated assertion failures.
363 if twin_exe.exists() {
364 return Outcome::AlreadyPresent;
365 }
366
367 // Stage beside and rename into place: copied straight onto the final name, the
368 // alias would exist-but-be-incomplete for the length of the copy, and a `devp`
369 // typed in that window executes a torn binary.
370 let staging = twin_exe.with_extension("new");
371 if fs::copy(current_exe, &staging).is_ok() && fs::rename(&staging, &twin_exe).is_ok() {
372 return Outcome::Installed;
373 }
374 let _ = fs::remove_file(&staging);
375 if twin_exe.exists() {
376 // A concurrent invocation won the rename; its alias serves exactly as well.
377 return Outcome::AlreadyPresent;
378 }
379 Outcome::Failed(format!(
380 "could not create `{}`",
381 output::clean_path(&twin_exe)
382 ))
383}
384
385/// Sameness test for two executables, cheap in the common case.
386///
387/// A hard link makes size and mtime equal by construction, so the usual layout answers
388/// without reading either file. When only the mtime differs — the alias came from the
389/// copy fallback, which does not preserve timestamps — the bytes themselves decide,
390/// because calling that pair "different" made every single invocation delete and
391/// recreate an alias whose content never changed.
392fn same_contents(a: &std::path::Path, b: &std::path::Path) -> bool {
393 let (Ok(ma), Ok(mb)) = (fs::metadata(a), fs::metadata(b)) else {
394 return false;
395 };
396 if ma.len() != mb.len() {
397 return false;
398 }
399 if ma.modified().ok() == mb.modified().ok() {
400 return true;
401 }
402 match (fs::read(a), fs::read(b)) {
403 (Ok(ca), Ok(cb)) => ca == cb,
404 _ => false,
405 }
406}
407
408/// Path that `devp skill` and this module export `SKILL.md` to.
409pub fn skill_path() -> Result<PathBuf> {
410 Ok(Registry::config_dir()?.join("SKILL.md"))
411}
412
413/// Export the bundled `SKILL.md` so AI assistants have something to read.
414///
415/// Rewritten whenever it differs from the embedded copy, since an upgrade that changes
416/// the skill must not leave the previous version's instructions on disk.
417pub fn ensure_skill_file() -> Outcome {
418 match Registry::config_dir() {
419 Ok(dir) => ensure_skill_file_in(&dir),
420 Err(_) => Outcome::Failed("could not determine the config directory".to_string()),
421 }
422}
423
424fn ensure_skill_file_in(config_dir: &std::path::Path) -> Outcome {
425 let target = config_dir.join("SKILL.md");
426
427 if fs::read_to_string(&target).is_ok_and(|current| current == EMBEDDED_SKILL_MD) {
428 return Outcome::AlreadyPresent;
429 }
430
431 let _ = fs::create_dir_all(config_dir);
432 match fs::write(&target, EMBEDDED_SKILL_MD) {
433 Ok(()) => Outcome::Installed,
434 Err(e) => Outcome::Failed(format!(
435 "could not write {}: {e}",
436 output::clean_path(&target)
437 )),
438 }
439}
440
441/// The per-skill directories of AI coding agents that are installed under `home`.
442///
443/// Detection only — an agent's home directory is created by the agent, never by this
444/// pass. Today that is Claude Code, whose Agent Skills live at
445/// `~/.claude/skills/<name>/SKILL.md`. Assistants without an on-disk skill format get
446/// the onboarding prompt from `devp skill` instead.
447fn agent_skill_roots_under(home: &std::path::Path) -> Vec<PathBuf> {
448 let mut roots = Vec::new();
449 let claude = home.join(constants::CLAUDE_HOME_DIR);
450 if claude.is_dir() {
451 roots.push(
452 claude
453 .join(constants::AGENT_SKILLS_SUBDIR)
454 .join(constants::APP_NAME),
455 );
456 }
457 roots
458}
459
460/// The agent skill directories on this machine. Empty when no agent is installed.
461pub fn agent_skill_roots() -> Vec<PathBuf> {
462 dirs::home_dir()
463 .map(|home| agent_skill_roots_under(&home))
464 .unwrap_or_default()
465}
466
467/// Install the skill into every detected agent's skills directory.
468pub fn ensure_agent_skills() -> Outcome {
469 ensure_agent_skills_at(&agent_skill_roots())
470}
471
472fn ensure_agent_skills_at(roots: &[PathBuf]) -> Outcome {
473 if roots.is_empty() {
474 return Outcome::Skipped(
475 "no AI agent skills directory was found — `devp skill` prints import prompts instead"
476 .to_string(),
477 );
478 }
479 let mut installed = false;
480 for root in roots {
481 match ensure_skill_file_in(root) {
482 Outcome::Installed => installed = true,
483 Outcome::AlreadyPresent => {}
484 other => return other,
485 }
486 }
487 if installed {
488 Outcome::Installed
489 } else {
490 Outcome::AlreadyPresent
491 }
492}
493
494/// Make the managed pair reachable from a fresh shell.
495///
496/// This is the step that lets `pip install dev-prune` in a virtualenv survive the
497/// virtualenv: the binaries pip placed vanish with the environment, but the managed
498/// copy under `<config>/bin` does not, and after this step it is the one a new
499/// terminal finds. See [`crate::pathenv`] for what "reachable" means per platform.
500pub fn ensure_command_on_path() -> Outcome {
501 let managed = stable_exe_path();
502 let is_managed_copy =
503 managed_exe_path().is_ok_and(|expected| expected == managed) && managed.is_file();
504 if !is_managed_copy {
505 // No managed copy exists and none could be created — under `cargo test` the
506 // running executable is the harness, and cloning that would be wrong. There is
507 // nothing durable to put on PATH.
508 return Outcome::Skipped("no managed copy of the binary exists to put on PATH".to_string());
509 }
510 let Some(bin_dir) = managed.parent() else {
511 return Outcome::Failed("the managed binary has no parent directory".to_string());
512 };
513 // `devp` has to sit beside it, or the PATH entry only ever finds `dev-prune`.
514 if let Outcome::Failed(why) = ensure_twin_of(&managed, bin_dir) {
515 return Outcome::Failed(why);
516 }
517 crate::pathenv::ensure_reachable(bin_dir)
518}
519
520/// Write the icon assets and register `*.devprune.json` with the OS file manager.
521///
522/// Part of the automatic pass rather than a separate errand, because "the config file has
523/// an icon" is not a thing anybody thinks to go and ask for. Everything it writes lives
524/// under the config directory and the user's own XDG data directory, `devp uninstall`
525/// removes all of it, and it touches no editor settings, no PATH and no shell profile —
526/// so there is nothing here that needs to be asked about first.
527///
528/// Unlike the hooks and the scheduler, this has no opt-out switch of its own. Files
529/// dropped into the user's data directory are not a background process and not a change
530/// in behaviour; `auto_setup` already covers "install nothing at all".
531fn ensure_icons() -> Outcome {
532 if crate::commands::icon::is_registered() {
533 return Outcome::AlreadyPresent;
534 }
535 match crate::commands::icon::sync_app_directory() {
536 Ok(()) => Outcome::Installed,
537 Err(e) => Outcome::Failed(format!("{e:#}")),
538 }
539}
540
541/// Install the global Git hooks, unless git is absent or the slot belongs to someone else.
542///
543/// `chain` is `auto_hooks_chain`: with it on, a slot that belongs to husky is not a
544/// reason to skip, because dev-prune can install in front and forward every hook back.
545pub fn ensure_hooks(chain: bool) -> Outcome {
546 if !hook::git_available() {
547 return Outcome::Skipped(format!(
548 "\n {}",
549 hook::GIT_MISSING_HELP.replace('\n', "\n ")
550 ));
551 }
552
553 match hook::state() {
554 // "Installed" is not the question — "installed and pointing at a binary that
555 // still exists" is. A hook backgrounds itself and discards its own output, so
556 // one left pointing at a deleted npm cache dies silently on every commit and
557 // nothing ever registers again; this pass is the only thing that ever looks.
558 // Two reasons to rewrite a working install: it names a binary that is gone, or
559 // it predates the passthrough shims and is silently shadowing every repository's
560 // own `.git/hooks`. Neither reports itself — a hook discards its own output by
561 // design — so the upgrade pass is the only thing that will ever notice.
562 Ok(HookState::Active) if hook_target_is_dead() || hook::shims_incomplete() => {
563 match hook::install() {
564 Ok(()) => Outcome::Installed,
565 Err(e) => Outcome::Failed(format!("{e:#}")),
566 }
567 }
568 Ok(HookState::Active) => Outcome::AlreadyPresent,
569 // Drift is repaired here rather than reported: the setup pass already runs on
570 // install, on update and on a schedule, and a chain the user opted into is a
571 // chain they want kept current.
572 Ok(HookState::Chained { drifted, .. }) if !drifted.is_empty() => {
573 match hook::install_with(true) {
574 Ok(()) => Outcome::Installed,
575 Err(e) => Outcome::Failed(format!("{e:#}")),
576 }
577 }
578 Ok(HookState::Chained { .. }) if hook_target_is_dead() => match hook::install_with(true) {
579 Ok(()) => Outcome::Installed,
580 Err(e) => Outcome::Failed(format!("{e:#}")),
581 },
582 Ok(HookState::Chained { .. }) => Outcome::AlreadyPresent,
583 Ok(HookState::Foreign(_)) if chain => match hook::install_with(true) {
584 Ok(()) => Outcome::Installed,
585 Err(e) => Outcome::Failed(format!("{e:#}")),
586 },
587 Ok(HookState::Foreign(existing)) => Outcome::Skipped(format!(
588 "`core.hooksPath` is already set to `{existing}`, which belongs to another tool.\n \
589 Git allows only one hooks directory, so dev-prune will not take the slot.\n \
590 `devp hook install --chain` installs in front of it instead — dev-prune registers \
591 the repo, then hands every hook on to `{existing}`, and `devp hook uninstall` puts \
592 the original setting back (`devp config set auto_hooks_chain true` makes that \
593 the standing answer). Or skip it: `devp link .` does the same job by hand."
594 )),
595 Ok(HookState::Absent) => match hook::install() {
596 Ok(()) => Outcome::Installed,
597 Err(e) => Outcome::Failed(format!("{e:#}")),
598 },
599 Err(e) => Outcome::Failed(format!("{e:#}")),
600 }
601}
602
603/// Whether the installed hooks name a binary that no longer exists.
604fn hook_target_is_dead() -> bool {
605 hook::registered_exe_path().is_some_and(|exe| !exe.exists())
606}
607
608/// Install the OS scheduler if it is not already registered.
609pub fn ensure_daemon(interval_days: u64) -> Outcome {
610 match daemon::daemon_status() {
611 // A task whose binary has been deleted keeps reporting itself `Ready` and dies
612 // the instant it fires, every interval, with nowhere to complain. Re-register
613 // it against the stable path instead of counting the corpse as present.
614 Ok(daemon::DaemonStatus::Installed)
615 if daemon::registered_exe_path().is_some_and(|exe| !exe.exists()) =>
616 {
617 match daemon::install_daemon(interval_days) {
618 Ok(()) => Outcome::Installed,
619 Err(e) => Outcome::Failed(format!("{e:#}")),
620 }
621 }
622 // A task registered by a version that only knew the interactive logon flashes a
623 // console window at whoever is logged in every time it fires — the single most
624 // trust-destroying thing a background tool can do. Re-register it hidden; a
625 // machine whose scheduler refuses the hidden logon remembers the refusal and is
626 // not asked again.
627 Ok(daemon::DaemonStatus::Installed) if daemon::wants_hidden_upgrade() => {
628 match daemon::install_daemon(interval_days) {
629 Ok(()) => Outcome::Installed,
630 Err(e) => Outcome::Failed(format!("{e:#}")),
631 }
632 }
633 // A settled, hidden task still needs its windowless twin kept current: the twin
634 // is a copy of the binary, so an upgrade that replaced the binary would otherwise
635 // leave the daemon firing the previous release. No-op on the other platforms, and
636 // when no twin is in use.
637 Ok(daemon::DaemonStatus::Installed) => {
638 daemon::refresh_hidden_twin();
639 Outcome::AlreadyPresent
640 }
641 Ok(daemon::DaemonStatus::NotInstalled) => match daemon::install_daemon(interval_days) {
642 Ok(()) => Outcome::Installed,
643 Err(e) => Outcome::Failed(format!("{e:#}")),
644 },
645 // `Unknown` means the query itself could not be answered — the scheduler may
646 // well be there. Installing over it would fail on every command from now on, so
647 // this reports and steps over instead of guessing. The platform backends are
648 // written to keep this case narrow: anything they can answer definitely, they do.
649 Ok(daemon::DaemonStatus::Unknown(why)) => {
650 Outcome::Skipped(format!("scheduler state could not be read — {why}"))
651 }
652 Err(e) => Outcome::Failed(format!("{e:#}")),
653 }
654}
655
656/// Whether unattended installation is permitted at all.
657///
658/// Both switches exist because these integrations write outside dev-prune's own config
659/// directory — a scheduled task, a global git setting — and there are places that must
660/// never happen unasked: container images, CI, and this project's own test suite.
661pub fn auto_setup_enabled(registry: &Registry) -> bool {
662 !no_auto_setup_requested() && registry.settings.auto_setup && unattended_environment().is_none()
663}
664
665/// The reason this looks like a machine nobody is sitting at, if it does.
666///
667/// `DEV_PRUNE_NO_AUTO_SETUP` and `auto_setup` are both switches you have to set *before*
668/// the first run — which is exactly the run that installs things, so in a container or a
669/// CI job the damage is done by the time there is anywhere to set them. Detecting the
670/// environment is the only opt-out that works on the first run, which is the only run
671/// that matters here.
672///
673/// Deliberately conservative: every signal below is one that CI providers and container
674/// runtimes set themselves, so a developer's own shell will not trip it. Someone who
675/// genuinely wants the integrations in CI can still ask in so many words with
676/// `devp setup`, which never consults this.
677pub fn unattended_environment() -> Option<&'static str> {
678 // Set by GitHub Actions, GitLab CI, CircleCI, Travis, Jenkins (via pipeline), Woodpecker
679 // and most others. `CI=true` is the closest thing this space has to a standard.
680 for var in [
681 "CI",
682 "CONTINUOUS_INTEGRATION",
683 "BUILD_NUMBER",
684 "GITHUB_ACTIONS",
685 ] {
686 if let Some(value) = std::env::var_os(var) {
687 // `CI=false` is set explicitly by some tools to mean "not CI", and honouring
688 // the word rather than the presence is what the user plainly meant.
689 let value = value.to_string_lossy();
690 if !value.is_empty() && !value.eq_ignore_ascii_case("false") {
691 return Some("this looks like a CI runner");
692 }
693 }
694 }
695
696 // Docker writes this marker into every container it builds from a Dockerfile;
697 // Podman and other OCI runtimes write the `container` variable instead.
698 #[cfg(unix)]
699 if std::path::Path::new("/.dockerenv").exists() {
700 return Some("this looks like a container");
701 }
702 if std::env::var_os("container").is_some() {
703 return Some("this looks like a container");
704 }
705
706 None
707}
708
709/// Whether this integration pass was asked for by name.
710///
711/// The only thing it decides is the `devp` twin. Writing a second executable beside the
712/// first is a self-installation, and doing it *unasked*, on the first run of a freshly
713/// downloaded unsigned binary, alongside registering a scheduled task, is a behavioural
714/// malware signature — it is what earned this package a `Validation-Defender-Error` on
715/// microsoft/winget-pkgs#422665. Asked for in so many words, the same write is an
716/// ordinary install step. Nothing else in the pass changes.
717#[derive(Clone, Copy, PartialEq, Eq)]
718pub enum Consent {
719 /// `devp setup`, or `devp doctor --fix`.
720 Explicit,
721 /// The pass that runs on its own when `auto_setup` is on.
722 Unattended,
723}
724
725/// Run an integration pass unless unattended installation is switched off.
726///
727/// Every caller that the user did not name explicitly goes through this. `devp setup`
728/// calls [`ensure_integrations`] with [`Consent::Explicit`]: asking for it in so many
729/// words is consent.
730pub fn ensure_integrations_if_enabled(registry: &Registry) -> Option<SetupReport> {
731 auto_setup_enabled(registry).then(|| ensure_integrations(registry, Consent::Unattended))
732}
733
734/// Run one integration pass, installing whatever is missing.
735///
736/// The two per-integration settings (`auto_daemon`, `auto_hooks`) are honoured here, so
737/// turning one off turns it off for every future pass as well as this one.
738pub fn ensure_integrations(registry: &Registry, consent: Consent) -> SetupReport {
739 let mut report = SetupReport::default();
740
741 // Only when asked. This is the twin *beside the running binary*, which on an
742 // unattended pass means beside whatever the delivery vehicle happened to be: npm's
743 // cache, a venv's `Scripts`, a Downloads folder. Every channel already ships both
744 // names as real files — the archives, the npm and PyPI packages, and two `[[bin]]`
745 // targets for `cargo install` — so there is normally nothing to create, and the one
746 // case left over is a manual install that skipped `dev-prune setup`, which `devp
747 // doctor` reports with a one-command fix.
748 //
749 // The pair that actually matters is not this one. `ensure_command_on_path` below
750 // keeps `dev-prune` and `devp` together in the managed `bin` directory, which is
751 // the directory on the user's PATH and the one `devp uninstall` knows about, and it
752 // runs on every pass.
753 if consent == Consent::Explicit {
754 report.push("dev-prune/devp pair", ensure_alias());
755 }
756 report.push("Command on PATH", ensure_command_on_path());
757 report.push("SKILL.md", ensure_skill_file());
758 // Only reported when an agent is actually installed: a machine without one would
759 // otherwise see a "skipped" warning about software it never had, on every install.
760 if !agent_skill_roots().is_empty() {
761 report.push("AI agent skills", ensure_agent_skills());
762 }
763 report.push("File icons", ensure_icons());
764
765 if registry.settings.auto_hooks {
766 report.push(
767 "Git hooks",
768 ensure_hooks(registry.settings.auto_hooks_chain),
769 );
770 } else {
771 report.push(
772 "Git hooks",
773 Outcome::Skipped("`auto_hooks` is false — enable with `devp hook install`".to_string()),
774 );
775 }
776
777 if registry.settings.auto_daemon {
778 report.push(
779 "Background scheduler",
780 ensure_daemon(registry.settings.check_interval_days),
781 );
782 } else {
783 report.push(
784 "Background scheduler",
785 Outcome::Skipped(
786 "`auto_daemon` is false — enable with `devp daemon install`".to_string(),
787 ),
788 );
789 }
790
791 report
792}
793
794// ── VS Code extension ────────────────────────────────────────────────────────
795
796/// Marker recording that the extension question was asked (or found already answered by
797/// an existing install). One file, no content: the offer is made once ever, whatever
798/// the answer was — a declined install must not be re-litigated on every upgrade.
799const VSCODE_OFFER_STAMP: &str = "vscode-ext-offered";
800
801/// A VS Code-compatible editor found on PATH.
802struct EditorCli {
803 /// The command to invoke — on Windows the `.cmd` launcher, because the entry on
804 /// PATH is a batch file, not an `.exe`, and `Command::new("code")` would miss it.
805 cli: String,
806 /// The editor's name as a person knows it, for the prompt and per-editor results.
807 label: &'static str,
808}
809
810/// Every VS Code-compatible editor on PATH, in the order listed here.
811///
812/// All of these forks keep the upstream CLI protocol (`--version`, `--list-extensions`,
813/// `--install-extension`), so one code path drives them all. What differs is the
814/// registry each one resolves an extension ID against: VS Code uses the Microsoft
815/// Marketplace, VSCodium/Windsurf/Positron/Kiro use OpenVSX, Cursor runs its own
816/// mirror. An ID install can therefore fail on a fork whose registry does not carry
817/// the extension yet — which is why the installer falls back to the `.vsix` from the
818/// GitHub release, the artifact every registry copy is built from.
819fn detect_vscode_editors() -> Vec<EditorCli> {
820 const CANDIDATES: &[(&str, &str)] = &[
821 ("code", "VS Code"),
822 ("code-insiders", "VS Code Insiders"),
823 ("codium", "VSCodium"),
824 ("codium-insiders", "VSCodium Insiders"),
825 ("cursor", "Cursor"),
826 ("windsurf", "Windsurf"),
827 ("positron", "Positron"),
828 ("kiro", "Kiro"),
829 ];
830 CANDIDATES
831 .iter()
832 .filter_map(|(name, label)| {
833 let cli = if cfg!(windows) {
834 format!("{name}.cmd")
835 } else {
836 (*name).to_string()
837 };
838 let responds = crate::spawn::command(&cli)
839 .arg("--version")
840 .stdin(std::process::Stdio::null())
841 .stdout(std::process::Stdio::null())
842 .stderr(std::process::Stdio::null())
843 .status()
844 .map(|s| s.success())
845 .unwrap_or(false);
846 responds.then_some(EditorCli { cli, label })
847 })
848 .collect()
849}
850
851fn vscode_extension_installed(cli: &str) -> bool {
852 crate::spawn::command(cli)
853 .arg("--list-extensions")
854 .stdin(std::process::Stdio::null())
855 .output()
856 .map(|out| {
857 String::from_utf8_lossy(&out.stdout).lines().any(|line| {
858 line.trim()
859 .eq_ignore_ascii_case(constants::VSCODE_EXTENSION_ID)
860 })
861 })
862 .unwrap_or(false)
863}
864
865/// Download the `.vsix` attached to the latest GitHub release into the config directory.
866///
867/// The release asset is the source of truth for the extension — the Marketplace and
868/// OpenVSX listings are built from it — so when an editor's registry cannot resolve the
869/// ID (a fork whose registry does not carry the extension), installing the release file
870/// directly gets the same bits through a channel every fork supports. Editors update a
871/// `.vsix`-installed extension from their registry once a newer listed version appears,
872/// so this install self-heals into the normal update flow.
873fn download_release_vsix() -> Option<std::path::PathBuf> {
874 use std::time::Duration;
875
876 if offline_requested() {
877 return None;
878 }
879
880 let fetch = |url: &str| {
881 ureq::get(url)
882 .header("User-Agent", &format!("dev-prune/{}", constants::VERSION))
883 .header("Accept", "application/vnd.github+json")
884 .config()
885 .timeout_global(Some(Duration::from_secs(30)))
886 .build()
887 .call()
888 };
889
890 let body = fetch(constants::LATEST_RELEASE_API_URL)
891 .ok()?
892 .body_mut()
893 .read_to_string()
894 .ok()?;
895 let json: serde_json::Value = serde_json::from_str(&body).ok()?;
896 let asset = json.get("assets")?.as_array()?.iter().find_map(|asset| {
897 let name = asset.get("name")?.as_str()?;
898 if !name.ends_with(".vsix") {
899 return None;
900 }
901 let url = asset.get("browser_download_url")?.as_str()?;
902 Some((name.to_string(), url.to_string()))
903 })?;
904
905 let bytes = fetch(&asset.1).ok()?.body_mut().read_to_vec().ok()?;
906 // The config directory, not the shared system temp dir: on a multi-user machine
907 // `%TEMP%`-style paths are predictable and writable by others, and the editor is
908 // about to execute what this file contains. The caller deletes it after installing.
909 let dir = Registry::config_dir().ok()?;
910 fs::create_dir_all(&dir).ok()?;
911 let path = dir.join(&asset.0);
912 fs::write(&path, bytes).ok()?;
913 Some(path)
914}
915
916/// `<cli> --install-extension <arg>`, surfacing the editor's own output.
917fn run_install(cli: &str, arg: &str) -> bool {
918 crate::spawn::command(cli)
919 .args(["--install-extension", arg])
920 .stdin(std::process::Stdio::null())
921 .status()
922 .map(|s| s.success())
923 .unwrap_or(false)
924}
925
926/// Offer to install the editor extension, once ever, when a VS Code-family editor is
927/// present.
928///
929/// This asks rather than installs because the editor is not dev-prune's territory the
930/// way its own config directory is. Every gate below is a way of making sure a person
931/// is actually there to answer: no marker yet, not a CI runner or container, both ends
932/// of the terminal attached. When no editor is found nothing is written, so installing
933/// one later and re-running `devp setup` still gets the one offer.
934pub fn offer_vscode_extension() {
935 use std::io::{IsTerminal, Write};
936
937 let Ok(config_dir) = Registry::config_dir() else {
938 return;
939 };
940 if config_dir.join(VSCODE_OFFER_STAMP).exists() {
941 return;
942 }
943 if no_auto_setup_requested()
944 || unattended_environment().is_some()
945 || !std::io::stdin().is_terminal()
946 || !std::io::stdout().is_terminal()
947 {
948 return;
949 }
950 let editors = detect_vscode_editors();
951 if editors.is_empty() {
952 return;
953 }
954
955 let write_marker = || {
956 let _ = fs::create_dir_all(&config_dir);
957 let _ = fs::write(config_dir.join(VSCODE_OFFER_STAMP), "");
958 };
959
960 let missing: Vec<&EditorCli> = editors
961 .iter()
962 .filter(|e| !vscode_extension_installed(&e.cli))
963 .collect();
964 if missing.is_empty() {
965 write_marker();
966 return;
967 }
968
969 let names = missing
970 .iter()
971 .map(|e| e.label)
972 .collect::<Vec<_>>()
973 .join(", ");
974 println!();
975 println!("{names} detected — install the dev-prune extension?");
976 println!(" It validates .devprune.json and shows reclaimable space in the status bar.");
977 // The listings and the source, before the question rather than after it. This is
978 // the one prompt that defaults to yes, so the material someone would need in order
979 // to say no has to be on screen at the moment they answer — not in a doc they would
980 // have to go and look for.
981 println!(" Marketplace: {}", constants::VSCODE_MARKETPLACE_URL);
982 println!(" Open VSX: {}", constants::OPENVSX_URL);
983 println!(" Source: {}", constants::REPO_URL);
984 print!(" Install it? [Y/n] ");
985 let _ = std::io::stdout().flush();
986 let mut answer = String::new();
987 if std::io::stdin().read_line(&mut answer).is_err() {
988 return;
989 }
990 write_marker();
991
992 // A bare Enter accepts. Unlike the uninstall sweep — which deletes — the worst case
993 // here is an extension the person removes in two clicks, and the gates above have
994 // already established that a human with a VS Code-family editor is watching.
995 if !matches!(answer.trim().to_lowercase().as_str(), "" | "y" | "yes") {
996 output::print_info(&format!(
997 "Skipped. Install it any time with `{} --install-extension {}`, or from {}.",
998 missing[0].cli,
999 constants::VSCODE_EXTENSION_ID,
1000 constants::VSCODE_MARKETPLACE_URL
1001 ));
1002 return;
1003 }
1004
1005 // Fetched at most once, shared by every editor whose registry install fails.
1006 let mut release_vsix: Option<Option<std::path::PathBuf>> = None;
1007 for editor in &missing {
1008 // The editor's own registry first: that install is the one the editor keeps
1009 // up to date by itself.
1010 if run_install(&editor.cli, constants::VSCODE_EXTENSION_ID) {
1011 output::print_success(&format!("{}: extension installed.", editor.label));
1012 continue;
1013 }
1014 // A fork whose registry does not carry the extension — install the `.vsix`
1015 // from the GitHub release instead.
1016 let vsix = release_vsix.get_or_insert_with(download_release_vsix);
1017 match vsix {
1018 Some(path) if run_install(&editor.cli, &path.to_string_lossy()) => {
1019 output::print_success(&format!(
1020 "{}: extension installed from the GitHub release .vsix.",
1021 editor.label
1022 ));
1023 }
1024 _ => {
1025 output::print_warning(&format!(
1026 "{}: could not install it from here. Search the Extensions view for \"dev-prune\", or run `{} --install-extension {}` yourself.",
1027 editor.label,
1028 editor.cli,
1029 constants::VSCODE_EXTENSION_ID
1030 ));
1031 }
1032 }
1033 }
1034 if let Some(Some(path)) = &release_vsix {
1035 let _ = fs::remove_file(path);
1036 }
1037}
1038
1039/// Record that a pass completed for this version.
1040fn write_stamp_in(config_dir: &std::path::Path) {
1041 let _ = fs::create_dir_all(config_dir);
1042 let _ = fs::write(config_dir.join(STAMP_FILE), constants::VERSION);
1043}
1044
1045fn write_stamp() {
1046 if let Ok(dir) = Registry::config_dir() {
1047 write_stamp_in(&dir);
1048 }
1049}
1050
1051fn setup_is_due_in(config_dir: &std::path::Path) -> bool {
1052 !fs::read_to_string(config_dir.join(STAMP_FILE))
1053 .is_ok_and(|stamp| stamp.trim() == constants::VERSION)
1054}
1055
1056/// Whether the unattended pass is due: a fresh install, or the first run after an upgrade.
1057pub fn setup_is_due() -> bool {
1058 Registry::config_dir()
1059 .map(|dir| setup_is_due_in(&dir))
1060 .unwrap_or(false)
1061}
1062
1063/// Whether there is a human at this invocation who could see what was done and undo it.
1064///
1065/// The one question that gates everything dev-prune installs without being asked. CI
1066/// variables and containers answer it directly; a redirected stdin or stdout answers it
1067/// too, because output nobody reads is the same as no output — and an integration
1068/// installed silently is one nobody knows to remove.
1069fn a_person_is_present() -> bool {
1070 use std::io::IsTerminal;
1071 unattended_environment().is_none()
1072 && std::io::stdin().is_terminal()
1073 && std::io::stdout().is_terminal()
1074}
1075
1076/// The unattended pass, run at most once per installed version.
1077///
1078/// Called at the top of every command that a human typed. It is deliberately not called
1079/// for the Git hook's `link --quiet` or the scheduler's `run --daemon`: those run without
1080/// a terminal, and an integration pass that nobody can see is one nobody can refuse.
1081pub fn auto_setup_if_due() {
1082 if !setup_is_due() {
1083 first_run_config_review();
1084 return;
1085 }
1086 // The same question `first_run_config_review` asks, asked one step earlier. It used
1087 // to be asked only about the *prompt*, never about the pass that installs a PATH
1088 // entry, a scheduled task and a git hook — so a binary run once by an automated
1089 // system, with its output captured, silently acquired persistence on that machine.
1090 // Nothing here is skipped permanently: the stamp is not written, so the first run a
1091 // person can actually see does the pass and reports it.
1092 if !a_person_is_present() {
1093 return;
1094 }
1095
1096 review_project_venv_install();
1097
1098 let Ok(registry) = Registry::load() else {
1099 return;
1100 };
1101 let Some(report) = ensure_integrations_if_enabled(®istry) else {
1102 // Suppressed. Stamp anyway, so a machine that opted out does not re-decide
1103 // this on every single command.
1104 write_stamp();
1105 crate::commands::config::skip_config_review();
1106 return;
1107 };
1108 if report.changed_anything() || report.needs_attention() {
1109 output::print_header("dev-prune setup");
1110 report.print(false);
1111 if report.changed_anything() {
1112 output::print_info(
1113 "Run `devp setup --status` to review these, or `devp uninstall` to remove them.",
1114 );
1115 }
1116 println!();
1117 }
1118 write_stamp();
1119 first_run_config_review();
1120}
1121
1122/// Put the defaults in front of the user on a fresh install, and any setting an upgrade
1123/// added that they have never been shown.
1124///
1125/// Separate from the integration stamp on purpose. The integrations are re-checked after
1126/// every upgrade; the settings are not, except for the ones that did not exist last time
1127/// — being asked to reconfirm `idle_days` on each new version would be a nuisance, and a
1128/// nuisance is something people learn to dismiss without reading.
1129///
1130/// Every condition here is a way of asking "is there a person reading this?", because the
1131/// alternative to asking is a prompt written into a log nobody will read, on a run that
1132/// then blocks forever waiting for an answer.
1133fn first_run_config_review() {
1134 if !crate::commands::config::config_review_is_due() {
1135 return;
1136 }
1137
1138 if !a_person_is_present() {
1139 crate::commands::config::skip_config_review();
1140 return;
1141 }
1142
1143 // Any error here is the wizard's own reporting; the command the user actually typed
1144 // still runs. A failed walkthrough must not become a failed `devp status`.
1145 if let Err(e) = crate::commands::config::run_wizard(false) {
1146 output::print_warning(&format!("Could not run the first-run setup ({e:#})."));
1147 }
1148 // Marked regardless of how it ended, including a deliberate quit. This is the one
1149 // caller that runs uninvited, and an unasked-for walkthrough that reappears on every
1150 // subsequent command is worse than one somebody dismissed once on purpose.
1151 crate::commands::config::skip_config_review();
1152 // Same first run, same person already answering questions — the one moment the
1153 // extension offer is a courtesy rather than an interruption.
1154 offer_vscode_extension();
1155 println!();
1156}
1157
1158/// Invalidate the stamp so the next human-run command performs a pass.
1159///
1160/// `uninstall` calls this in reverse — it writes the current stamp — so that removing the
1161/// integrations is not immediately undone by the next command.
1162pub fn suppress_next_auto_setup() {
1163 write_stamp();
1164}
1165
1166/// Say something, once, when this copy is running from inside a project's virtualenv.
1167///
1168/// This is the remedy at the source. By the time a prune pass refuses the environment,
1169/// the user is several days and one confusing error away from the moment they typed
1170/// `pip install dev-prune` with a project activated; saying it here, on the first run
1171/// after that install, is the only chance to explain it while the cause is still in
1172/// living memory. The refusal in the venv adapter stays as the failsafe, for a copy
1173/// installed before this check existed or by somebody who dismissed it.
1174///
1175/// Silent when `requirements.txt` already lists the tool. That is somebody who meant it,
1176/// and being told about a decision you made on purpose is what teaches people to stop
1177/// reading output.
1178fn review_project_venv_install() {
1179 let Ok(exe) = std::env::current_exe() else {
1180 return;
1181 };
1182 let Some(found) = crate::channel::project_venv_install(&exe) else {
1183 return;
1184 };
1185
1186 let requirements = found.project.join("requirements.txt");
1187 let recorded = crate::adapters::venv::requirement_names(&requirements, &mut Vec::new())
1188 .is_some_and(|names| names.iter().any(|n| crate::adapters::venv::is_dev_prune(n)));
1189 if recorded {
1190 return;
1191 }
1192
1193 output::print_header(&format!(
1194 "{} is installed inside this project's virtual environment",
1195 constants::APP_NAME
1196 ));
1197 println!(" running from {}", exe.display());
1198 println!(" environment {}", found.venv.display());
1199 println!(" project {}", found.project.display());
1200 println!();
1201 output::print_info(
1202 "A tool install belongs outside a project: it outlives the environment, every \
1203 repository shares it, and it never has to appear in an application's \
1204 requirements file to stay out of the way.",
1205 );
1206
1207 if requirements.is_file() {
1208 println!();
1209 output::print_info(
1210 "Until that is fixed, a prune pass will decline this project's environment \
1211 — a package `requirements.txt` does not account for is a package nothing \
1212 can rebuild.",
1213 );
1214 println!();
1215 if record_in_requirements(&requirements) {
1216 return;
1217 }
1218 }
1219
1220 println!();
1221 println!(" Remove this copy and install it as a tool instead:");
1222 println!(" pip uninstall {}", constants::APP_NAME);
1223 println!(" uv tool install {}", constants::APP_NAME);
1224 println!(" # or: pipx install {}", constants::APP_NAME);
1225 report_other_copy(&exe);
1226 println!();
1227}
1228
1229/// Offer the other repair: declare the tool a dependency of this project, on purpose.
1230///
1231/// Default no, for the reason `devp restore` defaults no on a substituted interpreter —
1232/// this is the branch that writes into a file in somebody's repository, so a reflexive
1233/// Enter must not be what agrees to it. Returns whether the file was written, which is
1234/// also whether the removal instructions are still worth printing.
1235fn record_in_requirements(requirements: &std::path::Path) -> bool {
1236 use std::io::{IsTerminal, Write};
1237 if !std::io::stdin().is_terminal() {
1238 return false;
1239 }
1240 eprint!(
1241 "Record {} in requirements.txt instead, as a deliberate dev dependency? [y/N]: ",
1242 constants::APP_NAME
1243 );
1244 if std::io::stderr().flush().is_err() {
1245 return false;
1246 }
1247 let mut input = String::new();
1248 if std::io::stdin().read_line(&mut input).is_err() {
1249 return false;
1250 }
1251 if !matches!(input.trim().to_lowercase().as_str(), "y" | "yes") {
1252 return false;
1253 }
1254
1255 let Ok(existing) = fs::read_to_string(requirements) else {
1256 output::print_warning("Could not read requirements.txt, so nothing was changed.");
1257 return false;
1258 };
1259 // Requirements files without a trailing newline are common, and appending to one
1260 // blind would glue the pin onto the last requirement.
1261 let separator = if existing.is_empty() || existing.ends_with('\n') {
1262 ""
1263 } else {
1264 "\n"
1265 };
1266 let line = format!(
1267 "{separator}{}=={}\n",
1268 constants::APP_NAME,
1269 constants::VERSION
1270 );
1271 match std::fs::OpenOptions::new()
1272 .append(true)
1273 .open(requirements)
1274 .and_then(|mut f| f.write_all(line.as_bytes()))
1275 {
1276 Ok(()) => {
1277 output::print_success(&format!(
1278 "Added `{}=={}` to {}. The environment is prunable now.",
1279 constants::APP_NAME,
1280 constants::VERSION,
1281 requirements.display()
1282 ));
1283 true
1284 }
1285 Err(e) => {
1286 output::print_warning(&format!("Could not write requirements.txt ({e})."));
1287 false
1288 }
1289 }
1290}
1291
1292/// Name the copy that is already installed properly, if there is one.
1293///
1294/// "Uninstall this" reads very differently depending on whether it leaves the user with
1295/// no tool at all or with the one they already had — and on a machine where this mistake
1296/// happens there usually is one, because the working copy is what they were reaching for
1297/// in the first place.
1298fn report_other_copy(exe: &std::path::Path) {
1299 let names: [&str; 2] = if cfg!(windows) {
1300 ["dev-prune.exe", "devp.exe"]
1301 } else {
1302 ["dev-prune", "devp"]
1303 };
1304 let home = dirs::home_dir();
1305 let other = crate::channel::install_dirs(home.as_deref())
1306 .into_iter()
1307 .flat_map(|dir| names.iter().map(move |name| dir.join(name)))
1308 .find(|candidate| candidate.is_file() && candidate != exe);
1309
1310 if let Some(other) = other {
1311 println!();
1312 output::print_info(&format!(
1313 "You already have a copy outside this project, at `{}`, so removing this one \
1314 still leaves you a working `devp`.",
1315 other.display()
1316 ));
1317 }
1318}
1319
1320#[cfg(test)]
1321mod tests {
1322 use super::*;
1323
1324 #[test]
1325 fn a_report_with_only_present_items_is_silent() {
1326 let mut report = SetupReport::default();
1327 report.push("a", Outcome::AlreadyPresent);
1328 assert!(!report.changed_anything());
1329 assert!(!report.needs_attention());
1330 }
1331
1332 #[test]
1333 fn skipped_and_failed_both_ask_for_attention() {
1334 let mut skipped = SetupReport::default();
1335 skipped.push("a", Outcome::Skipped("no git".into()));
1336 assert!(skipped.needs_attention());
1337 assert!(!skipped.changed_anything());
1338
1339 let mut failed = SetupReport::default();
1340 failed.push("a", Outcome::Failed("boom".into()));
1341 assert!(failed.needs_attention());
1342 }
1343
1344 #[test]
1345 fn an_install_counts_as_a_change() {
1346 let mut report = SetupReport::default();
1347 report.push("a", Outcome::Installed);
1348 assert!(report.changed_anything());
1349 }
1350
1351 #[test]
1352 fn the_skill_export_lands_in_the_config_directory() {
1353 let dir = tempfile::TempDir::new().unwrap();
1354 assert_eq!(ensure_skill_file_in(dir.path()), Outcome::Installed);
1355 // A second pass finds byte-identical content and leaves it alone.
1356 assert_eq!(ensure_skill_file_in(dir.path()), Outcome::AlreadyPresent);
1357 let written = fs::read_to_string(dir.path().join("SKILL.md")).unwrap();
1358 assert_eq!(written, EMBEDDED_SKILL_MD);
1359 }
1360
1361 #[test]
1362 fn a_stale_skill_export_is_rewritten() {
1363 // An upgrade must not leave the previous version's instructions on disk.
1364 let dir = tempfile::TempDir::new().unwrap();
1365 fs::write(dir.path().join("SKILL.md"), "# an older version").unwrap();
1366 assert_eq!(ensure_skill_file_in(dir.path()), Outcome::Installed);
1367 let written = fs::read_to_string(dir.path().join("SKILL.md")).unwrap();
1368 assert_eq!(written, EMBEDDED_SKILL_MD);
1369 }
1370
1371 #[test]
1372 fn agent_skills_install_only_into_agent_homes_that_exist() {
1373 let home = tempfile::TempDir::new().unwrap();
1374 assert!(
1375 agent_skill_roots_under(home.path()).is_empty(),
1376 "a machine without an agent must detect nothing"
1377 );
1378
1379 fs::create_dir_all(home.path().join(constants::CLAUDE_HOME_DIR)).unwrap();
1380 let roots = agent_skill_roots_under(home.path());
1381 assert_eq!(roots.len(), 1);
1382
1383 assert_eq!(ensure_agent_skills_at(&roots), Outcome::Installed);
1384 let installed = home
1385 .path()
1386 .join(constants::CLAUDE_HOME_DIR)
1387 .join(constants::AGENT_SKILLS_SUBDIR)
1388 .join(constants::APP_NAME)
1389 .join("SKILL.md");
1390 assert_eq!(fs::read_to_string(&installed).unwrap(), EMBEDDED_SKILL_MD);
1391
1392 // A second pass finds it current and leaves it alone.
1393 assert_eq!(ensure_agent_skills_at(&roots), Outcome::AlreadyPresent);
1394 }
1395
1396 #[test]
1397 fn no_detected_agent_is_a_skip_not_a_failure() {
1398 assert!(matches!(ensure_agent_skills_at(&[]), Outcome::Skipped(_)));
1399 }
1400
1401 #[test]
1402 fn the_stamp_gates_the_unattended_pass() {
1403 let dir = tempfile::TempDir::new().unwrap();
1404 assert!(setup_is_due_in(dir.path()), "a fresh install is due");
1405 write_stamp_in(dir.path());
1406 assert!(
1407 !setup_is_due_in(dir.path()),
1408 "the same version is not due twice"
1409 );
1410 fs::write(dir.path().join(STAMP_FILE), "0.0.1").unwrap();
1411 assert!(setup_is_due_in(dir.path()), "an upgrade is due again");
1412 }
1413
1414 /// The alias must never be written with a copy while it already exists.
1415 ///
1416 /// A hard link and its target share one inode, so `fs::copy` onto the alias empties
1417 /// the binary it was copied from. This reproduces the exact shape of that bug — link
1418 /// first, then ask for the alias again — and asserts the original still has its
1419 /// bytes. The real failure was silent: a zero-byte executable that macOS runs
1420 /// through `/bin/sh`, which exits 0 and prints nothing.
1421 #[test]
1422 fn refreshing_an_alias_that_is_a_hard_link_does_not_empty_the_binary() {
1423 let dir = tempfile::TempDir::new().unwrap();
1424 let binary = dir.path().join("dev-prune");
1425 let alias = dir.path().join("devp");
1426 fs::write(&binary, vec![b'M'; 4096]).unwrap();
1427
1428 if fs::hard_link(&binary, &alias).is_err() {
1429 return; // Filesystem without hard links; the hazard cannot arise.
1430 }
1431
1432 // What `ensure_alias` does when its `hard_link` loses the race: the alias is
1433 // already there, so it must stop rather than fall through to the copy.
1434 assert!(fs::hard_link(&binary, &alias).is_err(), "EEXIST expected");
1435 assert!(alias.exists(), "the guard's condition");
1436
1437 assert_eq!(
1438 fs::metadata(&binary).unwrap().len(),
1439 4096,
1440 "the running binary was truncated by refreshing its own alias"
1441 );
1442 }
1443
1444 /// The on-disk file name for one of the pair, on this platform.
1445 fn exe_name(stem: &str) -> String {
1446 if cfg!(windows) {
1447 format!("{stem}.exe")
1448 } else {
1449 stem.to_string()
1450 }
1451 }
1452
1453 #[test]
1454 fn dev_prune_creates_devp_beside_it() {
1455 let dir = tempfile::TempDir::new().unwrap();
1456 let canonical = dir.path().join(exe_name("dev-prune"));
1457 fs::write(&canonical, "the binary").unwrap();
1458
1459 assert_eq!(ensure_twin_of(&canonical, dir.path()), Outcome::Installed);
1460 let alias = dir.path().join(exe_name("devp"));
1461 assert!(alias.is_file(), "`devp` was not created");
1462 assert_eq!(fs::read_to_string(&alias).unwrap(), "the binary");
1463 }
1464
1465 /// The pair has to be recoverable from either side.
1466 ///
1467 /// Deleting `dev-prune` and leaving `devp` is not hypothetical: an antivirus
1468 /// quarantine, a half-finished uninstall, or a `Remove-Item` aimed at one name all
1469 /// produce it. Before this, `devp setup` reported the alias already present and did
1470 /// nothing, because the only direction it knew how to repair was the other one.
1471 #[test]
1472 fn devp_restores_a_missing_dev_prune() {
1473 let dir = tempfile::TempDir::new().unwrap();
1474 let alias = dir.path().join(exe_name("devp"));
1475 fs::write(&alias, "the binary").unwrap();
1476
1477 assert_eq!(ensure_twin_of(&alias, dir.path()), Outcome::Installed);
1478 let canonical = dir.path().join(exe_name("dev-prune"));
1479 assert!(canonical.is_file(), "`dev-prune` was not put back");
1480 assert_eq!(fs::read_to_string(&canonical).unwrap(), "the binary");
1481 }
1482
1483 /// `devp` may create `dev-prune`, never overwrite it.
1484 ///
1485 /// Repairing in both directions opens a downgrade: an upgrade replaces `dev-prune`
1486 /// first and can then fail on a `devp` that is running, which leaves the alias holding
1487 /// the *older* binary. If the alias were allowed to refresh its twin from there, the
1488 /// next `devp setup` would quietly reinstall the version the user just upgraded away
1489 /// from — and report it as a repair.
1490 #[test]
1491 fn devp_does_not_overwrite_an_existing_dev_prune() {
1492 let dir = tempfile::TempDir::new().unwrap();
1493 let alias = dir.path().join(exe_name("devp"));
1494 let canonical = dir.path().join(exe_name("dev-prune"));
1495 fs::write(&alias, "the previous version").unwrap();
1496 fs::write(&canonical, "the version just upgraded to").unwrap();
1497
1498 assert_eq!(
1499 ensure_twin_of(&alias, dir.path()),
1500 Outcome::AlreadyPresent,
1501 "`devp` must leave an existing `dev-prune` alone"
1502 );
1503 assert_eq!(
1504 fs::read_to_string(&canonical).unwrap(),
1505 "the version just upgraded to",
1506 "`devp` downgraded the binary it was supposed to leave alone"
1507 );
1508 }
1509
1510 #[test]
1511 fn versions_parse_strictly_or_not_at_all() {
1512 assert_eq!(parse_version("1.2.3"), Some((1, 2, 3)));
1513 assert_eq!(parse_version("10.0.0"), Some((10, 0, 0)));
1514 // Anything this project does not publish must answer None, because a None
1515 // means "replace the copy" and a mis-parse would order versions wrongly.
1516 assert_eq!(parse_version("1.2"), None);
1517 assert_eq!(parse_version("1.2.3.4"), None);
1518 assert_eq!(parse_version("1.2.3-rc1"), None);
1519 assert_eq!(parse_version("dev-prune"), None);
1520 // The version this binary was built with has to be parseable, or the refresh
1521 // logic can never decide anything.
1522 assert!(parse_version(constants::VERSION).is_some());
1523 }
1524
1525 #[test]
1526 fn the_version_this_cli_prints_is_one_this_cli_can_read_back() {
1527 // Not synthetic: this is the shape `print_version_info` writes, `v` and all,
1528 // down to the banner line that ends in the same token.
1529 let real = format!(
1530 "|_____| v{v}
1531
1532dev-prune (devp) v{v}
1533 Compiler: Rust 1.88+ (edition 2024)
1534",
1535 v = constants::VERSION
1536 );
1537 assert_eq!(
1538 version_in_output(&real),
1539 parse_version(constants::VERSION),
1540 "binary_version could not read this binary's own --version output"
1541 );
1542 // Something that is not this CLI still has to answer None, because doctor uses
1543 // that to mean "leave this file alone".
1544 assert_eq!(version_in_output("git version 2.51.0.windows.1"), None);
1545 assert_eq!(version_in_output("some other tool"), None);
1546 }
1547
1548 #[test]
1549 fn ordering_of_version_triples_matches_semver() {
1550 assert!(parse_version("1.1.0") > parse_version("1.0.9"));
1551 assert!(parse_version("2.0.0") > parse_version("1.99.99"));
1552 assert!(parse_version("1.0.10") > parse_version("1.0.9"));
1553 }
1554
1555 #[test]
1556 fn the_exported_skill_is_the_one_the_binary_was_built_with() {
1557 // `SKILL.md` is embedded, so a doc edit ships only if the binary is rebuilt.
1558 // Guard the two properties every consumer of it depends on.
1559 assert!(EMBEDDED_SKILL_MD.starts_with("---"), "needs frontmatter");
1560 assert!(
1561 !EMBEDDED_SKILL_MD.contains("file:///"),
1562 "SKILL.md is written to every user's machine — it must not contain \
1563 absolute paths from the author's checkout"
1564 );
1565 }
1566}