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_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    String::from_utf8_lossy(&output.stdout)
245        .split_whitespace()
246        .find_map(parse_version)
247}
248
249/// Parse `x.y.z` into an orderable triple. Anything else — including the pre-release
250/// and build suffixes this project never publishes — answers `None`.
251pub(crate) fn parse_version(text: &str) -> Option<(u64, u64, u64)> {
252    let mut parts = text.split('.');
253    let triple = (
254        parts.next()?.parse().ok()?,
255        parts.next()?.parse().ok()?,
256        parts.next()?.parse().ok()?,
257    );
258    parts.next().is_none().then_some(triple)
259}
260
261/// Keep `dev-prune` and `devp` beside each other, whichever of the two is running.
262///
263/// The pair is one binary under two names, and either one can be the survivor. An upgrade
264/// that could not replace a running `devp` leaves a stale alias; an antivirus quarantine,
265/// a half-finished uninstall or a `Remove-Item` aimed at the wrong name leaves only
266/// `devp`. So this restores *the other* name in whichever direction is missing, rather
267/// than only ever creating `devp` — running either one puts the pair back.
268pub fn ensure_alias() -> Outcome {
269    // WinGet, Scoop and Homebrew each install into a directory they version and replace
270    // whole on upgrade, and each ships both names in the package itself — so there is
271    // nothing to create here, and creating it would be actively wrong twice over. The
272    // twin would be orphaned by the next upgrade, still on PATH, still running the old
273    // release; and writing a second executable beside a freshly downloaded unsigned
274    // binary on its first run is a behavioural malware signature. WinGet's own
275    // post-install validation flags exactly that, which is how this was found.
276    if crate::channel::Channel::detect().replaces_its_directory() {
277        return Outcome::AlreadyPresent;
278    }
279    let Ok(current_exe) = std::env::current_exe() else {
280        return Outcome::Failed("could not locate the running executable".to_string());
281    };
282    let Some(parent_dir) = current_exe.parent() else {
283        return Outcome::Failed("the running executable has no parent directory".to_string());
284    };
285
286    ensure_twin_of(&current_exe, parent_dir)
287}
288
289/// The half of [`ensure_alias`] that takes its paths as arguments, so tests can drive both
290/// directions without being the binary they are testing.
291fn ensure_twin_of(current_exe: &std::path::Path, parent_dir: &std::path::Path) -> Outcome {
292    let running_as_alias = current_exe
293        .file_stem()
294        .and_then(|s| s.to_str())
295        .is_some_and(|stem| stem == "devp");
296
297    // `dev-prune` is the canonical name, and only it may overwrite its twin.
298    //
299    // Installers write `dev-prune` first and upgrades replace it first, so it is never the
300    // older of the two — a stale `devp` is worth replacing, because otherwise it silently
301    // runs the previous version. The reverse is not safe: an upgrade that replaced
302    // `dev-prune` and then failed on a running `devp` leaves exactly the state where the
303    // alias is the *older* binary, and refreshing from there would quietly reinstall the
304    // version the user just upgraded away from. So `devp` may only create a `dev-prune`
305    // that is missing outright.
306    let (twin_name, may_refresh) = if running_as_alias {
307        (
308            if cfg!(windows) {
309                "dev-prune.exe"
310            } else {
311                "dev-prune"
312            },
313            false,
314        )
315    } else {
316        (if cfg!(windows) { "devp.exe" } else { "devp" }, true)
317    };
318    let twin_exe = parent_dir.join(twin_name);
319
320    if twin_exe.exists() {
321        if !may_refresh || same_contents(&twin_exe, current_exe) {
322            return Outcome::AlreadyPresent;
323        }
324        // Replacing a running executable fails on Windows; that is fine, the alias is
325        // simply refreshed by the next invocation that is not itself `devp`.
326        if fs::remove_file(&twin_exe).is_err() {
327            return Outcome::Skipped(format!(
328                "`{twin_name}` is in use and could not be refreshed — re-run `devp setup` \
329                 from a terminal that is not running it"
330            ));
331        }
332    }
333
334    if fs::hard_link(current_exe, &twin_exe).is_ok() {
335        return Outcome::Installed;
336    }
337
338    // The copy is the fallback for filesystems without hard links — but it must never
339    // run when the alias already exists, because the reason `hard_link` usually fails is
340    // that another process created it a moment ago, as a hard link to this very
341    // executable. `fs::copy` opens its destination with O_TRUNC, and truncating a hard
342    // link truncates the shared inode: the copy would empty the running binary and then
343    // copy zero bytes from it.
344    //
345    // That is not hypothetical. It is what turned every macOS CI run red. The 28
346    // integration tests launch at once, one wins the link, the losers fall through to
347    // here, and `target/debug/dev-prune` becomes a zero-byte file. macOS `posix_spawn`
348    // answers ENOEXEC by handing the file to `/bin/sh`, so every later invocation
349    // "succeeded" with exit 0 and printed nothing — for two hours the tests looked like
350    // 27 unrelated assertion failures.
351    if twin_exe.exists() {
352        return Outcome::AlreadyPresent;
353    }
354
355    // Stage beside and rename into place: copied straight onto the final name, the
356    // alias would exist-but-be-incomplete for the length of the copy, and a `devp`
357    // typed in that window executes a torn binary.
358    let staging = twin_exe.with_extension("new");
359    if fs::copy(current_exe, &staging).is_ok() && fs::rename(&staging, &twin_exe).is_ok() {
360        return Outcome::Installed;
361    }
362    let _ = fs::remove_file(&staging);
363    if twin_exe.exists() {
364        // A concurrent invocation won the rename; its alias serves exactly as well.
365        return Outcome::AlreadyPresent;
366    }
367    Outcome::Failed(format!(
368        "could not create `{}`",
369        output::clean_path(&twin_exe)
370    ))
371}
372
373/// Sameness test for two executables, cheap in the common case.
374///
375/// A hard link makes size and mtime equal by construction, so the usual layout answers
376/// without reading either file. When only the mtime differs — the alias came from the
377/// copy fallback, which does not preserve timestamps — the bytes themselves decide,
378/// because calling that pair "different" made every single invocation delete and
379/// recreate an alias whose content never changed.
380fn same_contents(a: &std::path::Path, b: &std::path::Path) -> bool {
381    let (Ok(ma), Ok(mb)) = (fs::metadata(a), fs::metadata(b)) else {
382        return false;
383    };
384    if ma.len() != mb.len() {
385        return false;
386    }
387    if ma.modified().ok() == mb.modified().ok() {
388        return true;
389    }
390    match (fs::read(a), fs::read(b)) {
391        (Ok(ca), Ok(cb)) => ca == cb,
392        _ => false,
393    }
394}
395
396/// Path that `devp skill` and this module export `SKILL.md` to.
397pub fn skill_path() -> Result<PathBuf> {
398    Ok(Registry::config_dir()?.join("SKILL.md"))
399}
400
401/// Export the bundled `SKILL.md` so AI assistants have something to read.
402///
403/// Rewritten whenever it differs from the embedded copy, since an upgrade that changes
404/// the skill must not leave the previous version's instructions on disk.
405pub fn ensure_skill_file() -> Outcome {
406    match Registry::config_dir() {
407        Ok(dir) => ensure_skill_file_in(&dir),
408        Err(_) => Outcome::Failed("could not determine the config directory".to_string()),
409    }
410}
411
412fn ensure_skill_file_in(config_dir: &std::path::Path) -> Outcome {
413    let target = config_dir.join("SKILL.md");
414
415    if fs::read_to_string(&target).is_ok_and(|current| current == EMBEDDED_SKILL_MD) {
416        return Outcome::AlreadyPresent;
417    }
418
419    let _ = fs::create_dir_all(config_dir);
420    match fs::write(&target, EMBEDDED_SKILL_MD) {
421        Ok(()) => Outcome::Installed,
422        Err(e) => Outcome::Failed(format!(
423            "could not write {}: {e}",
424            output::clean_path(&target)
425        )),
426    }
427}
428
429/// The per-skill directories of AI coding agents that are installed under `home`.
430///
431/// Detection only — an agent's home directory is created by the agent, never by this
432/// pass. Today that is Claude Code, whose Agent Skills live at
433/// `~/.claude/skills/<name>/SKILL.md`. Assistants without an on-disk skill format get
434/// the onboarding prompt from `devp skill` instead.
435fn agent_skill_roots_under(home: &std::path::Path) -> Vec<PathBuf> {
436    let mut roots = Vec::new();
437    let claude = home.join(constants::CLAUDE_HOME_DIR);
438    if claude.is_dir() {
439        roots.push(
440            claude
441                .join(constants::AGENT_SKILLS_SUBDIR)
442                .join(constants::APP_NAME),
443        );
444    }
445    roots
446}
447
448/// The agent skill directories on this machine. Empty when no agent is installed.
449pub fn agent_skill_roots() -> Vec<PathBuf> {
450    dirs::home_dir()
451        .map(|home| agent_skill_roots_under(&home))
452        .unwrap_or_default()
453}
454
455/// Install the skill into every detected agent's skills directory.
456pub fn ensure_agent_skills() -> Outcome {
457    ensure_agent_skills_at(&agent_skill_roots())
458}
459
460fn ensure_agent_skills_at(roots: &[PathBuf]) -> Outcome {
461    if roots.is_empty() {
462        return Outcome::Skipped(
463            "no AI agent skills directory was found — `devp skill` prints import prompts instead"
464                .to_string(),
465        );
466    }
467    let mut installed = false;
468    for root in roots {
469        match ensure_skill_file_in(root) {
470            Outcome::Installed => installed = true,
471            Outcome::AlreadyPresent => {}
472            other => return other,
473        }
474    }
475    if installed {
476        Outcome::Installed
477    } else {
478        Outcome::AlreadyPresent
479    }
480}
481
482/// Make the managed pair reachable from a fresh shell.
483///
484/// This is the step that lets `pip install dev-prune` in a virtualenv survive the
485/// virtualenv: the binaries pip placed vanish with the environment, but the managed
486/// copy under `<config>/bin` does not, and after this step it is the one a new
487/// terminal finds. See [`crate::pathenv`] for what "reachable" means per platform.
488pub fn ensure_command_on_path() -> Outcome {
489    let managed = stable_exe_path();
490    let is_managed_copy =
491        managed_exe_path().is_ok_and(|expected| expected == managed) && managed.is_file();
492    if !is_managed_copy {
493        // No managed copy exists and none could be created — under `cargo test` the
494        // running executable is the harness, and cloning that would be wrong. There is
495        // nothing durable to put on PATH.
496        return Outcome::Skipped("no managed copy of the binary exists to put on PATH".to_string());
497    }
498    let Some(bin_dir) = managed.parent() else {
499        return Outcome::Failed("the managed binary has no parent directory".to_string());
500    };
501    // `devp` has to sit beside it, or the PATH entry only ever finds `dev-prune`.
502    if let Outcome::Failed(why) = ensure_twin_of(&managed, bin_dir) {
503        return Outcome::Failed(why);
504    }
505    crate::pathenv::ensure_reachable(bin_dir)
506}
507
508/// Write the icon assets and register `*.devprune.json` with the OS file manager.
509///
510/// Part of the automatic pass rather than a separate errand, because "the config file has
511/// an icon" is not a thing anybody thinks to go and ask for. Everything it writes lives
512/// under the config directory and the user's own XDG data directory, `devp uninstall`
513/// removes all of it, and it touches no editor settings, no PATH and no shell profile —
514/// so there is nothing here that needs to be asked about first.
515///
516/// Unlike the hooks and the scheduler, this has no opt-out switch of its own. Files
517/// dropped into the user's data directory are not a background process and not a change
518/// in behaviour; `auto_setup` already covers "install nothing at all".
519fn ensure_icons() -> Outcome {
520    if crate::commands::icon::is_registered() {
521        return Outcome::AlreadyPresent;
522    }
523    match crate::commands::icon::sync_app_directory() {
524        Ok(()) => Outcome::Installed,
525        Err(e) => Outcome::Failed(format!("{e:#}")),
526    }
527}
528
529/// Install the global Git hooks, unless git is absent or the slot belongs to someone else.
530///
531/// `chain` is `auto_hooks_chain`: with it on, a slot that belongs to husky is not a
532/// reason to skip, because dev-prune can install in front and forward every hook back.
533pub fn ensure_hooks(chain: bool) -> Outcome {
534    if !hook::git_available() {
535        return Outcome::Skipped(format!(
536            "\n    {}",
537            hook::GIT_MISSING_HELP.replace('\n', "\n    ")
538        ));
539    }
540
541    match hook::state() {
542        // "Installed" is not the question — "installed and pointing at a binary that
543        // still exists" is. A hook backgrounds itself and discards its own output, so
544        // one left pointing at a deleted npm cache dies silently on every commit and
545        // nothing ever registers again; this pass is the only thing that ever looks.
546        // Two reasons to rewrite a working install: it names a binary that is gone, or
547        // it predates the passthrough shims and is silently shadowing every repository's
548        // own `.git/hooks`. Neither reports itself — a hook discards its own output by
549        // design — so the upgrade pass is the only thing that will ever notice.
550        Ok(HookState::Active) if hook_target_is_dead() || hook::shims_incomplete() => {
551            match hook::install() {
552                Ok(()) => Outcome::Installed,
553                Err(e) => Outcome::Failed(format!("{e:#}")),
554            }
555        }
556        Ok(HookState::Active) => Outcome::AlreadyPresent,
557        // Drift is repaired here rather than reported: the setup pass already runs on
558        // install, on update and on a schedule, and a chain the user opted into is a
559        // chain they want kept current.
560        Ok(HookState::Chained { drifted, .. }) if !drifted.is_empty() => {
561            match hook::install_with(true) {
562                Ok(()) => Outcome::Installed,
563                Err(e) => Outcome::Failed(format!("{e:#}")),
564            }
565        }
566        Ok(HookState::Chained { .. }) if hook_target_is_dead() => match hook::install_with(true) {
567            Ok(()) => Outcome::Installed,
568            Err(e) => Outcome::Failed(format!("{e:#}")),
569        },
570        Ok(HookState::Chained { .. }) => Outcome::AlreadyPresent,
571        Ok(HookState::Foreign(_)) if chain => match hook::install_with(true) {
572            Ok(()) => Outcome::Installed,
573            Err(e) => Outcome::Failed(format!("{e:#}")),
574        },
575        Ok(HookState::Foreign(existing)) => Outcome::Skipped(format!(
576            "`core.hooksPath` is already set to `{existing}`, which belongs to another tool.\n    \
577             Git allows only one hooks directory, so dev-prune will not take the slot.\n    \
578             `devp hook install --chain` installs in front of it instead — dev-prune registers \
579             the repo, then hands every hook on to `{existing}`, and `devp hook uninstall` puts \
580             the original setting back (`devp config set auto_hooks_chain true` makes that \
581             the standing answer). Or skip it: `devp link .` does the same job by hand."
582        )),
583        Ok(HookState::Absent) => match hook::install() {
584            Ok(()) => Outcome::Installed,
585            Err(e) => Outcome::Failed(format!("{e:#}")),
586        },
587        Err(e) => Outcome::Failed(format!("{e:#}")),
588    }
589}
590
591/// Whether the installed hooks name a binary that no longer exists.
592fn hook_target_is_dead() -> bool {
593    hook::registered_exe_path().is_some_and(|exe| !exe.exists())
594}
595
596/// Install the OS scheduler if it is not already registered.
597pub fn ensure_daemon(interval_days: u64) -> Outcome {
598    match daemon::daemon_status() {
599        // A task whose binary has been deleted keeps reporting itself `Ready` and dies
600        // the instant it fires, every interval, with nowhere to complain. Re-register
601        // it against the stable path instead of counting the corpse as present.
602        Ok(daemon::DaemonStatus::Installed)
603            if daemon::registered_exe_path().is_some_and(|exe| !exe.exists()) =>
604        {
605            match daemon::install_daemon(interval_days) {
606                Ok(()) => Outcome::Installed,
607                Err(e) => Outcome::Failed(format!("{e:#}")),
608            }
609        }
610        // A task registered by a version that only knew the interactive logon flashes a
611        // console window at whoever is logged in every time it fires — the single most
612        // trust-destroying thing a background tool can do. Re-register it hidden; a
613        // machine whose scheduler refuses the hidden logon remembers the refusal and is
614        // not asked again.
615        Ok(daemon::DaemonStatus::Installed) if daemon::wants_hidden_upgrade() => {
616            match daemon::install_daemon(interval_days) {
617                Ok(()) => Outcome::Installed,
618                Err(e) => Outcome::Failed(format!("{e:#}")),
619            }
620        }
621        // A settled, hidden task still needs its windowless twin kept current: the twin
622        // is a copy of the binary, so an upgrade that replaced the binary would otherwise
623        // leave the daemon firing the previous release. No-op on the other platforms, and
624        // when no twin is in use.
625        Ok(daemon::DaemonStatus::Installed) => {
626            daemon::refresh_hidden_twin();
627            Outcome::AlreadyPresent
628        }
629        Ok(daemon::DaemonStatus::NotInstalled) => match daemon::install_daemon(interval_days) {
630            Ok(()) => Outcome::Installed,
631            Err(e) => Outcome::Failed(format!("{e:#}")),
632        },
633        // `Unknown` means the query itself could not be answered — the scheduler may
634        // well be there. Installing over it would fail on every command from now on, so
635        // this reports and steps over instead of guessing. The platform backends are
636        // written to keep this case narrow: anything they can answer definitely, they do.
637        Ok(daemon::DaemonStatus::Unknown(why)) => {
638            Outcome::Skipped(format!("scheduler state could not be read — {why}"))
639        }
640        Err(e) => Outcome::Failed(format!("{e:#}")),
641    }
642}
643
644/// Whether unattended installation is permitted at all.
645///
646/// Both switches exist because these integrations write outside dev-prune's own config
647/// directory — a scheduled task, a global git setting — and there are places that must
648/// never happen unasked: container images, CI, and this project's own test suite.
649pub fn auto_setup_enabled(registry: &Registry) -> bool {
650    !no_auto_setup_requested() && registry.settings.auto_setup && unattended_environment().is_none()
651}
652
653/// The reason this looks like a machine nobody is sitting at, if it does.
654///
655/// `DEV_PRUNE_NO_AUTO_SETUP` and `auto_setup` are both switches you have to set *before*
656/// the first run — which is exactly the run that installs things, so in a container or a
657/// CI job the damage is done by the time there is anywhere to set them. Detecting the
658/// environment is the only opt-out that works on the first run, which is the only run
659/// that matters here.
660///
661/// Deliberately conservative: every signal below is one that CI providers and container
662/// runtimes set themselves, so a developer's own shell will not trip it. Someone who
663/// genuinely wants the integrations in CI can still ask in so many words with
664/// `devp setup`, which never consults this.
665pub fn unattended_environment() -> Option<&'static str> {
666    // Set by GitHub Actions, GitLab CI, CircleCI, Travis, Jenkins (via pipeline), Woodpecker
667    // and most others. `CI=true` is the closest thing this space has to a standard.
668    for var in [
669        "CI",
670        "CONTINUOUS_INTEGRATION",
671        "BUILD_NUMBER",
672        "GITHUB_ACTIONS",
673    ] {
674        if let Some(value) = std::env::var_os(var) {
675            // `CI=false` is set explicitly by some tools to mean "not CI", and honouring
676            // the word rather than the presence is what the user plainly meant.
677            let value = value.to_string_lossy();
678            if !value.is_empty() && !value.eq_ignore_ascii_case("false") {
679                return Some("this looks like a CI runner");
680            }
681        }
682    }
683
684    // Docker writes this marker into every container it builds from a Dockerfile;
685    // Podman and other OCI runtimes write the `container` variable instead.
686    #[cfg(unix)]
687    if std::path::Path::new("/.dockerenv").exists() {
688        return Some("this looks like a container");
689    }
690    if std::env::var_os("container").is_some() {
691        return Some("this looks like a container");
692    }
693
694    None
695}
696
697/// Run an integration pass unless unattended installation is switched off.
698///
699/// Every caller that the user did not name explicitly goes through this. `devp setup`
700/// calls [`ensure_integrations`] directly: asking for it in so many words is consent.
701pub fn ensure_integrations_if_enabled(registry: &Registry) -> Option<SetupReport> {
702    auto_setup_enabled(registry).then(|| ensure_integrations(registry))
703}
704
705/// Run one integration pass, installing whatever is missing.
706///
707/// The two per-integration settings (`auto_daemon`, `auto_hooks`) are honoured here, so
708/// turning one off turns it off for every future pass as well as this one.
709pub fn ensure_integrations(registry: &Registry) -> SetupReport {
710    let mut report = SetupReport::default();
711
712    report.push("dev-prune/devp pair", ensure_alias());
713    report.push("Command on PATH", ensure_command_on_path());
714    report.push("SKILL.md", ensure_skill_file());
715    // Only reported when an agent is actually installed: a machine without one would
716    // otherwise see a "skipped" warning about software it never had, on every install.
717    if !agent_skill_roots().is_empty() {
718        report.push("AI agent skills", ensure_agent_skills());
719    }
720    report.push("File icons", ensure_icons());
721
722    if registry.settings.auto_hooks {
723        report.push(
724            "Git hooks",
725            ensure_hooks(registry.settings.auto_hooks_chain),
726        );
727    } else {
728        report.push(
729            "Git hooks",
730            Outcome::Skipped("`auto_hooks` is false — enable with `devp hook install`".to_string()),
731        );
732    }
733
734    if registry.settings.auto_daemon {
735        report.push(
736            "Background scheduler",
737            ensure_daemon(registry.settings.check_interval_days),
738        );
739    } else {
740        report.push(
741            "Background scheduler",
742            Outcome::Skipped(
743                "`auto_daemon` is false — enable with `devp daemon install`".to_string(),
744            ),
745        );
746    }
747
748    report
749}
750
751// ── VS Code extension ────────────────────────────────────────────────────────
752
753/// Marker recording that the extension question was asked (or found already answered by
754/// an existing install). One file, no content: the offer is made once ever, whatever
755/// the answer was — a declined install must not be re-litigated on every upgrade.
756const VSCODE_OFFER_STAMP: &str = "vscode-ext-offered";
757
758/// A VS Code-compatible editor found on PATH.
759struct EditorCli {
760    /// The command to invoke — on Windows the `.cmd` launcher, because the entry on
761    /// PATH is a batch file, not an `.exe`, and `Command::new("code")` would miss it.
762    cli: String,
763    /// The editor's name as a person knows it, for the prompt and per-editor results.
764    label: &'static str,
765}
766
767/// Every VS Code-compatible editor on PATH, in the order listed here.
768///
769/// All of these forks keep the upstream CLI protocol (`--version`, `--list-extensions`,
770/// `--install-extension`), so one code path drives them all. What differs is the
771/// registry each one resolves an extension ID against: VS Code uses the Microsoft
772/// Marketplace, VSCodium/Windsurf/Positron/Kiro use OpenVSX, Cursor runs its own
773/// mirror. An ID install can therefore fail on a fork whose registry does not carry
774/// the extension yet — which is why the installer falls back to the `.vsix` from the
775/// GitHub release, the artifact every registry copy is built from.
776fn detect_vscode_editors() -> Vec<EditorCli> {
777    const CANDIDATES: &[(&str, &str)] = &[
778        ("code", "VS Code"),
779        ("code-insiders", "VS Code Insiders"),
780        ("codium", "VSCodium"),
781        ("codium-insiders", "VSCodium Insiders"),
782        ("cursor", "Cursor"),
783        ("windsurf", "Windsurf"),
784        ("positron", "Positron"),
785        ("kiro", "Kiro"),
786    ];
787    CANDIDATES
788        .iter()
789        .filter_map(|(name, label)| {
790            let cli = if cfg!(windows) {
791                format!("{name}.cmd")
792            } else {
793                (*name).to_string()
794            };
795            let responds = crate::spawn::command(&cli)
796                .arg("--version")
797                .stdin(std::process::Stdio::null())
798                .stdout(std::process::Stdio::null())
799                .stderr(std::process::Stdio::null())
800                .status()
801                .map(|s| s.success())
802                .unwrap_or(false);
803            responds.then_some(EditorCli { cli, label })
804        })
805        .collect()
806}
807
808fn vscode_extension_installed(cli: &str) -> bool {
809    crate::spawn::command(cli)
810        .arg("--list-extensions")
811        .stdin(std::process::Stdio::null())
812        .output()
813        .map(|out| {
814            String::from_utf8_lossy(&out.stdout).lines().any(|line| {
815                line.trim()
816                    .eq_ignore_ascii_case(constants::VSCODE_EXTENSION_ID)
817            })
818        })
819        .unwrap_or(false)
820}
821
822/// Download the `.vsix` attached to the latest GitHub release into the config directory.
823///
824/// The release asset is the source of truth for the extension — the Marketplace and
825/// OpenVSX listings are built from it — so when an editor's registry cannot resolve the
826/// ID (a fork whose registry does not carry the extension), installing the release file
827/// directly gets the same bits through a channel every fork supports. Editors update a
828/// `.vsix`-installed extension from their registry once a newer listed version appears,
829/// so this install self-heals into the normal update flow.
830fn download_release_vsix() -> Option<std::path::PathBuf> {
831    use std::time::Duration;
832
833    if offline_requested() {
834        return None;
835    }
836
837    let fetch = |url: &str| {
838        ureq::get(url)
839            .header("User-Agent", &format!("dev-prune/{}", constants::VERSION))
840            .header("Accept", "application/vnd.github+json")
841            .config()
842            .timeout_global(Some(Duration::from_secs(30)))
843            .build()
844            .call()
845    };
846
847    let body = fetch(constants::LATEST_RELEASE_API_URL)
848        .ok()?
849        .body_mut()
850        .read_to_string()
851        .ok()?;
852    let json: serde_json::Value = serde_json::from_str(&body).ok()?;
853    let asset = json.get("assets")?.as_array()?.iter().find_map(|asset| {
854        let name = asset.get("name")?.as_str()?;
855        if !name.ends_with(".vsix") {
856            return None;
857        }
858        let url = asset.get("browser_download_url")?.as_str()?;
859        Some((name.to_string(), url.to_string()))
860    })?;
861
862    let bytes = fetch(&asset.1).ok()?.body_mut().read_to_vec().ok()?;
863    // The config directory, not the shared system temp dir: on a multi-user machine
864    // `%TEMP%`-style paths are predictable and writable by others, and the editor is
865    // about to execute what this file contains. The caller deletes it after installing.
866    let dir = Registry::config_dir().ok()?;
867    fs::create_dir_all(&dir).ok()?;
868    let path = dir.join(&asset.0);
869    fs::write(&path, bytes).ok()?;
870    Some(path)
871}
872
873/// `<cli> --install-extension <arg>`, surfacing the editor's own output.
874fn run_install(cli: &str, arg: &str) -> bool {
875    crate::spawn::command(cli)
876        .args(["--install-extension", arg])
877        .stdin(std::process::Stdio::null())
878        .status()
879        .map(|s| s.success())
880        .unwrap_or(false)
881}
882
883/// Offer to install the editor extension, once ever, when a VS Code-family editor is
884/// present.
885///
886/// This asks rather than installs because the editor is not dev-prune's territory the
887/// way its own config directory is. Every gate below is a way of making sure a person
888/// is actually there to answer: no marker yet, not a CI runner or container, both ends
889/// of the terminal attached. When no editor is found nothing is written, so installing
890/// one later and re-running `devp setup` still gets the one offer.
891pub fn offer_vscode_extension() {
892    use std::io::{IsTerminal, Write};
893
894    let Ok(config_dir) = Registry::config_dir() else {
895        return;
896    };
897    if config_dir.join(VSCODE_OFFER_STAMP).exists() {
898        return;
899    }
900    if no_auto_setup_requested()
901        || unattended_environment().is_some()
902        || !std::io::stdin().is_terminal()
903        || !std::io::stdout().is_terminal()
904    {
905        return;
906    }
907    let editors = detect_vscode_editors();
908    if editors.is_empty() {
909        return;
910    }
911
912    let write_marker = || {
913        let _ = fs::create_dir_all(&config_dir);
914        let _ = fs::write(config_dir.join(VSCODE_OFFER_STAMP), "");
915    };
916
917    let missing: Vec<&EditorCli> = editors
918        .iter()
919        .filter(|e| !vscode_extension_installed(&e.cli))
920        .collect();
921    if missing.is_empty() {
922        write_marker();
923        return;
924    }
925
926    let names = missing
927        .iter()
928        .map(|e| e.label)
929        .collect::<Vec<_>>()
930        .join(", ");
931    println!();
932    println!("{names} detected — install the dev-prune extension?");
933    println!("  It validates .devprune.json and shows reclaimable space in the status bar.");
934    // The listings and the source, before the question rather than after it. This is
935    // the one prompt that defaults to yes, so the material someone would need in order
936    // to say no has to be on screen at the moment they answer — not in a doc they would
937    // have to go and look for.
938    println!("    Marketplace: {}", constants::VSCODE_MARKETPLACE_URL);
939    println!("    Open VSX:    {}", constants::OPENVSX_URL);
940    println!("    Source:      {}", constants::REPO_URL);
941    print!("  Install it? [Y/n] ");
942    let _ = std::io::stdout().flush();
943    let mut answer = String::new();
944    if std::io::stdin().read_line(&mut answer).is_err() {
945        return;
946    }
947    write_marker();
948
949    // A bare Enter accepts. Unlike the uninstall sweep — which deletes — the worst case
950    // here is an extension the person removes in two clicks, and the gates above have
951    // already established that a human with a VS Code-family editor is watching.
952    if !matches!(answer.trim().to_lowercase().as_str(), "" | "y" | "yes") {
953        output::print_info(&format!(
954            "Skipped. Install it any time with `{} --install-extension {}`, or from {}.",
955            missing[0].cli,
956            constants::VSCODE_EXTENSION_ID,
957            constants::VSCODE_MARKETPLACE_URL
958        ));
959        return;
960    }
961
962    // Fetched at most once, shared by every editor whose registry install fails.
963    let mut release_vsix: Option<Option<std::path::PathBuf>> = None;
964    for editor in &missing {
965        // The editor's own registry first: that install is the one the editor keeps
966        // up to date by itself.
967        if run_install(&editor.cli, constants::VSCODE_EXTENSION_ID) {
968            output::print_success(&format!("{}: extension installed.", editor.label));
969            continue;
970        }
971        // A fork whose registry does not carry the extension — install the `.vsix`
972        // from the GitHub release instead.
973        let vsix = release_vsix.get_or_insert_with(download_release_vsix);
974        match vsix {
975            Some(path) if run_install(&editor.cli, &path.to_string_lossy()) => {
976                output::print_success(&format!(
977                    "{}: extension installed from the GitHub release .vsix.",
978                    editor.label
979                ));
980            }
981            _ => {
982                output::print_warning(&format!(
983                    "{}: could not install it from here. Search the Extensions view for \"dev-prune\", or run `{} --install-extension {}` yourself.",
984                    editor.label,
985                    editor.cli,
986                    constants::VSCODE_EXTENSION_ID
987                ));
988            }
989        }
990    }
991    if let Some(Some(path)) = &release_vsix {
992        let _ = fs::remove_file(path);
993    }
994}
995
996/// Record that a pass completed for this version.
997fn write_stamp_in(config_dir: &std::path::Path) {
998    let _ = fs::create_dir_all(config_dir);
999    let _ = fs::write(config_dir.join(STAMP_FILE), constants::VERSION);
1000}
1001
1002fn write_stamp() {
1003    if let Ok(dir) = Registry::config_dir() {
1004        write_stamp_in(&dir);
1005    }
1006}
1007
1008fn setup_is_due_in(config_dir: &std::path::Path) -> bool {
1009    !fs::read_to_string(config_dir.join(STAMP_FILE))
1010        .is_ok_and(|stamp| stamp.trim() == constants::VERSION)
1011}
1012
1013/// Whether the unattended pass is due: a fresh install, or the first run after an upgrade.
1014pub fn setup_is_due() -> bool {
1015    Registry::config_dir()
1016        .map(|dir| setup_is_due_in(&dir))
1017        .unwrap_or(false)
1018}
1019
1020/// Whether there is a human at this invocation who could see what was done and undo it.
1021///
1022/// The one question that gates everything dev-prune installs without being asked. CI
1023/// variables and containers answer it directly; a redirected stdin or stdout answers it
1024/// too, because output nobody reads is the same as no output — and an integration
1025/// installed silently is one nobody knows to remove.
1026fn a_person_is_present() -> bool {
1027    use std::io::IsTerminal;
1028    unattended_environment().is_none()
1029        && std::io::stdin().is_terminal()
1030        && std::io::stdout().is_terminal()
1031}
1032
1033/// The unattended pass, run at most once per installed version.
1034///
1035/// Called at the top of every command that a human typed. It is deliberately not called
1036/// for the Git hook's `link --quiet` or the scheduler's `run --daemon`: those run without
1037/// a terminal, and an integration pass that nobody can see is one nobody can refuse.
1038pub fn auto_setup_if_due() {
1039    if !setup_is_due() {
1040        first_run_config_review();
1041        return;
1042    }
1043    // The same question `first_run_config_review` asks, asked one step earlier. It used
1044    // to be asked only about the *prompt*, never about the pass that installs a PATH
1045    // entry, a scheduled task and a git hook — so a binary run once by an automated
1046    // system, with its output captured, silently acquired persistence on that machine.
1047    // Nothing here is skipped permanently: the stamp is not written, so the first run a
1048    // person can actually see does the pass and reports it.
1049    if !a_person_is_present() {
1050        return;
1051    }
1052
1053    let Ok(registry) = Registry::load() else {
1054        return;
1055    };
1056    let Some(report) = ensure_integrations_if_enabled(&registry) else {
1057        // Suppressed. Stamp anyway, so a machine that opted out does not re-decide
1058        // this on every single command.
1059        write_stamp();
1060        crate::commands::config::skip_config_review();
1061        return;
1062    };
1063    if report.changed_anything() || report.needs_attention() {
1064        output::print_header("dev-prune setup");
1065        report.print(false);
1066        if report.changed_anything() {
1067            output::print_info(
1068                "Run `devp setup --status` to review these, or `devp uninstall` to remove them.",
1069            );
1070        }
1071        println!();
1072    }
1073    write_stamp();
1074    first_run_config_review();
1075}
1076
1077/// Put the defaults in front of the user on a fresh install, and any setting an upgrade
1078/// added that they have never been shown.
1079///
1080/// Separate from the integration stamp on purpose. The integrations are re-checked after
1081/// every upgrade; the settings are not, except for the ones that did not exist last time
1082/// — being asked to reconfirm `idle_days` on each new version would be a nuisance, and a
1083/// nuisance is something people learn to dismiss without reading.
1084///
1085/// Every condition here is a way of asking "is there a person reading this?", because the
1086/// alternative to asking is a prompt written into a log nobody will read, on a run that
1087/// then blocks forever waiting for an answer.
1088fn first_run_config_review() {
1089    if !crate::commands::config::config_review_is_due() {
1090        return;
1091    }
1092
1093    if !a_person_is_present() {
1094        crate::commands::config::skip_config_review();
1095        return;
1096    }
1097
1098    // Any error here is the wizard's own reporting; the command the user actually typed
1099    // still runs. A failed walkthrough must not become a failed `devp status`.
1100    if let Err(e) = crate::commands::config::run_wizard(false) {
1101        output::print_warning(&format!("Could not run the first-run setup ({e:#})."));
1102    }
1103    // Marked regardless of how it ended, including a deliberate quit. This is the one
1104    // caller that runs uninvited, and an unasked-for walkthrough that reappears on every
1105    // subsequent command is worse than one somebody dismissed once on purpose.
1106    crate::commands::config::skip_config_review();
1107    // Same first run, same person already answering questions — the one moment the
1108    // extension offer is a courtesy rather than an interruption.
1109    offer_vscode_extension();
1110    println!();
1111}
1112
1113/// Invalidate the stamp so the next human-run command performs a pass.
1114///
1115/// `uninstall` calls this in reverse — it writes the current stamp — so that removing the
1116/// integrations is not immediately undone by the next command.
1117pub fn suppress_next_auto_setup() {
1118    write_stamp();
1119}
1120
1121#[cfg(test)]
1122mod tests {
1123    use super::*;
1124
1125    #[test]
1126    fn a_report_with_only_present_items_is_silent() {
1127        let mut report = SetupReport::default();
1128        report.push("a", Outcome::AlreadyPresent);
1129        assert!(!report.changed_anything());
1130        assert!(!report.needs_attention());
1131    }
1132
1133    #[test]
1134    fn skipped_and_failed_both_ask_for_attention() {
1135        let mut skipped = SetupReport::default();
1136        skipped.push("a", Outcome::Skipped("no git".into()));
1137        assert!(skipped.needs_attention());
1138        assert!(!skipped.changed_anything());
1139
1140        let mut failed = SetupReport::default();
1141        failed.push("a", Outcome::Failed("boom".into()));
1142        assert!(failed.needs_attention());
1143    }
1144
1145    #[test]
1146    fn an_install_counts_as_a_change() {
1147        let mut report = SetupReport::default();
1148        report.push("a", Outcome::Installed);
1149        assert!(report.changed_anything());
1150    }
1151
1152    #[test]
1153    fn the_skill_export_lands_in_the_config_directory() {
1154        let dir = tempfile::TempDir::new().unwrap();
1155        assert_eq!(ensure_skill_file_in(dir.path()), Outcome::Installed);
1156        // A second pass finds byte-identical content and leaves it alone.
1157        assert_eq!(ensure_skill_file_in(dir.path()), Outcome::AlreadyPresent);
1158        let written = fs::read_to_string(dir.path().join("SKILL.md")).unwrap();
1159        assert_eq!(written, EMBEDDED_SKILL_MD);
1160    }
1161
1162    #[test]
1163    fn a_stale_skill_export_is_rewritten() {
1164        // An upgrade must not leave the previous version's instructions on disk.
1165        let dir = tempfile::TempDir::new().unwrap();
1166        fs::write(dir.path().join("SKILL.md"), "# an older version").unwrap();
1167        assert_eq!(ensure_skill_file_in(dir.path()), Outcome::Installed);
1168        let written = fs::read_to_string(dir.path().join("SKILL.md")).unwrap();
1169        assert_eq!(written, EMBEDDED_SKILL_MD);
1170    }
1171
1172    #[test]
1173    fn agent_skills_install_only_into_agent_homes_that_exist() {
1174        let home = tempfile::TempDir::new().unwrap();
1175        assert!(
1176            agent_skill_roots_under(home.path()).is_empty(),
1177            "a machine without an agent must detect nothing"
1178        );
1179
1180        fs::create_dir_all(home.path().join(constants::CLAUDE_HOME_DIR)).unwrap();
1181        let roots = agent_skill_roots_under(home.path());
1182        assert_eq!(roots.len(), 1);
1183
1184        assert_eq!(ensure_agent_skills_at(&roots), Outcome::Installed);
1185        let installed = home
1186            .path()
1187            .join(constants::CLAUDE_HOME_DIR)
1188            .join(constants::AGENT_SKILLS_SUBDIR)
1189            .join(constants::APP_NAME)
1190            .join("SKILL.md");
1191        assert_eq!(fs::read_to_string(&installed).unwrap(), EMBEDDED_SKILL_MD);
1192
1193        // A second pass finds it current and leaves it alone.
1194        assert_eq!(ensure_agent_skills_at(&roots), Outcome::AlreadyPresent);
1195    }
1196
1197    #[test]
1198    fn no_detected_agent_is_a_skip_not_a_failure() {
1199        assert!(matches!(ensure_agent_skills_at(&[]), Outcome::Skipped(_)));
1200    }
1201
1202    #[test]
1203    fn the_stamp_gates_the_unattended_pass() {
1204        let dir = tempfile::TempDir::new().unwrap();
1205        assert!(setup_is_due_in(dir.path()), "a fresh install is due");
1206        write_stamp_in(dir.path());
1207        assert!(
1208            !setup_is_due_in(dir.path()),
1209            "the same version is not due twice"
1210        );
1211        fs::write(dir.path().join(STAMP_FILE), "0.0.1").unwrap();
1212        assert!(setup_is_due_in(dir.path()), "an upgrade is due again");
1213    }
1214
1215    /// The alias must never be written with a copy while it already exists.
1216    ///
1217    /// A hard link and its target share one inode, so `fs::copy` onto the alias empties
1218    /// the binary it was copied from. This reproduces the exact shape of that bug — link
1219    /// first, then ask for the alias again — and asserts the original still has its
1220    /// bytes. The real failure was silent: a zero-byte executable that macOS runs
1221    /// through `/bin/sh`, which exits 0 and prints nothing.
1222    #[test]
1223    fn refreshing_an_alias_that_is_a_hard_link_does_not_empty_the_binary() {
1224        let dir = tempfile::TempDir::new().unwrap();
1225        let binary = dir.path().join("dev-prune");
1226        let alias = dir.path().join("devp");
1227        fs::write(&binary, vec![b'M'; 4096]).unwrap();
1228
1229        if fs::hard_link(&binary, &alias).is_err() {
1230            return; // Filesystem without hard links; the hazard cannot arise.
1231        }
1232
1233        // What `ensure_alias` does when its `hard_link` loses the race: the alias is
1234        // already there, so it must stop rather than fall through to the copy.
1235        assert!(fs::hard_link(&binary, &alias).is_err(), "EEXIST expected");
1236        assert!(alias.exists(), "the guard's condition");
1237
1238        assert_eq!(
1239            fs::metadata(&binary).unwrap().len(),
1240            4096,
1241            "the running binary was truncated by refreshing its own alias"
1242        );
1243    }
1244
1245    /// The on-disk file name for one of the pair, on this platform.
1246    fn exe_name(stem: &str) -> String {
1247        if cfg!(windows) {
1248            format!("{stem}.exe")
1249        } else {
1250            stem.to_string()
1251        }
1252    }
1253
1254    #[test]
1255    fn dev_prune_creates_devp_beside_it() {
1256        let dir = tempfile::TempDir::new().unwrap();
1257        let canonical = dir.path().join(exe_name("dev-prune"));
1258        fs::write(&canonical, "the binary").unwrap();
1259
1260        assert_eq!(ensure_twin_of(&canonical, dir.path()), Outcome::Installed);
1261        let alias = dir.path().join(exe_name("devp"));
1262        assert!(alias.is_file(), "`devp` was not created");
1263        assert_eq!(fs::read_to_string(&alias).unwrap(), "the binary");
1264    }
1265
1266    /// The pair has to be recoverable from either side.
1267    ///
1268    /// Deleting `dev-prune` and leaving `devp` is not hypothetical: an antivirus
1269    /// quarantine, a half-finished uninstall, or a `Remove-Item` aimed at one name all
1270    /// produce it. Before this, `devp setup` reported the alias already present and did
1271    /// nothing, because the only direction it knew how to repair was the other one.
1272    #[test]
1273    fn devp_restores_a_missing_dev_prune() {
1274        let dir = tempfile::TempDir::new().unwrap();
1275        let alias = dir.path().join(exe_name("devp"));
1276        fs::write(&alias, "the binary").unwrap();
1277
1278        assert_eq!(ensure_twin_of(&alias, dir.path()), Outcome::Installed);
1279        let canonical = dir.path().join(exe_name("dev-prune"));
1280        assert!(canonical.is_file(), "`dev-prune` was not put back");
1281        assert_eq!(fs::read_to_string(&canonical).unwrap(), "the binary");
1282    }
1283
1284    /// `devp` may create `dev-prune`, never overwrite it.
1285    ///
1286    /// Repairing in both directions opens a downgrade: an upgrade replaces `dev-prune`
1287    /// first and can then fail on a `devp` that is running, which leaves the alias holding
1288    /// the *older* binary. If the alias were allowed to refresh its twin from there, the
1289    /// next `devp setup` would quietly reinstall the version the user just upgraded away
1290    /// from — and report it as a repair.
1291    #[test]
1292    fn devp_does_not_overwrite_an_existing_dev_prune() {
1293        let dir = tempfile::TempDir::new().unwrap();
1294        let alias = dir.path().join(exe_name("devp"));
1295        let canonical = dir.path().join(exe_name("dev-prune"));
1296        fs::write(&alias, "the previous version").unwrap();
1297        fs::write(&canonical, "the version just upgraded to").unwrap();
1298
1299        assert_eq!(
1300            ensure_twin_of(&alias, dir.path()),
1301            Outcome::AlreadyPresent,
1302            "`devp` must leave an existing `dev-prune` alone"
1303        );
1304        assert_eq!(
1305            fs::read_to_string(&canonical).unwrap(),
1306            "the version just upgraded to",
1307            "`devp` downgraded the binary it was supposed to leave alone"
1308        );
1309    }
1310
1311    #[test]
1312    fn versions_parse_strictly_or_not_at_all() {
1313        assert_eq!(parse_version("1.2.3"), Some((1, 2, 3)));
1314        assert_eq!(parse_version("10.0.0"), Some((10, 0, 0)));
1315        // Anything this project does not publish must answer None, because a None
1316        // means "replace the copy" and a mis-parse would order versions wrongly.
1317        assert_eq!(parse_version("1.2"), None);
1318        assert_eq!(parse_version("1.2.3.4"), None);
1319        assert_eq!(parse_version("1.2.3-rc1"), None);
1320        assert_eq!(parse_version("dev-prune"), None);
1321        // The version this binary was built with has to be parseable, or the refresh
1322        // logic can never decide anything.
1323        assert!(parse_version(constants::VERSION).is_some());
1324    }
1325
1326    #[test]
1327    fn ordering_of_version_triples_matches_semver() {
1328        assert!(parse_version("1.1.0") > parse_version("1.0.9"));
1329        assert!(parse_version("2.0.0") > parse_version("1.99.99"));
1330        assert!(parse_version("1.0.10") > parse_version("1.0.9"));
1331    }
1332
1333    #[test]
1334    fn the_exported_skill_is_the_one_the_binary_was_built_with() {
1335        // `SKILL.md` is embedded, so a doc edit ships only if the binary is rebuilt.
1336        // Guard the two properties every consumer of it depends on.
1337        assert!(EMBEDDED_SKILL_MD.starts_with("---"), "needs frontmatter");
1338        assert!(
1339            !EMBEDDED_SKILL_MD.contains("file:///"),
1340            "SKILL.md is written to every user's machine — it must not contain \
1341             absolute paths from the author's checkout"
1342        );
1343    }
1344}