cargo-fresh 0.10.7

A Rust tool for checking and updating globally installed Cargo packages with interactive mode and smart prerelease detection
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;

use anyhow::Result;
use clap::Parser;
use colored::*;

use cargo_fresh::cli::{Cli, Commands, OutputFormat};
use cargo_fresh::display::{
    print_results, print_update_selection, print_update_summary, set_json_mode, status,
    status_dim, status_err, status_warn,
};
use cargo_fresh::locale::detect_language;
use cargo_fresh::models::{
    JsonCheckError, JsonReport, JsonResult, JsonSkipped, JsonSummary, JsonUpdateCandidate,
    PackageInfo, PackageSource, UpdateResult,
};
use cargo_fresh::package::{
    check_package_updates, exclude_packages, filter_packages, get_installed_packages,
    is_stable_version,
};
use cargo_fresh::updater::update_package;

/// 退出码契约(在 README 同步文档化):
///
/// | 码  | 含义                                            |
/// |-----|-------------------------------------------------|
/// | 0   | 无更新候选;或所有选中包更新成功                |
/// | 1   | 有更新候选但本次未应用(JSON 模式无 --batch;或 --no-interactive 没选中包) |
/// | 2   | 至少一个包更新失败                              |
/// | 130 | 用户按 Ctrl-C 中断                              |
/// | 其他| clap 用法错误等由 clap / anyhow 直接返回的标准码 |
const EXIT_OK: i32 = 0;
const EXIT_UPDATES_AVAILABLE: i32 = 1;
const EXIT_FAILED: i32 = 2;
const EXIT_ABORTED: i32 = 130;

#[tokio::main]
async fn main() {
    let exit_code = match run().await {
        Ok(code) => code,
        Err(err) => {
            // anyhow 默认会把整条 chain 打到 stderr,我们额外补一条 "Hint" 行
            // 给出可执行建议(如果 errors::hint_for 能识别这条错误)。
            // 用 anstream::eprintln 而非 status_err:anstream 已经处理过 NO_COLOR/TTY;
            // hint 用 status_dim 走和 spinner 同一条 stderr 通道。
            anstream::eprintln!("error: {err:?}");
            if let Some(hint) = cargo_fresh::errors::hint_for(&err) {
                if !cargo_fresh::display::is_json_mode() {
                    status_dim("Hint", hint);
                }
            }
            std::process::exit(EXIT_FAILED);
        }
    };
    std::process::exit(exit_code);
}

