Skip to main content

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