1use anyhow::{Result, bail};
10use std::path::Path;
11
12use crate::config::{PerRepoConfig, Registry, Settings};
13use crate::i18n;
14use crate::output;
15
16struct Setting {
24 key: &'static str,
25 category: Category,
31 since: &'static str,
38 kind: Kind,
40 help: &'static str,
44 plain: &'static str,
51 get: fn(&Settings) -> String,
52 set: fn(&mut Settings, &str) -> Result<()>,
53}
54
55#[derive(Debug, Clone, Copy, PartialEq, Eq)]
64enum Category {
65 Presentation,
70 Scope,
72 Safety,
74 BuildTrees,
77 Caches,
79 Unattended,
81 Updates,
83}
84
85impl Category {
86 fn title(self) -> &'static str {
93 match self {
94 Category::Presentation => i18n::t("config.category.presentation"),
95 Category::Scope => i18n::t("config.category.scope"),
96 Category::Safety => i18n::t("config.category.safety"),
97 Category::BuildTrees => i18n::t("config.category.build_trees"),
98 Category::Caches => i18n::t("config.category.caches"),
99 Category::Unattended => i18n::t("config.category.unattended"),
100 Category::Updates => i18n::t("config.category.updates"),
101 }
102 }
103}
104
105const CATEGORIES: &[Category] = &[
107 Category::Presentation,
108 Category::Scope,
109 Category::Safety,
110 Category::BuildTrees,
111 Category::Caches,
112 Category::Unattended,
113 Category::Updates,
114];
115
116fn settings_by_category() -> Vec<(Category, Vec<&'static Setting>)> {
122 CATEGORIES
123 .iter()
124 .map(|&category| {
125 (
126 category,
127 SETTINGS.iter().filter(|s| s.category == category).collect(),
128 )
129 })
130 .collect()
131}
132
133#[derive(Debug, Clone, Copy, PartialEq, Eq)]
139enum Kind {
140 Toggle,
142 Number,
144 Adapters,
146 CacheCaps,
152 Choice,
157 AdapterDays,
164}
165
166struct Recommendation {
172 key: &'static str,
173 label: &'static str,
175 why: &'static str,
177 value: &'static str,
180 cautious: bool,
182}
183
184const SAFE_TIER: &str = "Recommended";
191
192const CAUTIOUS_TIER: &str = "Recommended, with one thing to know first";
195
196const RECOMMENDED: &[Recommendation] = &[
203 Recommendation {
204 key: "enable_cargo",
205 label: "Rust build folders",
206 why: "Rust `target/` directories are usually the largest thing on a developer's disk — \
207 tens of gigabytes across a handful of old projects. Nothing is lost: `cargo build` \
208 rebuilds it, and a project has to sit untouched for 45 days before this one is even \
209 considered.",
210 value: "true",
211 cautious: false,
212 },
213 Recommendation {
214 key: "enable_gradle",
215 label: "Android / Gradle builds",
216 why: "`build/` and `.gradle/` grow with every Android build and are never cleaned up by \
217 anything else. They come back on the next build, under the same 45-day wait.",
218 value: "true",
219 cautious: false,
220 },
221 Recommendation {
222 key: "enable_maven",
223 label: "Maven builds",
224 why: "Maven `target/` directories accumulate quietly per module, so a multi-module project \
225 has several. `mvn package` brings them back.",
226 value: "true",
227 cautious: false,
228 },
229 Recommendation {
230 key: "enable_swift",
231 label: "Swift builds",
232 why: "`.build/` holds compiled modules for every configuration you have ever built, and \
233 `swift build` recreates the one you actually use.",
234 value: "true",
235 cautious: false,
236 },
237 Recommendation {
238 key: "enable_dart",
239 label: "Dart / Flutter caches",
240 why: "`.dart_tool/` carries the pub metadata — back in a second — alongside `build_runner` \
241 and `flutter_build` caches that are worth real disk space.",
242 value: "true",
243 cautious: false,
244 },
245 Recommendation {
246 key: "enable_mix_build",
247 label: "Elixir build trees",
248 why: "`_build/` holds compiled beam files for every Mix environment you have built, and \
249 `mix compile` recreates the one you are working in.",
250 value: "true",
251 cautious: false,
252 },
253 Recommendation {
254 key: "enable_vcpkg",
255 label: "C / C++ vcpkg trees",
256 why: "`vcpkg_installed/` holds libraries vcpkg compiled from source for one \
257 project, and `vcpkg install` builds them again from the manifest beside \
258 them.",
259 value: "true",
260 cautious: false,
261 },
262 Recommendation {
263 key: "enable_cmake_build",
264 label: "C / C++ CMake build trees",
265 why: "A configured CMake build tree is object files and linked binaries, and \
266 `cmake` writes a `CMakeCache.txt` at the top of it that says which sources \
267 build it again — so a `build/` you made by hand is left alone.",
268 value: "true",
269 cautious: false,
270 },
271 Recommendation {
272 key: "allow_manifest_rewrite",
273 label: "Let cargo and go tidy up",
274 why: "Cautious, not risky. The commands that restore a Rust or Go project can also update \
275 `Cargo.lock` or `go.mod` — files Git tracks. Nothing is lost and nothing is deleted, \
276 but the next `git status` may show a change you did not make by hand. Turn it on if \
277 that is fine; leave it off if a clean working tree matters more than a fully \
278 automatic restore.",
279 value: "true",
280 cautious: true,
281 },
282];
283
284const SETTINGS: &[Setting] = &[
286 Setting {
287 key: "language",
288 category: Category::Presentation,
289 since: "1.10.0",
290 kind: Kind::Choice,
291 help: "Language for dev-prune's own headings and summary lines. `--json`, exit codes, flag names and config keys stay English in every language.",
292 plain: "What language dev-prune talks to you in. Only its own headings change — the words you type and anything a script reads stay in English, so nothing breaks. Everything but English is a community translation, and some have not been proofread yet.",
293 get: |s| s.language.clone(),
294 set: |s, v| {
295 let code = v.trim();
296 let Some(meta) = i18n::language(code) else {
297 bail!(
298 "unknown language `{code}` — available: {}",
299 i18n::catalogue_line()
300 );
301 };
302 s.language = meta.code.clone();
303 Ok(())
304 },
305 },
306 Setting {
307 key: "idle_days",
308 category: Category::Scope,
309 since: "1.0.0",
310 kind: Kind::Number,
311 help: "Days a repository must sit untouched before it is eligible for pruning.",
312 plain: "How long a project has to sit untouched before dev-prune will clean it. Something you worked on yesterday is never touched.",
313 get: |s| s.idle_days.to_string(),
314 set: |s, v| {
315 s.idle_days = v
316 .parse()
317 .map_err(|_| anyhow::anyhow!("idle_days must be a whole number of days"))?;
318 Ok(())
319 },
320 },
321 Setting {
322 key: "min_size_mb",
323 category: Category::Scope,
324 since: "1.0.0",
325 kind: Kind::Number,
326 help: "Smallest bloat directory worth deleting, in MiB. 0 removes the floor.",
327 plain: "Ignore small folders. Deleting a 2 MB folder is not worth the download to get it back.",
328 get: |s| s.min_size_mb.to_string(),
329 set: |s, v| {
330 s.min_size_mb = v.parse().map_err(|_| {
331 anyhow::anyhow!("min_size_mb must be a whole number of MiB (0 disables the floor)")
332 })?;
333 Ok(())
334 },
335 },
336 Setting {
337 key: "scan_depth",
338 category: Category::Scope,
339 since: "1.0.0",
340 kind: Kind::Number,
341 help: "How many directory levels below a repo root project discovery descends.",
342 plain: "How deep inside a repository to look for projects. Raise it if your projects live several folders down; lower it if scanning feels slow.",
343 get: |s| s.scan_depth.to_string(),
344 set: |s, v| {
345 let depth: usize = v
346 .parse()
347 .map_err(|_| anyhow::anyhow!("scan_depth must be a positive integer"))?;
348 if depth == 0 {
352 bail!("scan_depth must be at least 1 — 0 would find no projects at all.");
353 }
354 if depth > crate::constants::MAX_SCAN_DEPTH_LIMIT {
355 bail!(
356 "scan_depth must be at most {} — deeper walks stall on generated trees.",
357 crate::constants::MAX_SCAN_DEPTH_LIMIT
358 );
359 }
360 s.scan_depth = depth;
361 Ok(())
362 },
363 },
364 Setting {
365 key: "require_confirmation",
366 category: Category::Safety,
367 since: "1.0.0",
368 kind: Kind::Toggle,
369 help: "Ask before deleting anything. Turning this off makes every run unattended.",
370 plain: "Whether dev-prune asks \"delete these?\" before it deletes. Leave this on unless you want it to run silently while you are away.",
371 get: |s| s.require_confirmation.to_string(),
372 set: |s, v| {
373 s.require_confirmation = parse_bool("require_confirmation", v)?;
374 Ok(())
375 },
376 },
377 Setting {
378 key: "allow_manifest_rewrite",
379 category: Category::Safety,
380 since: "1.0.0",
381 kind: Kind::Toggle,
382 help: "Let cargo and go run the sync command that rewrites tracked manifests.",
383 plain: "Lets dev-prune run the command that puts a Rust or Go project back together — which can edit files that are checked into Git. Nothing is lost, but the change shows up in `git status`.",
384 get: |s| s.allow_manifest_rewrite.to_string(),
385 set: |s, v| {
386 s.allow_manifest_rewrite = parse_bool("allow_manifest_rewrite", v)?;
387 Ok(())
388 },
389 },
390 Setting {
391 key: "command_timeout_secs",
392 category: Category::Safety,
393 since: "1.0.0",
394 kind: Kind::Number,
395 help: "How long one package-manager command may run before it is killed — the lockfile check and `devp restore`, never a recompile.",
396 plain: "How long to wait for a package manager to answer before giving up on it: the lockfile check before a delete, and the reinstall `devp restore` runs. Nothing is compiled under it — the opt-in build adapters run no command at all during a prune — except a restore whose install builds a native module. Raise it on a slow connection.",
397 get: |s| s.command_timeout_secs.to_string(),
398 set: |s, v| {
399 let secs: u64 = v
400 .parse()
401 .map_err(|_| anyhow::anyhow!("command_timeout_secs must be a positive integer"))?;
402 if secs == 0 {
406 bail!(
407 "command_timeout_secs must be at least 1 — 0 would kill every command \
408 the instant it starts."
409 );
410 }
411 s.command_timeout_secs = secs;
412 Ok(())
413 },
414 },
415 Setting {
416 key: "auto_setup",
417 category: Category::Unattended,
418 since: "1.0.0",
419 kind: Kind::Toggle,
420 help: "Install missing integrations by itself, once per installed version.",
421 plain: "Whether dev-prune finishes setting itself up on its own instead of making you run `devp setup`.",
422 get: |s| s.auto_setup.to_string(),
423 set: |s, v| {
424 s.auto_setup = parse_bool("auto_setup", v)?;
425 Ok(())
426 },
427 },
428 Setting {
429 key: "auto_config",
430 category: Category::Unattended,
431 since: "1.3.0",
432 kind: Kind::Toggle,
433 help: "Write a default .devprune.json into repositories that link/init register.",
434 plain: "Drops a small settings file into each repository you register, so you can give that one project different rules later.",
435 get: |s| s.auto_config.to_string(),
436 set: |s, v| {
437 s.auto_config = parse_bool("auto_config", v)?;
438 Ok(())
439 },
440 },
441 Setting {
442 key: "auto_daemon",
443 category: Category::Unattended,
444 since: "1.0.0",
445 kind: Kind::Toggle,
446 help: "Register the OS scheduler so passes run without being remembered.",
447 plain: "Lets your operating system run dev-prune on a schedule, so you never have to remember to.",
448 get: |s| s.auto_daemon.to_string(),
449 set: |s, v| {
450 s.auto_daemon = parse_bool("auto_daemon", v)?;
451 Ok(())
452 },
453 },
454 Setting {
455 key: "check_interval_days",
456 category: Category::Unattended,
457 since: "1.0.0",
458 kind: Kind::Number,
459 help: "Days between scheduled background passes.",
460 plain: "How often that scheduled cleanup runs.",
461 get: |s| s.check_interval_days.to_string(),
462 set: |s, v| {
463 let days: u64 = v
464 .parse()
465 .map_err(|_| anyhow::anyhow!("check_interval_days must be a positive integer"))?;
466 if days == 0 {
468 bail!("check_interval_days must be at least 1.");
469 }
470 s.check_interval_days = days;
471 Ok(())
472 },
473 },
474 Setting {
475 key: "auto_hooks",
476 category: Category::Unattended,
477 since: "1.0.0",
478 kind: Kind::Toggle,
479 help: "Install the Git hooks that register repositories as you clone them.",
480 plain: "Registers new repositories automatically as you clone them, so you never have to add them by hand.",
481 get: |s| s.auto_hooks.to_string(),
482 set: |s, v| {
483 s.auto_hooks = parse_bool("auto_hooks", v)?;
484 Ok(())
485 },
486 },
487 Setting {
488 key: "auto_hooks_chain",
489 category: Category::Unattended,
490 since: "1.0.0",
491 kind: Kind::Toggle,
492 help: "If another tool owns core.hooksPath, install in front of it and forward. Off by default: that slot is machine-wide and already someone else's.",
493 plain: "Git only has one slot for this kind of automation. If something else — husky, pre-commit, lefthook — is already using it, share the slot instead of taking it over. Off by default because the slot is global to your machine and dev-prune would be taking over another tool's setup to use it. `devp doctor` names the command when it finds one of those tools holding it.",
494 get: |s| s.auto_hooks_chain.to_string(),
495 set: |s, v| {
496 s.auto_hooks_chain = parse_bool("auto_hooks_chain", v)?;
497 Ok(())
498 },
499 },
500 Setting {
501 key: "update_check",
502 category: Category::Updates,
503 since: "1.0.0",
504 kind: Kind::Toggle,
505 help: "Ask GitHub for the latest release from time to time. Sends nothing but the request.",
506 plain: "Whether dev-prune checks GitHub now and then to see if there is a newer version. It sends no information about you.",
507 get: |s| s.update_check.to_string(),
508 set: |s, v| {
509 s.update_check = parse_bool("update_check", v)?;
510 Ok(())
511 },
512 },
513 Setting {
514 key: "update_check_interval_days",
515 category: Category::Updates,
516 since: "1.0.0",
517 kind: Kind::Number,
518 help: "Days between automatic release checks.",
519 plain: "How often that version check happens.",
520 get: |s| s.update_check_interval_days.to_string(),
521 set: |s, v| {
522 let days: i64 = v.parse().map_err(|_| {
523 anyhow::anyhow!("update_check_interval_days must be a positive integer")
524 })?;
525 if days < 1 {
526 bail!("update_check_interval_days must be at least 1.");
527 }
528 s.update_check_interval_days = days;
529 Ok(())
530 },
531 },
532 Setting {
533 key: "update_check_timeout_secs",
534 category: Category::Updates,
535 since: "1.0.0",
536 kind: Kind::Number,
537 help: "Seconds the release check waits for GitHub. Raise it behind a slow proxy.",
538 plain: "How long the version check waits before giving up. Raise it if you are behind a slow proxy.",
539 get: |s| s.update_check_timeout_secs.to_string(),
540 set: |s, v| {
541 let secs: u64 = v.parse().map_err(|_| {
542 anyhow::anyhow!("update_check_timeout_secs must be a positive integer")
543 })?;
544 if secs == 0 {
545 bail!("update_check_timeout_secs must be at least 1.");
546 }
547 s.update_check_timeout_secs = secs;
548 Ok(())
549 },
550 },
551 Setting {
552 key: "enable_cargo",
553 category: Category::BuildTrees,
554 since: "1.5.0",
555 kind: Kind::Toggle,
556 help: "Turn on the opt-in Cargo adapter (target/ comes back by recompiling, not downloading).",
557 plain: "Clean Rust build folders too. These come back by recompiling, which takes minutes rather than a download — so it is off by default.",
558 get: |s| s.enable_cargo.to_string(),
559 set: |s, v| {
560 s.enable_cargo = parse_bool("enable_cargo", v)?;
561 Ok(())
562 },
563 },
564 Setting {
565 key: "enable_gradle",
566 category: Category::BuildTrees,
567 since: "1.3.0",
568 kind: Kind::Toggle,
569 help: "Turn on the opt-in Gradle adapter (build/ and .gradle/ come back by recompiling).",
570 plain: "Clean Android and Java build folders too. Same trade: they come back by recompiling, not downloading.",
571 get: |s| s.enable_gradle.to_string(),
572 set: |s, v| {
573 s.enable_gradle = parse_bool("enable_gradle", v)?;
574 Ok(())
575 },
576 },
577 Setting {
578 key: "enable_maven",
579 category: Category::BuildTrees,
580 since: "1.3.0",
581 kind: Kind::Toggle,
582 help: "Turn on the opt-in Maven adapter (target/ comes back by recompiling).",
583 plain: "Clean Maven build folders too. They come back by recompiling.",
584 get: |s| s.enable_maven.to_string(),
585 set: |s, v| {
586 s.enable_maven = parse_bool("enable_maven", v)?;
587 Ok(())
588 },
589 },
590 Setting {
591 key: "enable_swift",
592 category: Category::BuildTrees,
593 since: "1.4.0",
594 kind: Kind::Toggle,
595 help: "Turn on the opt-in SwiftPM adapter (.build/ comes back by recompiling).",
596 plain: "Clean Swift build folders too. They come back by recompiling.",
597 get: |s| s.enable_swift.to_string(),
598 set: |s, v| {
599 s.enable_swift = parse_bool("enable_swift", v)?;
600 Ok(())
601 },
602 },
603 Setting {
604 key: "enable_dart",
605 category: Category::BuildTrees,
606 since: "1.6.0",
607 kind: Kind::Toggle,
608 help: "Turn on the opt-in Dart/Flutter adapter (.dart_tool/ holds build caches).",
609 plain: "Clean Dart and Flutter caches too. Part comes back instantly, part by recompiling.",
610 get: |s| s.enable_dart.to_string(),
611 set: |s, v| {
612 s.enable_dart = parse_bool("enable_dart", v)?;
613 Ok(())
614 },
615 },
616 Setting {
617 key: "enable_mix_build",
618 category: Category::BuildTrees,
619 since: "1.7.0",
620 kind: Kind::Toggle,
621 help: "Turn on the opt-in Elixir Mix build-tree adapter (_build/ comes back by recompiling).",
622 plain: "Elixir projects only. Mix is Elixir's build tool, and it compiles your project and every dependency into `_build/` — this cleans that folder. The downloaded `deps/` folder beside it belongs to a different adapter that is already on. Off by default, because `_build/` comes back by recompiling rather than by downloading.",
623 get: |s| s.enable_mix_build.to_string(),
624 set: |s, v| {
625 s.enable_mix_build = parse_bool("enable_mix_build", v)?;
626 Ok(())
627 },
628 },
629 Setting {
630 key: "enable_vcpkg",
631 category: Category::BuildTrees,
632 since: "1.8.0",
633 kind: Kind::Toggle,
634 help: "Turn on the opt-in vcpkg adapter (vcpkg_installed/ comes back by recompiling).",
635 plain: "Clean C and C++ vcpkg_installed/ folders too. They come back by recompiling.",
636 get: |s| s.enable_vcpkg.to_string(),
637 set: |s, v| {
638 s.enable_vcpkg = parse_bool("enable_vcpkg", v)?;
639 Ok(())
640 },
641 },
642 Setting {
643 key: "enable_cmake_build",
644 category: Category::BuildTrees,
645 since: "1.8.0",
646 kind: Kind::Toggle,
647 help: "Turn on the opt-in CMake adapter (build trees proven by their CMakeCache.txt).",
648 plain: "Clean C and C++ build folders CMake configured. A `build/` you made by hand is \
649 never touched.",
650 get: |s| s.enable_cmake_build.to_string(),
651 set: |s, v| {
652 s.enable_cmake_build = parse_bool("enable_cmake_build", v)?;
653 Ok(())
654 },
655 },
656 Setting {
657 key: "build_idle_days",
658 category: Category::BuildTrees,
659 since: "1.3.0",
660 kind: Kind::Number,
661 help: "Idle days before the opt-in adapters' build trees are pruned. Applied as max(this, idle_days).",
662 plain: "A longer wait, used only for the build folders above, because getting those back costs a recompile rather than a download.",
663 get: |s| s.build_idle_days.to_string(),
664 set: |s, v| {
665 let days: u64 = v
666 .parse()
667 .map_err(|_| anyhow::anyhow!("build_idle_days must be a non-negative integer"))?;
668 s.build_idle_days = days;
669 Ok(())
670 },
671 },
672 Setting {
673 key: "auto_update",
674 category: Category::Updates,
675 since: "1.3.0",
676 kind: Kind::Toggle,
677 help: "Install a newer release by itself at the end of a prune pass. On by default.",
678 plain: "Whether dev-prune installs its own updates after a cleanup. The download is checked against its published fingerprint first.",
679 get: |s| s.auto_update.to_string(),
680 set: |s, v| {
681 s.auto_update = parse_bool("auto_update", v)?;
682 Ok(())
683 },
684 },
685 Setting {
686 key: "version_lock",
687 category: Category::Updates,
688 since: "1.8.0",
689 kind: Kind::Toggle,
690 help: "Pin this copy to the version it is. Overrides auto_update, `devp update \
691 --install`, `devp install --channel` and the install scripts.",
692 plain: "Stay on exactly this version. Nothing dev-prune does replaces the binary \
693 while this is on -- not the automatic update, not a re-run of the install \
694 one-liner.",
695 get: |s| s.version_lock.to_string(),
696 set: |s, v| {
697 s.version_lock = parse_bool("version_lock", v)?;
698 Ok(())
699 },
700 },
701 Setting {
702 key: "disabled_adapters",
703 category: Category::Scope,
704 since: "1.4.0",
705 kind: Kind::Adapters,
706 help: "Adapters to leave alone entirely, by name. Empty means every one of them is active.",
707 plain: "Ecosystems to ignore completely — as if you did not have them installed at all.",
708 get: |s| {
709 if s.disabled_adapters.is_empty() {
710 "(none)".to_string()
711 } else {
712 s.disabled_adapters.join(",")
713 }
714 },
715 set: |s, v| {
716 s.disabled_adapters = parse_adapter_list(v)?;
717 Ok(())
718 },
719 },
720 Setting {
721 key: "adapter_idle_days",
722 category: Category::Scope,
723 since: "1.5.0",
724 kind: Kind::AdapterDays,
725 help: "Per-adapter idle windows, as `cargo=60,npm=30`. Each one can only raise its own wait.",
726 plain: "A different waiting period for one ecosystem. Useful when your Rust projects should wait longer than your Node ones.",
727 get: |s| {
728 if s.adapter_idle_days.is_empty() {
729 "(none)".to_string()
730 } else {
731 s.adapter_idle_days
732 .iter()
733 .map(|(name, days)| format!("{name}={days}"))
734 .collect::<Vec<_>>()
735 .join(",")
736 }
737 },
738 set: |s, v| {
739 s.adapter_idle_days = parse_adapter_days(v)?;
740 Ok(())
741 },
742 },
743 Setting {
744 key: "cache_max_gb",
745 category: Category::Caches,
746 since: "1.8.0",
747 kind: Kind::CacheCaps,
748 help: "Per-manager cache size caps in GiB, as `npm=10,uv=10`. Reported by `devp caches`; cleared only by `devp caches clear --over-cap`.",
749 plain: "How big one ecosystem's download cache is allowed to get before dev-prune says so. It still never deletes a cache on its own.",
750 get: |s| {
751 if s.cache_max_gb.is_empty() {
752 "(none)".to_string()
753 } else {
754 s.cache_max_gb
755 .iter()
756 .map(|(name, gb)| format!("{name}={gb}"))
757 .collect::<Vec<_>>()
758 .join(",")
759 }
760 },
761 set: |s, v| {
762 s.cache_max_gb = parse_cache_caps(v)?;
763 Ok(())
764 },
765 },
766];
767
768fn parse_cache_caps(value: &str) -> Result<std::collections::BTreeMap<String, u64>> {
785 let trimmed = value.trim();
786 if trimmed.is_empty() || matches!(trimmed.to_lowercase().as_str(), "none" | "(none)" | "-") {
787 return Ok(std::collections::BTreeMap::new());
788 }
789
790 let mut caps = std::collections::BTreeMap::new();
791 for raw in trimmed.split(',') {
792 let entry = raw.trim();
793 if entry.is_empty() {
794 continue;
795 }
796 let Some((name, value)) = entry.split_once('=') else {
797 bail!("`{entry}` must be written as `<manager>=<gib>`, for example `uv=10`.");
798 };
799 let name = name.trim().to_lowercase();
800 if !crate::commands::caches::is_cache_manager(&name) {
801 bail!(
802 "`{name}` is not a manager dev-prune knows a cache for. Valid names: {}",
803 crate::commands::caches::known_managers().join(", ")
804 );
805 }
806 let parsed: u64 = value.trim().parse().map_err(|_| {
807 anyhow::anyhow!(
808 "`{name}` needs a whole number of gibibytes, not `{}`.",
809 value.trim()
810 )
811 })?;
812 if parsed == 0 {
813 bail!(
814 "`{name}=0` would call the cache too big the moment it exists. Use `-` to clear the caps instead."
815 );
816 }
817 caps.insert(name, parsed);
818 }
819 Ok(caps)
820}
821
822fn parse_adapter_days(value: &str) -> Result<std::collections::BTreeMap<String, u64>> {
827 let trimmed = value.trim();
828 if trimmed.is_empty() || matches!(trimmed.to_lowercase().as_str(), "none" | "(none)" | "-") {
829 return Ok(std::collections::BTreeMap::new());
830 }
831
832 let mut days = std::collections::BTreeMap::new();
833 for raw in trimmed.split(',') {
834 let entry = raw.trim();
835 if entry.is_empty() {
836 continue;
837 }
838 let Some((name, value)) = entry.split_once('=') else {
839 bail!("`{entry}` must be written as `<adapter>=<days>`, for example `cargo=60`.");
840 };
841 let name = name.trim().to_lowercase();
842 if !crate::adapters::is_adapter_name(&name) {
843 bail!(
844 "`{name}` is not an adapter. Valid names: {}",
845 crate::adapters::all_adapter_names().join(", ")
846 );
847 }
848 let parsed: u64 = value.trim().parse().map_err(|_| {
849 anyhow::anyhow!(
850 "`{name}` needs a whole number of days, not `{}`.",
851 value.trim()
852 )
853 })?;
854 days.insert(name, parsed);
855 }
856 Ok(days)
857}
858
859fn parse_adapter_list(value: &str) -> Result<Vec<String>> {
860 let trimmed = value.trim();
861 if trimmed.is_empty() || matches!(trimmed.to_lowercase().as_str(), "none" | "(none)" | "-") {
864 return Ok(Vec::new());
865 }
866
867 let mut names: Vec<String> = Vec::new();
868 for raw in trimmed.split(',') {
869 let name = raw.trim().to_lowercase();
870 if name.is_empty() {
871 continue;
872 }
873 if !crate::adapters::is_adapter_name(&name) {
874 bail!(
875 "`{name}` is not an adapter. Valid names: {}",
876 crate::adapters::all_adapter_names().join(", ")
877 );
878 }
879 if !names.contains(&name) {
880 names.push(name);
881 }
882 }
883 Ok(names)
884}
885
886fn parse_bool(key: &str, value: &str) -> Result<bool> {
887 match value.trim().to_lowercase().as_str() {
888 "true" | "yes" | "y" | "on" | "1" => Ok(true),
889 "false" | "no" | "n" | "off" | "0" => Ok(false),
890 _ => bail!("{key} must be true or false"),
891 }
892}
893
894pub fn invalid_settings(settings: &Settings) -> Vec<(&'static str, String)> {
905 SETTINGS
906 .iter()
907 .filter_map(|setting| {
908 let mut probe = settings.clone();
909 (setting.set)(&mut probe, &(setting.get)(settings))
910 .err()
911 .map(|e| (setting.key, e.to_string()))
912 })
913 .collect()
914}
915
916pub fn setting_count() -> usize {
918 SETTINGS.len()
919}
920
921fn find_setting(key: &str) -> Result<&'static Setting> {
922 SETTINGS
923 .iter()
924 .find(|s| s.key == key)
925 .ok_or_else(|| anyhow::anyhow!("Unknown config key: {key}. Valid keys: {}", valid_keys()))
926}
927
928fn valid_keys() -> String {
929 SETTINGS
930 .iter()
931 .map(|s| s.key)
932 .collect::<Vec<_>>()
933 .join(", ")
934}
935
936#[derive(Debug, PartialEq, Eq)]
938pub enum Toggle {
939 Enable,
940 Disable,
941 Status,
942}
943
944pub fn parse_toggle(action: &str) -> Result<Toggle> {
954 match action.to_lowercase().as_str() {
955 "enable" | "install" | "on" => Ok(Toggle::Enable),
956 "disable" | "uninstall" | "remove" | "off" => Ok(Toggle::Disable),
957 "" | "status" | "show" => Ok(Toggle::Status),
958 other => bail!(
959 "Unknown action `{other}`. Expected `enable`, `disable` or `status` \
960 (`install` / `uninstall` / `on` / `off` also work)."
961 ),
962 }
963}
964
965pub fn is_toggle_word(word: &str) -> bool {
971 parse_toggle(word).is_ok() && !word.is_empty()
972}
973
974fn resolve_workspace(path: &str) -> Result<std::path::PathBuf> {
981 let raw = Path::new(path);
982 if !raw.is_dir() {
983 bail!(
984 "`{path}` is neither an action nor an existing directory.\n\
985 Expected `enable`, `disable` or `status`, or a path to a repository."
986 );
987 }
988 Ok(raw.canonicalize().unwrap_or_else(|_| raw.to_path_buf()))
989}
990
991pub fn run_get(key: &str) -> Result<()> {
993 let registry = Registry::load()?;
994 let setting = find_setting(key)?;
995 println!("{key} = {}", (setting.get)(®istry.settings));
996 Ok(())
997}
998
999pub fn run_set(key: &str, value: &str) -> Result<()> {
1001 let mut registry = Registry::load()?;
1002 let setting = find_setting(key)?;
1003 (setting.set)(&mut registry.settings, value)?;
1004 registry.save()?;
1005
1006 output::print_success(&format!("{key} = {}", (setting.get)(®istry.settings)));
1009
1010 if key == "language"
1014 && let Some(meta) = i18n::language(®istry.settings.language)
1015 && !meta.reviewed
1016 {
1017 output::print_info(&format!(
1018 "No native speaker has reviewed the {} translation yet. Corrections are welcome — see docs/TRANSLATIONS.md.",
1019 meta.english_name
1020 ));
1021 }
1022 Ok(())
1023}
1024
1025fn key_column_width() -> usize {
1027 SETTINGS.iter().map(|s| s.key.len()).max().unwrap_or(0)
1028}
1029
1030pub fn run_show() -> Result<()> {
1032 let registry = Registry::load()?;
1033 let width = key_column_width();
1034
1035 output::print_header("dev-prune Global Configuration");
1036 for (category, settings) in settings_by_category() {
1037 output::print_section(category.title());
1038 for setting in settings {
1039 println!(
1040 " {:<width$} = {}",
1041 setting.key,
1042 (setting.get)(®istry.settings)
1043 );
1044 }
1045 }
1046
1047 output::print_section("This machine");
1050 println!(
1051 " {:<width$} = {}",
1052 "tracked_repos",
1053 registry.repo_count()
1054 );
1055 let reg_path = Registry::registry_path()
1056 .map(|p| output::clean_path(&p))
1057 .unwrap_or_else(|_| "unknown".to_string());
1058 println!(" {:<width$} = {reg_path}", "registry_file");
1059
1060 print_recommendation_summary(®istry.settings);
1064
1065 println!();
1066 output::print_info("Change any of these with `devp config set <key> <value>`.");
1067 output::print_info("Walk through them one at a time with `devp config wizard`.");
1068
1069 Ok(())
1070}
1071
1072#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1074pub enum Opened {
1075 ByRequest,
1077 OnItsOwn,
1081}
1082
1083fn why_this_opened(opened: Opened) -> Option<String> {
1090 if opened == Opened::ByRequest {
1091 return None;
1092 }
1093 let new = settings_added_since_review().len();
1094 Some(if reviewed_version().is_none() || new == 0 {
1095 "You did not ask for this screen. dev-prune opens it once, on the first command \
1096 after it is installed, so that you see what its defaults do before they start \
1097 doing it. Whatever you typed runs as soon as you leave. It will not open by \
1098 itself again unless an upgrade adds a setting."
1099 .to_string()
1100 } else {
1101 format!(
1102 "You did not ask for this screen. This upgrade added {new} {}, and dev-prune \
1103 shows a new one once before its default goes on applying. Nothing else about \
1104 your configuration changed. Whatever you typed runs as soon as you leave.",
1105 output::plural(new, "setting", "settings"),
1106 )
1107 })
1108}
1109
1110pub fn run_wizard(no_tui: bool, opened: Opened) -> Result<()> {
1121 if !no_tui && full_screen_is_usable() {
1122 return run_wizard_tui(opened);
1123 }
1124 run_wizard_prompts(opened)
1125}
1126
1127fn full_screen_is_usable() -> bool {
1135 use std::io::IsTerminal;
1136 if std::env::var_os(crate::constants::ENV_NO_TUI).is_some() {
1137 return false;
1138 }
1139 std::io::stdin().is_terminal() && std::io::stdout().is_terminal()
1140}
1141
1142fn run_wizard_tui(opened: Opened) -> Result<()> {
1144 use crate::tui::config_view::{ConfigRow, ConfigSession, Control, Outcome};
1145
1146 let mut registry = Registry::load()?;
1147 let new_keys = settings_added_since_review();
1148 let fresh = Settings::default();
1152
1153 let rows: Vec<ConfigRow> = settings_by_category()
1156 .into_iter()
1157 .flat_map(|(category, settings)| {
1158 settings.into_iter().map(move |setting| (category, setting))
1159 })
1160 .map(|(category, setting)| {
1161 let value = (setting.get)(®istry.settings);
1162 ConfigRow {
1163 key: setting.key,
1164 category: category.title(),
1165 help: setting.help,
1166 plain: setting.plain,
1167 control: match setting.kind {
1168 Kind::Toggle => Control::Toggle,
1169 Kind::Choice => Control::Choice(i18n::choices()),
1170 Kind::Number => Control::Number,
1171 Kind::Adapters => Control::Adapters,
1172 Kind::AdapterDays => Control::AdapterDays,
1173 Kind::CacheCaps => Control::CacheCaps,
1174 },
1175 original: value.clone(),
1176 default: (setting.get)(&fresh),
1177 recommended: recommended_value(setting.key),
1178 value,
1179 is_new: new_keys.contains(&setting.key),
1180 }
1181 })
1182 .collect();
1183
1184 let base = registry.settings.clone();
1187 let validate = move |key: &str, value: &str| -> std::result::Result<(), String> {
1188 let setting = find_setting(key).map_err(|e| e.to_string())?;
1189 let mut probe = base.clone();
1190 (setting.set)(&mut probe, value).map_err(|e| format!("{e}"))
1191 };
1192
1193 let report = crate::commands::trust::build(®istry);
1194 let adapters = crate::adapters::all_adapter_names();
1195 let opt_in = crate::adapters::opt_in_adapter_names();
1196 let capped: Vec<&'static str> = adapters
1199 .iter()
1200 .copied()
1201 .filter(|name| crate::commands::caches::is_cache_manager(name))
1202 .collect();
1203
1204 let why = why_this_opened(opened);
1205 let outcome = crate::tui::config_view::run(ConfigSession {
1206 declaration: declaration_lines(&report),
1207 standing: NOTHING_DELETED_YET.to_string(),
1208 suggestions: first_run_suggestions(),
1209 rows,
1210 adapters: &adapters,
1211 opt_in_adapters: &opt_in,
1212 capped_adapters: &capped,
1213 groups: crate::adapters::ADAPTER_GROUPS,
1214 validate: &validate,
1215 title: "dev-prune configuration",
1216 uninvited: why.as_deref(),
1217 })?;
1218
1219 match outcome {
1220 Outcome::Cancelled => {
1224 output::print_info("Cancelled — nothing was changed.");
1225 Ok(())
1226 }
1227 Outcome::KeepAll => {
1228 mark_reviewed();
1229 output::print_success(
1230 "Keeping the current values. `devp config set <key> <value>` changes any.",
1231 );
1232 Ok(())
1233 }
1234 Outcome::Save(changed) => {
1235 for row in &changed {
1236 (find_setting(row.key)?.set)(&mut registry.settings, &row.value)?;
1237 }
1238 registry.save()?;
1239 mark_reviewed();
1240
1241 output::print_header("Saved");
1245 let width = changed.iter().map(|r| r.key.len()).max().unwrap_or(0);
1246 for row in &changed {
1247 println!(
1248 " {:<width$} = {} (was {})",
1249 row.key, row.value, row.original
1250 );
1251 }
1252 println!();
1253 output::print_success(&format!(
1254 "{} {} saved. `devp config show` lists every setting.",
1255 changed.len(),
1256 output::plural(changed.len(), "change", "changes")
1257 ));
1258 Ok(())
1259 }
1260 }
1261}
1262
1263fn recommended_value(key: &str) -> Option<&'static str> {
1280 recommendation(key).map(|r| r.value)
1281}
1282
1283fn recommendation(key: &str) -> Option<&'static Recommendation> {
1285 RECOMMENDED.iter().find(|r| r.key == key)
1286}
1287
1288fn outstanding(settings: &Settings) -> Vec<&'static Recommendation> {
1290 RECOMMENDED
1291 .iter()
1292 .filter(|r| {
1293 find_setting(r.key)
1294 .map(|s| (s.get)(settings))
1295 .ok()
1296 .as_deref()
1297 != Some(r.value)
1298 })
1299 .collect()
1300}
1301
1302fn print_recommendation_summary(settings: &Settings) {
1309 let outstanding = outstanding(settings);
1310 if outstanding.is_empty() {
1311 return;
1312 }
1313 let width = key_column_width();
1314
1315 let safe: Vec<_> = outstanding.iter().filter(|r| !r.cautious).collect();
1316 if !safe.is_empty() {
1317 output::print_section(SAFE_TIER);
1318 for r in &safe {
1319 println!(" {:<width$} = {} {}", r.key, r.value, r.label);
1320 }
1321 println!();
1322 output::print_info(&format!(
1323 "`devp config recommended` sets {} {} in one command.",
1324 safe.len(),
1325 output::plural(safe.len(), "setting", "settings")
1326 ));
1327 }
1328
1329 let cautious: Vec<_> = outstanding.iter().filter(|r| r.cautious).collect();
1330 if !cautious.is_empty() {
1331 output::print_section(CAUTIOUS_TIER);
1332 for r in &cautious {
1333 println!(" {:<width$} = {} {}", r.key, r.value, r.label);
1334 println!(" {:<width$} {}", "", r.why);
1335 }
1336 println!();
1337 output::print_info(
1338 "Not included above. `devp config recommended --with-cautious` includes it; \
1339 `devp config set <key> <value>` sets one on its own.",
1340 );
1341 }
1342}
1343
1344pub fn run_recommended(with_cautious: bool) -> Result<()> {
1358 let mut registry = Registry::load()?;
1359 let width = key_column_width();
1360
1361 output::print_header("dev-prune recommended settings");
1362
1363 let mut applied: Vec<(&'static str, String, &'static str)> = Vec::new();
1364 let mut already: Vec<&'static Recommendation> = Vec::new();
1365 let mut held_back: Vec<&'static Recommendation> = Vec::new();
1366
1367 for rec in RECOMMENDED {
1368 let setting = find_setting(rec.key)?;
1369 let current = (setting.get)(®istry.settings);
1370 if current == rec.value {
1371 already.push(rec);
1372 } else if rec.cautious && !with_cautious {
1373 held_back.push(rec);
1374 } else {
1375 (setting.set)(&mut registry.settings, rec.value)?;
1376 applied.push((rec.key, current, rec.value));
1377 }
1378 }
1379
1380 if !applied.is_empty() {
1381 registry.save()?;
1382 output::print_section("Turned on");
1383 for (key, from, to) in &applied {
1384 println!(" {:<width$} {from} → {to}", key);
1385 }
1386 }
1387 if !already.is_empty() {
1388 output::print_section("Already set");
1389 for rec in &already {
1390 println!(" {:<width$} {}", rec.key, rec.label);
1391 }
1392 }
1393 if !held_back.is_empty() {
1394 output::print_section(CAUTIOUS_TIER);
1395 for rec in &held_back {
1396 println!(" {:<width$} = {} {}", rec.key, rec.value, rec.label);
1397 println!(" {:<width$} {}", "", rec.why);
1398 }
1399 println!();
1400 output::print_info(
1401 "Left alone. `devp config recommended --with-cautious` includes it; \
1402 `devp config set <key> <value>` sets one on its own.",
1403 );
1404 }
1405
1406 println!();
1407 if applied.is_empty() {
1408 output::print_success(
1409 "Nothing changed — everything recommended without a caveat is already set.",
1410 );
1411 } else {
1412 output::print_success(&format!(
1413 "{} {} changed. `devp config show` lists them all.",
1414 applied.len(),
1415 output::plural(applied.len(), "setting", "settings")
1416 ));
1417 }
1418 Ok(())
1419}
1420
1421fn first_run_suggestions() -> Vec<crate::tui::config_view::Suggestion> {
1422 use crate::tui::config_view::Suggestion;
1423
1424 if reviewed_version().is_some() {
1425 return Vec::new();
1426 }
1427 RECOMMENDED
1428 .iter()
1429 .filter_map(|r| {
1430 let setting = find_setting(r.key).ok()?;
1431 Some(Suggestion {
1432 key: r.key,
1433 label: r.label,
1434 help: setting.help,
1435 plain: setting.plain,
1436 why: r.why,
1437 value: r.value,
1438 cautious: r.cautious,
1439 })
1440 })
1441 .collect()
1442}
1443
1444const NOTHING_DELETED_YET: &str =
1446 "Nothing has been deleted, and nothing will be until a lockfile proves it comes back.";
1447
1448fn provenance_rows() -> Vec<(&'static str, String)> {
1465 let url = |u: &str| u.trim_start_matches("https://").to_string();
1468 vec![
1469 (
1470 "What you are running",
1471 format!(
1472 "{} v{}",
1473 crate::constants::APP_NAME,
1474 crate::constants::VERSION
1475 ),
1476 ),
1477 (
1478 "Written by",
1479 format!("{}, under Apache-2.0", crate::constants::AUTHOR),
1480 ),
1481 ("Source code", url(crate::constants::REPO_URL)),
1482 (
1483 "Official downloads",
1484 format!("{} · GitHub releases", url(crate::constants::HOMEPAGE_URL)),
1485 ),
1486 (
1487 "Package registries",
1488 "crates.io · PyPI · npm, all named dev-prune".to_string(),
1489 ),
1490 (
1491 "Editor extension",
1492 "VS Code Marketplace · Open VSX".to_string(),
1493 ),
1494 (
1495 "Any other source",
1496 "is not a copy the author published".to_string(),
1497 ),
1498 ]
1499}
1500
1501fn declaration_lines(
1507 report: &crate::commands::trust::TrustReport,
1508) -> Vec<crate::tui::config_view::DeclarationLine> {
1509 use crate::commands::trust::{TrustRow, Verdict};
1510 use crate::tui::config_view::DeclarationLine;
1511
1512 let heading = |text: &str| DeclarationLine {
1513 mark: '#',
1514 subject: text.to_string(),
1515 state: String::new(),
1516 };
1517 let row = |r: &TrustRow| DeclarationLine {
1518 mark: match r.verdict {
1519 Verdict::Guaranteed | Verdict::Safe => '+',
1520 Verdict::Widened => '!',
1521 Verdict::Neutral => ' ',
1522 },
1523 subject: r.subject.to_string(),
1524 state: r.state.clone(),
1525 };
1526
1527 let mut lines = vec![heading("What this is, and where it came from")];
1528 lines.extend(
1529 provenance_rows()
1530 .into_iter()
1531 .map(|(subject, state)| DeclarationLine {
1532 mark: ' ',
1533 subject: subject.to_string(),
1534 state,
1535 }),
1536 );
1537 lines.push(heading(""));
1538 lines.push(heading("Guaranteed by the code"));
1539 lines.extend(report.guarantees.iter().map(&row));
1540 lines.push(heading(""));
1541 lines.push(heading("On this machine"));
1542 lines.extend(report.machine.iter().map(&row));
1543 lines
1544}
1545
1546fn run_wizard_prompts(opened: Opened) -> Result<()> {
1550 use std::io::{self, IsTerminal, Write};
1551
1552 if !io::stdin().is_terminal() {
1553 bail!(
1554 "`devp config wizard` needs a terminal to ask questions on.\n\
1555 Use `devp config show` to read the settings and `devp config set <key> <value>` \
1556 to change one."
1557 );
1558 }
1559
1560 let mut registry = Registry::load()?;
1561 let width = key_column_width();
1562 let new_keys = settings_added_since_review();
1563 let fresh = Settings::default();
1564
1565 output::print_header("dev-prune configuration");
1566 if let Some(why) = why_this_opened(opened) {
1569 output::print_warning(&why);
1570 println!();
1571 }
1572 output::print_section("What this is, and where it came from");
1573 for (subject, state) in provenance_rows() {
1574 println!(" {} {state}", output::pad_display(subject, 22));
1575 }
1576 println!(" {}", crate::constants::LICENCE_NOTICE);
1577 println!();
1578
1579 output::print_info("These are the defaults every run will use. Nothing has been changed yet.");
1580 println!();
1581 for (category, settings) in settings_by_category() {
1582 output::print_section(category.title());
1583 for setting in settings {
1584 let badge = if new_keys.contains(&setting.key) {
1587 " (new in this version)"
1588 } else {
1589 ""
1590 };
1591 println!(
1592 " {:<width$} = {}{badge}",
1593 setting.key,
1594 (setting.get)(®istry.settings)
1595 );
1596 println!(" {:<width$} {}", "", setting.help);
1597 println!(" {:<width$} {}", "", setting.plain);
1600 let mut facts = format!("default {}", (setting.get)(&fresh));
1604 if let Some(rec) = recommendation(setting.key) {
1608 facts.push_str(&format!(
1609 " · recommended {} ({}, not required)",
1610 rec.value,
1611 if rec.cautious {
1612 "read the note below first"
1613 } else {
1614 "suggested"
1615 }
1616 ));
1617 }
1618 println!(" {:<width$} {facts}", "");
1619 if let Some(rec) = recommendation(setting.key).filter(|r| r.cautious) {
1620 println!(" {:<width$} {}", "", rec.why);
1621 }
1622 }
1623 }
1624 println!();
1625
1626 print_recommendation_summary(®istry.settings);
1627 println!();
1628
1629 if confirmed_twice("Press Enter twice to keep all of these, or type anything to change them: ")?
1632 {
1633 mark_reviewed();
1634 output::print_success("Keeping the defaults. `devp config set <key> <value>` changes any.");
1635 return Ok(());
1636 }
1637
1638 println!();
1639 output::print_info("Enter a new value, or press Enter to keep the one shown.");
1640 println!();
1641
1642 let mut edits: Vec<(&'static str, String, String)> = Vec::new();
1643 for setting in SETTINGS {
1644 let current = (setting.get)(®istry.settings);
1645 loop {
1646 print!(" {} [{current}]: ", setting.key);
1647 io::stdout().flush()?;
1648 let mut line = String::new();
1649 if io::stdin().read_line(&mut line)? == 0 {
1652 println!();
1653 break;
1654 }
1655 let typed = line.trim();
1656 if typed.is_empty() {
1657 break;
1658 }
1659 match (setting.set)(&mut registry.settings, typed) {
1660 Ok(()) => {
1661 let now = (setting.get)(®istry.settings);
1665 if now != current {
1666 edits.push((setting.key, current.clone(), now));
1667 }
1668 break;
1669 }
1670 Err(e) => output::print_error(&format!("{e}")),
1673 }
1674 }
1675 }
1676
1677 println!();
1678 if edits.is_empty() {
1679 mark_reviewed();
1680 output::print_success("Nothing changed — the defaults are in place.");
1681 return Ok(());
1682 }
1683
1684 output::print_section("About to be saved");
1687 for (key, from, to) in &edits {
1688 println!(" {:<width$} {from} → {to}", key);
1689 }
1690 println!();
1691 if !confirmed_twice("Press Enter twice to save, or type anything to abandon: ")? {
1692 output::print_info("Nothing was written.");
1693 return Ok(());
1694 }
1695
1696 registry.save()?;
1697 mark_reviewed();
1698 let changed = edits.len();
1699 println!();
1700 output::print_success(&format!(
1701 "Saved {changed} {}. `devp config show` lists them all.",
1702 output::plural(changed, "change", "changes")
1703 ));
1704 Ok(())
1705}
1706
1707fn confirmed_twice(prompt: &str) -> Result<bool> {
1713 use std::io::{self, Write};
1714
1715 for pass in 0..2 {
1716 print!(
1717 "{}",
1718 if pass == 0 {
1719 prompt
1720 } else {
1721 "Press Enter once more to confirm: "
1722 }
1723 );
1724 io::stdout().flush()?;
1725 let mut line = String::new();
1726 if io::stdin().read_line(&mut line)? == 0 {
1727 println!();
1728 return Ok(false);
1729 }
1730 if !line.trim().is_empty() {
1731 return Ok(false);
1732 }
1733 }
1734 Ok(true)
1735}
1736
1737const REVIEW_MARKER: &str = "config-reviewed";
1739
1740pub fn config_review_is_due() -> bool {
1749 let Ok(dir) = Registry::config_dir() else {
1750 return false;
1751 };
1752 if !dir.join(REVIEW_MARKER).exists() {
1753 return true;
1754 }
1755 !settings_added_since_review().is_empty()
1756}
1757
1758fn reviewed_version() -> Option<String> {
1760 let dir = Registry::config_dir().ok()?;
1761 let recorded = std::fs::read_to_string(dir.join(REVIEW_MARKER)).ok()?;
1762 let recorded = recorded.trim().to_string();
1763 (!recorded.is_empty()).then_some(recorded)
1764}
1765
1766pub fn settings_added_since_review() -> Vec<&'static str> {
1775 let Some(reviewed) = reviewed_version() else {
1776 return Vec::new();
1777 };
1778 SETTINGS
1779 .iter()
1780 .filter(|s| {
1781 crate::commands::update::compare_versions(s.since, &reviewed)
1782 == Some(std::cmp::Ordering::Greater)
1783 })
1784 .map(|s| s.key)
1785 .collect()
1786}
1787
1788fn mark_reviewed() {
1789 if let Ok(dir) = Registry::config_dir() {
1790 let _ = std::fs::create_dir_all(&dir);
1791 let _ = std::fs::write(dir.join(REVIEW_MARKER), crate::constants::VERSION);
1792 }
1793}
1794
1795pub fn skip_config_review() {
1800 mark_reviewed();
1801}
1802
1803pub fn run_global_update() -> Result<()> {
1805 output::print_header("dev-prune Global Configuration Audit & Sync");
1806
1807 let registry = Registry::load()?;
1808 let mut total_audited = 0;
1809 let mut errors_found = 0;
1810
1811 for repo_path in registry.repositories.keys() {
1812 let clean = output::clean_path(repo_path);
1813
1814 if !repo_path.exists() {
1818 output::print_warning(&format!(
1819 "Skipped {clean} — the path no longer exists. `devp unlink --missing` \
1820 clears such entries."
1821 ));
1822 continue;
1823 }
1824 total_audited += 1;
1825
1826 match PerRepoConfig::load_personal_for_write(repo_path) {
1827 Ok(Some(cfg)) => {
1828 if let Err(e) = cfg.save_to_repo(repo_path) {
1829 output::print_error(&format!("Failed to write config for {clean}: {e}"));
1830 errors_found += 1;
1831 } else {
1832 output::print_success(&format!("Audited & synced config for {clean}"));
1833 }
1834 }
1835 Ok(None) => {
1836 output::print_info(&format!(
1840 "{clean} has no .devprune.json — global defaults apply."
1841 ));
1842 }
1843 Err(err_msg) => {
1844 errors_found += 1;
1845 output::print_error(&format!("Syntax/Schema Error in {clean}:"));
1846 for line in err_msg.lines() {
1847 eprintln!(" {line}");
1848 }
1849 output::print_info(&format!(
1850 "Hint: fix the syntax by hand, or run `devp config {clean} --update` to \
1851 replace the file with a valid default."
1852 ));
1853 }
1854 }
1855 }
1856
1857 if errors_found > 0 {
1858 anyhow::bail!(
1861 "Audit complete: {total_audited} repos checked, {errors_found} could not be read \
1862 or written."
1863 );
1864 }
1865 output::print_success(&format!(
1866 "Audit complete: All {total_audited} registered repositories are healthy & synced!"
1867 ));
1868
1869 Ok(())
1870}
1871
1872pub fn run_path_config(path_str: &str, force_update: bool, team: bool) -> Result<()> {
1877 let raw_path = Path::new(path_str);
1878
1879 let path = if raw_path.exists() {
1880 raw_path
1881 .canonicalize()
1882 .unwrap_or_else(|_| raw_path.to_path_buf())
1883 } else {
1884 raw_path.to_path_buf()
1885 };
1886
1887 let clean = output::clean_path(&path);
1888
1889 if !path.exists() {
1890 bail!("Path does not exist: {clean}");
1891 }
1892
1893 if !crate::scanner::is_git_repo(&path) {
1894 bail!(
1896 "`{clean}` is not a Git repository.\n \
1897 Run `git init` there first, then `devp config {clean}` again."
1898 );
1899 }
1900
1901 let mut registry = Registry::load()?;
1902 if !registry.repositories.contains_key(&path) {
1903 output::print_info(&format!(
1904 "{clean} is not yet registered with dev-prune. Registering now..."
1905 ));
1906 registry.add_repo(path.clone());
1907 registry.save()?;
1908 }
1909
1910 let name = if team {
1911 crate::constants::PROJECT_REPO_CONFIG_FILE
1912 } else {
1913 crate::constants::PER_REPO_CONFIG_FILE
1914 };
1915 let cfg_file = path.join(name);
1916
1917 if cfg_file.exists() && !force_update {
1918 output::print_header(&format!("dev-prune Per-Repo Config for {clean}"));
1919 match crate::config::RepoConfigLayers::load(&path) {
1920 Ok(layers) => {
1921 let addressed = if team {
1922 layers.project_config()
1923 } else {
1924 layers.personal_config()
1925 };
1926 println!("{}", serde_json::to_string_pretty(&addressed)?);
1927 output::print_info(&format!("File location: {name}"));
1928 print_layer_provenance(&layers);
1929 }
1930 Err(err_msg) => {
1931 output::print_error(&format!("Invalid configuration in {clean}:"));
1932 for line in err_msg.lines() {
1933 eprintln!(" {line}");
1934 }
1935 anyhow::bail!(
1938 "Run `devp config {clean} --update` to reset this file back to defaults \
1939 (your current overrides in it are discarded)."
1940 );
1941 }
1942 }
1943 } else {
1944 output::print_info(&format!("Initializing {name} for {clean}..."));
1945 if team {
1946 crate::config::write_project_starter(&path)?;
1947 } else {
1948 PerRepoConfig::default().save_to_repo(&path)?;
1949 }
1950 output::print_success(&format!("Created {name} in {clean}"));
1951 if team {
1952 output::print_info(
1953 "It starts empty on purpose: every key it names overrules \
1954 `.devprune.json`, so it should only name the ones your team decides.",
1955 );
1956 output::print_info(
1957 "`prunable.directories` is the exception — the two files' lists add \
1958 up, so naming one here never discards somebody's own.",
1959 );
1960 output::print_info(
1961 "Commit it. Unlike `.devprune.json`, this file is not added to \
1962 `.git/info/exclude` — being shared is the whole reason it exists.",
1963 );
1964 }
1965 }
1966
1967 Ok(())
1968}
1969
1970fn print_layer_provenance(layers: &crate::config::RepoConfigLayers) {
1978 if layers.project_config().is_none() || layers.personal_config().is_none() {
1979 return;
1980 }
1981 output::print_section("Effective values");
1982 for (key, value, source) in layers.rows() {
1983 println!(
1984 " {} {} {}",
1985 output::pad_display(key, 20),
1986 output::pad_display(&value, 14),
1987 source.label()
1988 );
1989 }
1990}
1991
1992fn load_workspace_config_for_write(repo_path: &Path) -> Result<PerRepoConfig> {
1998 match PerRepoConfig::load_personal_for_write(repo_path) {
1999 Ok(Some(cfg)) => Ok(cfg),
2000 Ok(None) => Ok(PerRepoConfig::default()),
2001 Err(e) => bail!(
2002 "{e}\n \
2003 Fix that file, or run `devp config {} --update` to reset it back to defaults \
2004 (your current overrides in it are discarded).",
2005 output::clean_path(repo_path)
2006 ),
2007 }
2008}
2009
2010pub fn run_daemon_toggle(path: Option<&str>, action: &str) -> Result<()> {
2012 if let Some(p) = path {
2013 let repo_path = resolve_workspace(p)?;
2014 let mut cfg = load_workspace_config_for_write(&repo_path)?;
2015 match parse_toggle(action)? {
2016 Toggle::Enable => {
2017 cfg.disable_daemon = false;
2018 cfg.save_to_repo(&repo_path)?;
2019 output::print_success(&format!(
2020 "Enabled background daemon for workspace: {}",
2021 output::clean_path(&repo_path)
2022 ));
2023 }
2024 Toggle::Disable => {
2025 cfg.disable_daemon = true;
2026 cfg.save_to_repo(&repo_path)?;
2027 output::print_success(&format!(
2028 "Disabled background daemon for workspace: {}",
2029 output::clean_path(&repo_path)
2030 ));
2031 }
2032 Toggle::Status => {
2033 let st = if cfg.disable_daemon {
2034 "Disabled for workspace"
2035 } else {
2036 "Enabled for workspace"
2037 };
2038 output::print_info(&format!(
2039 "Daemon Status ({}): {}",
2040 output::clean_path(&repo_path),
2041 st
2042 ));
2043 }
2044 }
2045 } else {
2046 match parse_toggle(action)? {
2047 Toggle::Enable => crate::commands::daemon::run_install()?,
2048 Toggle::Disable => crate::commands::daemon::run_uninstall()?,
2049 Toggle::Status => crate::commands::daemon::run_status()?,
2050 }
2051 }
2052 Ok(())
2053}
2054
2055pub fn run_hook_toggle(path: Option<&str>, action: &str, chain: bool) -> Result<()> {
2057 if let Some(p) = path {
2058 if chain {
2059 bail!(
2060 "`--chain` changes the single global `core.hooksPath`, so it has no \
2061 per-workspace form. Drop the path: `devp hook install --chain`."
2062 );
2063 }
2064 let repo_path = resolve_workspace(p)?;
2065 let mut cfg = load_workspace_config_for_write(&repo_path)?;
2066 match parse_toggle(action)? {
2067 Toggle::Enable => {
2068 cfg.disable_hooks = false;
2069 cfg.save_to_repo(&repo_path)?;
2070 output::print_success(&format!(
2071 "Enabled background Git hooks for workspace: {}",
2072 output::clean_path(&repo_path)
2073 ));
2074 }
2075 Toggle::Disable => {
2076 cfg.disable_hooks = true;
2077 cfg.save_to_repo(&repo_path)?;
2078 output::print_success(&format!(
2079 "Disabled background Git hooks for workspace: {}",
2080 output::clean_path(&repo_path)
2081 ));
2082 }
2083 Toggle::Status => {
2084 let st = if cfg.disable_hooks {
2085 "Disabled for workspace"
2086 } else {
2087 "Enabled for workspace"
2088 };
2089 output::print_info(&format!(
2090 "Git Hook Status ({}): {}",
2091 output::clean_path(&repo_path),
2092 st
2093 ));
2094 }
2095 }
2096 } else {
2097 match parse_toggle(action)? {
2098 Toggle::Enable => crate::commands::hook::run_install(chain)?,
2099 Toggle::Disable => crate::commands::hook::run_uninstall()?,
2100 Toggle::Status => crate::commands::hook::run_status()?,
2101 }
2102 }
2103 Ok(())
2104}
2105
2106#[cfg(test)]
2107mod tests {
2108 use super::*;
2109
2110 #[test]
2111 fn enable_synonyms_all_resolve_to_enable() {
2112 for word in ["enable", "install", "on", "INSTALL", "On"] {
2113 assert_eq!(parse_toggle(word).unwrap(), Toggle::Enable, "{word}");
2114 }
2115 }
2116
2117 #[test]
2118 fn disable_synonyms_all_resolve_to_disable() {
2119 for word in ["disable", "uninstall", "remove", "off", "Uninstall"] {
2120 assert_eq!(parse_toggle(word).unwrap(), Toggle::Disable, "{word}");
2121 }
2122 }
2123
2124 #[test]
2125 fn status_is_the_default_and_is_also_spellable() {
2126 for word in ["", "status", "show"] {
2127 assert_eq!(parse_toggle(word).unwrap(), Toggle::Status, "{word}");
2128 }
2129 }
2130
2131 #[test]
2132 fn a_typo_is_an_error_rather_than_a_silent_status_report() {
2133 let err = parse_toggle("enabel").unwrap_err().to_string();
2136 assert!(err.contains("enabel"), "{err}");
2137 assert!(err.contains("enable"), "{err}");
2138 }
2139
2140 #[test]
2141 fn a_workspace_toggle_refuses_to_write_over_a_broken_config() {
2142 let tmp = tempfile::TempDir::new().unwrap();
2145 let broken = r#"{ "project_name": "api", "override_idle_days": 90, }"#;
2146 std::fs::write(
2147 tmp.path().join(crate::constants::PER_REPO_CONFIG_FILE),
2148 broken,
2149 )
2150 .unwrap();
2151
2152 let err = load_workspace_config_for_write(tmp.path())
2153 .unwrap_err()
2154 .to_string();
2155 assert!(err.contains("Syntax error"), "{err}");
2156 assert!(err.contains("--update"), "{err}");
2157
2158 let on_disk =
2160 std::fs::read_to_string(tmp.path().join(crate::constants::PER_REPO_CONFIG_FILE))
2161 .unwrap();
2162 assert_eq!(on_disk, broken);
2163 }
2164
2165 #[test]
2166 fn a_workspace_with_no_config_yet_starts_from_the_defaults() {
2167 let tmp = tempfile::TempDir::new().unwrap();
2168 assert_eq!(
2169 load_workspace_config_for_write(tmp.path()).unwrap(),
2170 PerRepoConfig::default()
2171 );
2172 }
2173
2174 #[test]
2175 fn a_cache_cap_is_written_the_way_it_is_read_back() {
2176 let caps = parse_cache_caps("uv=10,npm=4").unwrap();
2177 assert_eq!(caps.get("uv"), Some(&10));
2178 assert_eq!(caps.get("npm"), Some(&4));
2179 let settings = Settings {
2182 cache_max_gb: parse_cache_caps("UV = 10 , npm=4").unwrap(),
2183 ..Settings::default()
2184 };
2185 let printed = SETTINGS
2186 .iter()
2187 .find(|s| s.key == "cache_max_gb")
2188 .map(|s| (s.get)(&settings))
2189 .unwrap();
2190 assert_eq!(printed, "npm=4,uv=10");
2191 assert_eq!(parse_cache_caps(&printed).unwrap(), settings.cache_max_gb);
2192 }
2193
2194 #[test]
2195 fn clearing_the_caps_is_spelled_the_way_the_getter_prints_an_empty_map() {
2196 for blank in ["", "-", "none", "(none)", "NONE"] {
2197 assert!(
2198 parse_cache_caps(blank).unwrap().is_empty(),
2199 "`{blank}` should clear every cap"
2200 );
2201 }
2202 }
2203
2204 #[test]
2205 fn a_cap_on_something_that_is_not_a_cache_is_refused_with_the_list() {
2206 let err = parse_cache_caps("venv=10").unwrap_err().to_string();
2209 assert!(err.contains("venv"), "{err}");
2210 assert!(err.contains("npm"), "the error lists what is valid: {err}");
2211 }
2212
2213 #[test]
2214 fn a_cap_has_to_be_a_whole_number_of_gibibytes() {
2215 for bad in ["uv=10.5", "uv=ten", "uv=-1", "uv="] {
2216 assert!(parse_cache_caps(bad).is_err(), "`{bad}` was accepted");
2217 }
2218 assert!(parse_cache_caps("uv").is_err());
2221 }
2222
2223 #[test]
2224 fn a_cap_of_zero_is_refused_rather_than_stored() {
2225 let err = parse_cache_caps("uv=0").unwrap_err().to_string();
2228 assert!(
2229 err.contains("`-`"),
2230 "the error names the way to clear it: {err}"
2231 );
2232 }
2233
2234 #[test]
2235 fn every_setting_round_trips_through_its_own_getter() {
2236 let mut settings = Settings::default();
2240 for setting in SETTINGS {
2241 let before = (setting.get)(&settings);
2242 let probe = match setting.kind {
2243 Kind::Toggle => if before == "true" { "false" } else { "true" }.to_string(),
2244 Kind::Number => "7".to_string(),
2247 Kind::Adapters => "cargo".to_string(),
2250 Kind::AdapterDays => "cargo=45".to_string(),
2253 Kind::CacheCaps => "cargo=10".to_string(),
2256 Kind::Choice => "hi".to_string(),
2259 };
2260 (setting.set)(&mut settings, &probe)
2261 .unwrap_or_else(|e| panic!("{} rejected `{probe}`: {e}", setting.key));
2262 assert_eq!(
2263 (setting.get)(&settings),
2264 probe,
2265 "{} reads back a different field than it writes",
2266 setting.key
2267 );
2268 }
2269 }
2270
2271 #[test]
2272 fn every_setting_is_documented_and_uniquely_named() {
2273 let mut seen = std::collections::HashSet::new();
2274 for setting in SETTINGS {
2275 assert!(seen.insert(setting.key), "duplicate key {}", setting.key);
2276 assert!(!setting.help.is_empty(), "{} has no help", setting.key);
2277 assert!(
2278 !setting.plain.is_empty(),
2279 "{} has no plain text",
2280 setting.key
2281 );
2282 assert!(
2284 setting.help.ends_with('.'),
2285 "{} help should read as a sentence",
2286 setting.key
2287 );
2288 assert!(
2289 setting.plain.ends_with('.'),
2290 "{} plain text should read as a sentence",
2291 setting.key
2292 );
2293 assert_ne!(
2296 setting.plain, setting.help,
2297 "{} says the same thing twice",
2298 setting.key
2299 );
2300 }
2301 }
2302
2303 #[test]
2304 fn the_settings_table_covers_every_field_of_settings() {
2305 let json = serde_json::to_value(Settings::default()).unwrap();
2309 let fields: Vec<String> = json.as_object().unwrap().keys().cloned().collect();
2310 for field in fields {
2311 assert!(
2312 SETTINGS.iter().any(|s| s.key == field),
2313 "`{field}` is a setting with no entry in SETTINGS, so `devp config set \
2314 {field}` cannot reach it"
2315 );
2316 }
2317 }
2318
2319 #[test]
2320 fn a_rejected_value_leaves_the_previous_one_in_place() {
2321 let mut settings = Settings::default();
2322 assert!((find_setting("scan_depth").unwrap().set)(&mut settings, "0").is_err());
2323 assert_eq!(settings.scan_depth, Settings::default().scan_depth);
2324
2325 assert!((find_setting("command_timeout_secs").unwrap().set)(&mut settings, "0").is_err());
2326 assert!((find_setting("check_interval_days").unwrap().set)(&mut settings, "0").is_err());
2327 assert!(
2328 (find_setting("update_check_interval_days").unwrap().set)(&mut settings, "0").is_err()
2329 );
2330 }
2331
2332 #[test]
2333 fn booleans_accept_the_words_people_actually_type() {
2334 assert!(parse_bool("k", "yes").unwrap());
2335 assert!(parse_bool("k", "ON").unwrap());
2336 assert!(!parse_bool("k", "0").unwrap());
2337 assert!(parse_bool("k", "maybe").is_err());
2338 }
2339
2340 #[test]
2341 fn an_unknown_key_lists_the_ones_that_exist() {
2342 let err = match find_setting("idel_days") {
2343 Ok(_) => panic!("`idel_days` is not a setting"),
2344 Err(e) => e.to_string(),
2345 };
2346 assert!(err.contains("idle_days"), "{err}");
2347 }
2348
2349 #[test]
2350 fn a_path_is_never_mistaken_for_an_action() {
2351 assert!(!is_toggle_word("~/Code/my-repo"));
2353 assert!(!is_toggle_word("."));
2354 assert!(!is_toggle_word(""));
2355 assert!(is_toggle_word("install"));
2356 }
2357}