async fn run() -> Result<i32> {
    let args: Vec<String> = std::env::args().collect();
    let cli = if args.get(1) == Some(&"fresh".to_string()) {
        Cli::parse_from(args.into_iter().skip(1))
    } else {
        Cli::parse()
    };

    // 颜色决策权交给 anstream:它读取 NO_COLOR / CLICOLOR[_FORCE] / TERM / TTY
    // 一次得出 ColorChoice,我们把这个决定下发给 colored(让 `.green().bold()` 这套
    // 生成 ANSI,但是否实际写到终端最终还是 anstream::eprintln! 在每次调用时再裁剪)。
    // status 全部走 stderr,因此用 stderr 的 choice 校准;JSON 模式独立走 anstream::stdout。
    let stderr_choice = anstream::AutoStream::choice(&std::io::stderr());
    colored::control::set_override(stderr_choice != anstream::ColorChoice::Never);

    // JSON 模式:禁用所有 status*/print_*/dialoguer 输出,结尾统一打一行 JSON。
    let json_mode = cli.format == OutputFormat::Json;
    if json_mode {
        set_json_mode(true);
    }

    let language = detect_language();

    let cancel = Arc::new(AtomicBool::new(false));
    {
        let cancel = cancel.clone();
        tokio::spawn(async move {
            if tokio::signal::ctrl_c().await.is_ok() {
                cancel.store(true, Ordering::SeqCst);
            }
        });
    }

    if let Some(command) = cli.command {
        match command {
            Commands::Completion { shell, cargo_fresh } => {
                if cargo_fresh {
                    Cli::generate_cargo_fresh_completion(shell.clone());
                } else {
                    Cli::generate_completion(shell.clone());
                }
                Cli::maybe_hint_fish_install(&shell, cargo_fresh);
                return Ok(EXIT_OK);
            }
            Commands::Man => {
                Cli::generate_man()?;
                return Ok(EXIT_OK);
            }
        }
    }

    let run_start = std::time::Instant::now();
    status("Checking", language.get_text("checking_packages"));

    let mut packages = get_installed_packages().await?;

    if packages.is_empty() {
        status_warn("Note", language.get_text("no_packages_found"));
        if json_mode {
            emit_report(&cli, &[], &[], &[], false, run_start, 0);
        }
        return Ok(EXIT_OK);
    }

    if let Some(filter_pattern) = &cli.filter {
        filter_packages(&mut packages, filter_pattern)?;
    }
    if !cli.exclude.is_empty() {
        exclude_packages(&mut packages, &cli.exclude)?;
    }
    if (cli.filter.is_some() || !cli.exclude.is_empty()) && packages.is_empty() {
        status_warn("Note", language.get_text("no_packages_found"));
        if json_mode {
            emit_report(&cli, &[], &[], &[], false, run_start, 0);
        }
        return Ok(EXIT_OK);
    }

    status(
        "Found",
        &language
            .get_text("found_packages")
            .replace("{}", &packages.len().to_string()),
    );

    let no_fallback = cargo_fresh::package::cargo_search_fallback_disabled(cli.no_cargo_search_fallback);
    check_package_updates(
        &mut packages,
        cli.verbose,
        cli.include_prerelease,
        cli.registry_url.clone(),
        no_fallback,
    )
    .await?;

    // --check-binstall:对更新候选并发跑 `cargo binstall --dry-run`,提前标出
    // "会拿预编译产物(快)"还是"会从源码构建(慢)"。binstall 没装就只给 Hint。
    if cli.check_binstall {
        if cargo_fresh::package::is_binstall_available() {
            cargo_fresh::package::binstall_probe::annotate_updates(&mut packages).await;
        } else {
            status_dim("Hint", language.get_text("binstall_hint"));
        }
    }

    let stable_updates: Vec<&PackageInfo> = packages
        .iter()
        .filter(|p| {
            p.has_update()
                && p.latest_version
                    .as_ref()
                    .map(|v| is_stable_version(v))
                    .unwrap_or(false)
        })
        .collect();

    let prerelease_updates: Vec<&PackageInfo> = packages
        .iter()
        .filter(|p| p.has_update() && p.is_prerelease())
        .collect();

    let mut all_updates = stable_updates.clone();
    all_updates.extend(prerelease_updates.clone());

    if all_updates.is_empty() {
        status("Finished", language.get_text("all_up_to_date"));
        if json_mode {
            emit_report(&cli, &packages, &[], &[], false, run_start, 0);
        }
        return Ok(EXIT_OK);
    }

    print_results(&packages, cli.updates_only, language);

    // 选包:
    // - JSON + --batch:选所有更新候选
    // - JSON 无 --batch:不选任何(只检查,退出码 1 表示"有可更新")
    // - human --batch:选所有
    // - human 交互:dialoguer 多选
    // - human --no-interactive:不选
    let selections: Vec<usize> = if cli.batch {
        (0..all_updates.len()).collect()
    } else if json_mode || cli.no_interactive {
        Vec::new()
    } else {
        print_update_selection(&stable_updates, &prerelease_updates, language)?
    };

    let mut update_results: Vec<UpdateResult> = Vec::new();
    let mut aborted = false;

    if !selections.is_empty() {
        if !json_mode {
            anstream::eprintln!();
            if cli.dry_run {
                status("Dry run", language.get_text("dry_run_summary"));
            } else {
                status("Updating", language.get_text("starting_update"));
            }
        }

        let mut all_packages_to_update = stable_updates.clone();
        all_packages_to_update.extend(prerelease_updates.clone());
        let total_packages = selections.len();
        let mut success_count = 0;
        let mut fail_count = 0;
        let mut aborted_at: Option<usize> = None;

        for (i, &index) in selections.iter().enumerate() {
            if cancel.load(Ordering::SeqCst) {
                aborted_at = Some(i);
                break;
            }
            let package_name = &all_packages_to_update[index].name;
            let selected_pkg = all_packages_to_update
                .iter()
                .find(|p| p.name == *package_name);
            let target_version = selected_pkg
                .and_then(|p| p.latest_version.as_ref())
                .map(|v| v.as_str());
            let source = selected_pkg
                .map(|p| p.source.clone())
                .unwrap_or(PackageSource::Crates);
            let install_opts = selected_pkg.and_then(|p| p.install_opts.as_ref());

            if total_packages > 1 {
                status_dim(
                    "Package",
                    &format!("{}/{} {}", i + 1, total_packages, package_name.cyan()),
                );
            }

            match update_package(
                package_name,
                target_version,
                &source,
                install_opts,
                cli.dry_run,
                cli.install_binstall,
                cli.verbose,
                &cancel,
            )
            .await
            {
                Ok(Some(result)) => {
                    if result.success {
                        success_count += 1;
                    } else {
                        fail_count += 1;
                    }
                    update_results.push(result);
                }
                Ok(None) => {
                    // update_package 执行中途检测到 Ctrl-C:这个包既不算成功
                    // 也不算失败,不计入 update_results。标记中止、停止后续包。
                    aborted_at = Some(i);
                    break;
                }
                Err(e) => {
                    status_err(
                        "Error",
                        &language.format_text(
                            "package_error",
                            &[
                                ("name", &package_name.red().to_string()),
                                ("error", &e.to_string()),
                            ],
                        ),
                    );
                    fail_count += 1;
                    update_results.push(UpdateResult::new(package_name.clone(), None, None, false));
                }
            }
        }

        let total_duration = run_start.elapsed();
        let duration_seconds = total_duration.as_secs();
        let duration_millis = total_duration.as_millis();

        print_update_summary(&update_results, language);

        if let Some(done) = aborted_at {
            aborted = true;
            status_warn(
                "Aborted",
                &language.format_text(
                    "aborted_by_user",
                    &[
                        ("done", &done.to_string()),
                        ("total", &total_packages.to_string()),
                    ],
                ),
            );
        } else {
            let success_text = language
                .get_text("success_count")
                .replace("{}", &success_count.to_string());
            let time_text = if duration_seconds > 0 {
                language
                    .get_text("total_time_seconds")
                    .replace("{}", &duration_seconds.to_string())
            } else {
                language
                    .get_text("total_time_millis")
                    .replace("{}", &duration_millis.to_string())
            };
            let summary = if fail_count > 0 {
                let fail_text = language
                    .get_text("fail_count")
                    .replace("{}", &fail_count.to_string());
                format!("{}, {}, {}", success_text, fail_text, time_text)
            } else {
                format!("{}, {}", success_text, time_text)
            };
            if fail_count > 0 {
                status_err("Finished", &summary);
            } else {
                status("Finished", &summary);
            }
        }
    } else {
        status_dim("Note", language.get_text("no_packages_selected"));
    }

    if json_mode {
        emit_report(
            &cli,
            &packages,
            &all_updates,
            &update_results,
            aborted,
            run_start,
            selections.len(),
        );
    }

    // 计算退出码
    let any_failed = update_results.iter().any(|r| !r.success);
    let updates_available = !all_updates.is_empty();
    let applied_any = !update_results.is_empty();

    let code = if aborted {
        EXIT_ABORTED
    } else if any_failed {
        EXIT_FAILED
    } else if updates_available && !applied_any {
        EXIT_UPDATES_AVAILABLE
    } else {
        EXIT_OK
    };

    Ok(code)
}

/// 纯函数:把整次运行的快照组装成 JSON 报告结构。
/// 不做 I/O,便于单元测试;`emit_report` 负责真正写 stdout。
fn build_report<'a>(
    cli: &'a Cli,
    packages: &'a [PackageInfo],
    all_updates: &[&'a PackageInfo],
    update_results: &'a [UpdateResult],
    aborted: bool,
    start: std::time::Instant,
    selected: usize,
) -> JsonReport<'a> {
    let updates_available: Vec<JsonUpdateCandidate> = all_updates
        .iter()
        .filter_map(|p| {
            p.latest_version.as_deref().map(|latest| JsonUpdateCandidate {
                name: p.name.as_str(),
                current: p.current_version.as_deref(),
                latest,
                source: p.source.kind_str(),
                prerelease: p.is_prerelease(),
                binstall: p.binstall_kind.map(|k| k.kind_str()),
            })
        })
        .collect();

    let fresh: Vec<&str> = packages
        .iter()
        .filter(|p| !p.has_update() && p.source.is_crates() && p.check_error.is_none())
        .map(|p| p.name.as_str())
        .collect();

    let skipped: Vec<JsonSkipped> = packages
        .iter()
        .filter(|p| !p.source.is_crates())
        .map(|p| JsonSkipped {
            name: p.name.as_str(),
            source: p.source.kind_str(),
            reason_code: p.source.skip_reason_code(),
            reason: "non-crates source: version check skipped",
        })
        .collect();

    let version_check_errors: Vec<JsonCheckError> = packages
        .iter()
        .filter_map(|p| {
            p.check_error.as_ref().map(|e| JsonCheckError {
                name: p.name.as_str(),
                kind: e.kind.kind_str(),
                error: e.message.as_str(),
            })
        })
        .collect();

    let results: Vec<JsonResult> = update_results
        .iter()
        .map(|r| JsonResult {
            name: r.package_name.as_str(),
            old_version: r.old_version.as_deref(),
            new_version: r.new_version.as_deref(),
            success: r.success,
        })
        .collect();

    let succeeded = results.iter().filter(|r| r.success).count();
    let failed = results.iter().filter(|r| !r.success).count();

    let summary = JsonSummary {
        checked: packages.len(),
        available: updates_available.len(),
        selected,
        attempted: results.len(),
        succeeded,
        failed,
        skipped: skipped.len(),
        check_errors: version_check_errors.len(),
        duration_ms: start.elapsed().as_millis(),
    };

    JsonReport {
        schema_version: 1,
        format: "cargo-fresh-v1",
        include_prerelease: cli.include_prerelease,
        dry_run: cli.dry_run,
        registry_url: cli.registry_url.as_deref(),
        updates_available,
        fresh,
        skipped,
        version_check_errors,
        results,
        summary,
        aborted,
    }
}

fn emit_report(
    cli: &Cli,
    packages: &[PackageInfo],
    all_updates: &[&PackageInfo],
    update_results: &[UpdateResult],
    aborted: bool,
    start: std::time::Instant,
    selected: usize,
) {
    print_json(&build_report(
        cli,
        packages,
        all_updates,
        update_results,
        aborted,
        start,
        selected,
    ));
}

fn print_json(report: &JsonReport) {
    // JSON 报告永远不需要颜色,但仍走 anstream::println! 以保持 stdout 通道一致
    match serde_json::to_string(report) {
        Ok(s) => anstream::println!("{}", s),
        Err(e) => {
            anstream::eprintln!(
                "{{\"schema_version\":1,\"error\":\"failed to serialize report: {}\"}}", e
            );
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use clap::Parser;
    use cargo_fresh::models::{PackageInfo, PackageSource};

    fn empty_cli() -> Cli {
        Cli::parse_from(["cargo-fresh"])
    }

    #[test]
    fn build_report_counts_packages_and_sets_format() {
        let cli = empty_cli();
        let packages = vec![
            PackageInfo::with_source("ripgrep".into(), Some("14.1.1".into()), PackageSource::Crates),
        ];
        let report = build_report(&cli, &packages, &[], &[], false, std::time::Instant::now(), 0);
        assert_eq!(report.schema_version, 1);
        assert_eq!(report.format, "cargo-fresh-v1");
        assert_eq!(report.summary.checked, 1);
        assert_eq!(report.fresh, vec!["ripgrep"]);
    }

    #[test]
    fn build_report_sets_skip_reason_code() {
        let cli = empty_cli();
        let packages = vec![PackageInfo::with_source(
            "my-tool".into(),
            Some("0.1.0".into()),
            PackageSource::Git { url: "u".into(), rev: None },
        )];
        let report = build_report(&cli, &packages, &[], &[], false, std::time::Instant::now(), 0);
        assert_eq!(report.skipped.len(), 1);
        assert_eq!(report.skipped[0].reason_code, "git_source");
    }

    #[test]
    fn build_report_excludes_check_error_packages_from_fresh() {
        use cargo_fresh::models::{CheckError, CheckErrorKind};

        let cli = empty_cli();
        let mut errored = PackageInfo::with_source(
            "bat".into(),
            Some("0.24.0".into()),
            PackageSource::Crates,
        );
        errored.check_error = Some(CheckError {
            kind: CheckErrorKind::Unavailable,
            message: "sparse index HTTP 503".into(),
        });
        let fresh_pkg = PackageInfo::with_source(
            "ripgrep".into(),
            Some("14.1.1".into()),
            PackageSource::Crates,
        );
        let packages = vec![errored, fresh_pkg];

        let report = build_report(&cli, &packages, &[], &[], false, std::time::Instant::now(), 0);

        assert_eq!(report.fresh, vec!["ripgrep"]);
        assert_eq!(report.version_check_errors.len(), 1);
        assert_eq!(report.version_check_errors[0].name, "bat");
        assert_eq!(report.version_check_errors[0].kind, "unavailable");
        assert_eq!(report.summary.check_errors, 1);
    }

    #[test]
    fn build_report_maps_binstall_kind_to_json() {
        // --check-binstall 探测出的 BinstallKind 必须落到 updates_available[].binstall
        use cargo_fresh::models::BinstallKind;
        let cli = empty_cli();
        let mut pkg = PackageInfo::with_source(
            "cargo-deny".into(),
            Some("0.19.6".into()),
            PackageSource::Crates,
        );
        pkg.latest_version = Some("0.19.7".into());
        pkg.binstall_kind = Some(BinstallKind::SourceBuild);
        let packages = vec![pkg];
        let all_updates: Vec<&PackageInfo> = packages.iter().collect();
        let report = build_report(
            &cli,
            &packages,
            &all_updates,
            &[],
            false,
            std::time::Instant::now(),
            0,
        );
        assert_eq!(report.updates_available.len(), 1);
        assert_eq!(report.updates_available[0].binstall, Some("source_build"));
    }

    #[test]
    fn build_report_binstall_is_null_when_not_probed() {
        // 没跑 --check-binstall 时 binstall_kind 为 None,JSON 里应是 null
        let cli = empty_cli();
        let mut pkg = PackageInfo::with_source(
            "ripgrep".into(),
            Some("14.1.0".into()),
            PackageSource::Crates,
        );
        pkg.latest_version = Some("14.1.1".into());
        let packages = vec![pkg];
        let all_updates: Vec<&PackageInfo> = packages.iter().collect();
        let report = build_report(
            &cli,
            &packages,
            &all_updates,
            &[],
            false,
            std::time::Instant::now(),
            0,
        );
        assert_eq!(report.updates_available[0].binstall, None);
    }

    #[test]
    fn build_report_summary_has_selection_counts() {
        let cli = empty_cli();
        let report = build_report(
            &cli,
            &[],
            &[],
            &[],
            false,
            std::time::Instant::now(),
            3,
        );
        assert_eq!(report.summary.selected, 3);
        assert_eq!(report.summary.attempted, 0);
    }
}