cargo-semver-checks 0.45.0

Scan your Rust crate for semver violations.
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
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
#![deny(unsafe_code)]

use std::{collections::HashSet, env, ffi::OsStr, io::Write as _, path::PathBuf};

use anstyle::{AnsiColor, Color, Reset, Style};
use cargo_config2::Config;
use cargo_semver_checks::{
    FeatureFlag, GlobalConfig, PackageSelection, ReleaseType, Rustdoc, ScopeSelection, SemverQuery,
    WitnessGeneration,
};
use clap::{Args, CommandFactory, Parser, Subcommand};

#[cfg(test)]
#[allow(unsafe_code)]
mod snapshot_tests;

fn main() {
    human_panic::setup_panic!();

    let Cargo::SemverChecks(args) = Cargo::parse();

    let feature_flags = HashSet::from_iter(args.unstable_features.clone());

    configure_color(args.color_choice);
    let mut config = GlobalConfig::new();
    config.set_log_level(args.verbosity.log_level());
    config.set_feature_flags(feature_flags);

    exit_on_error(true, || validate_feature_flags(&mut config, &args));

    // --bugreport: generate a bug report URL
    if args.bugreport {
        print_issue_url(&mut config);
        std::process::exit(0);
    }
    // --list: print a list of all lints
    else if args.list {
        exit_on_error(true, || {
            let queries = SemverQuery::all_queries();
            let mut rows = vec![["id", "type", "description"], ["==", "====", "==========="]];
            for query in queries.values() {
                rows.push([
                    query.id.as_str(),
                    query.required_update.as_str(),
                    query.description.as_str(),
                ]);
            }
            let mut widths = [0; 3];
            for row in &rows {
                widths[0] = widths[0].max(row[0].len());
                widths[1] = widths[1].max(row[1].len());
                widths[2] = widths[2].max(row[2].len());
            }
            let stdout = std::io::stdout();
            let mut stdout = stdout.lock();
            for row in rows {
                writeln!(
                    stdout,
                    "{0:<1$} {2:<3$} {4:<5$}",
                    row[0], widths[0], row[1], widths[1], row[2], widths[2]
                )?;
            }

            config.shell_note("Use `--explain <id>` to see more details")
        });
        std::process::exit(0);
    }
    // --explain ID: print detailed information about a lint
    else if let Some(id) = args.explain.as_deref() {
        exit_on_error(true, || {
            let queries = SemverQuery::all_queries();
            let query = queries.get(id).ok_or_else(|| {
                let ids = queries.keys().cloned().collect::<Vec<_>>();
                anyhow::format_err!(
                    "Unknown id `{}`, available id's:\n  {}",
                    id,
                    ids.join("\n  ")
                )
            })?;
            println!(
                "{}",
                query
                    .reference
                    .as_deref()
                    .unwrap_or(query.description.as_str())
            );
            if let Some(link) = &query.reference_link {
                println!();
                println!("See also {link}");
            }
            Ok(())
        });
        std::process::exit(0);
    }
    // -Z help: print information on all unstable FeatureFlags (-Z flag)
    else if config.feature_flag_enabled(FeatureFlag::HELP) {
        config
            .log_info(|config| {
                let header = Style::new()
                    .bold()
                    .fg_color(Some(Color::Ansi(AnsiColor::Cyan)));
                let option = Style::new().bold();

                let mut stdout = config.stdout();

                writeln!(stdout, "{header}Unstable feature flags:{header:#}")?;
                writeln!(stdout, "{header}{:<20}{header:#}Description", "-Z name",)?;

                for flag in FeatureFlag::ALL_FLAGS.iter().filter(|x| !x.stable) {
                    write!(stdout, "{option}{:<20}{option:#}", flag.id)?;

                    if let Some(help) = flag.help {
                        let mut lines = help.lines();

                        if let Some(first) = lines.next() {
                            writeln!(stdout, "{first}")?;

                            for line in lines {
                                writeln!(stdout, "{:<20}{line}", "")?;
                            }
                        }
                    } else {
                        writeln!(stdout)?;
                    }
                }

                // helper struct for rendering help for just the unstable options.
                #[derive(Parser)]
                #[command(
                    disable_help_flag = true,
                    help_template = "{options}",
                    mut_args = |arg| arg.hide(false),
                )]
                struct HelpPrinter {
                    #[command(flatten)]
                    args: UnstableOptions,
                }

                write!(
                    stdout,
                    "{header}Unstable options:{header:#}\n\
                    {}",
                    HelpPrinter::command().render_long_help()
                )
                .expect("print failed");

                Ok(())
            })
            .expect("write failed");

        std::process::exit(0);
    }

    let check_release = match args.command {
        Some(SemverChecksCommands::CheckRelease(c)) => c,
        None => args.check_release,
    };

    let check: cargo_semver_checks::Check = check_release.into();

    let report = exit_on_error(config.is_error(), || check.check_release(&mut config));
    if report.success() {
        std::process::exit(0);
    } else {
        std::process::exit(1);
    }
}

fn exit_on_error<T>(log_errors: bool, mut inner: impl FnMut() -> anyhow::Result<T>) -> T {
    match inner() {
        Ok(x) => x,
        Err(err) => {
            if log_errors {
                eprintln!("error: {err:?}");
            }
            std::process::exit(1)
        }
    }
}

/// helper function to determine whether to use colors based on the (passed) `--color` flag
/// and the value of the `CARGO_TERM_COLOR` variable.
///
/// If the `--color` flag is set to something valid, it overrides anything in
/// the `CARGO_TERM_COLOR` environment variable
fn configure_color(cli_choice: Option<clap::ColorChoice>) {
    use anstream::ColorChoice as AnstreamChoice;
    use clap::ColorChoice as ClapChoice;
    let choice = match cli_choice {
        Some(ClapChoice::Always) => AnstreamChoice::Always,
        Some(ClapChoice::Auto) => AnstreamChoice::Auto,
        Some(ClapChoice::Never) => AnstreamChoice::Never,
        // we match the behavior of cargo in
        // https://doc.rust-lang.org/cargo/reference/config.html#termcolor
        // note that [`ColorChoice::AlwaysAnsi`] is not supported by cargo.
        None => match env::var("CARGO_TERM_COLOR").as_deref() {
            Ok("always") => AnstreamChoice::Always,
            Ok("never") => AnstreamChoice::Never,
            // if `auto` is set, or the env var is invalid
            // or both the env var and flag are not set, we set the choice to auto
            _ => AnstreamChoice::Auto,
        },
    };

    choice.write_global();
}

fn print_issue_url(config: &mut GlobalConfig) {
    use bugreport::{bugreport, collector::*, format::Markdown};
    let other_bug_url: &str = "https://github.com/obi1kenobi/cargo-semver-checks/issues/new?labels=C-bug&template=3-bug-report.yml";

    let mut bug_report = bugreport!()
        .info(SoftwareVersion::default())
        .info(OperatingSystem::default())
        .info(CommandLine::default())
        .info(CommandOutput::new("cargo version", "cargo", &["-V"]))
        .info(CompileTimeInformation::default());

    let bold_cyan = Style::new()
        .bold()
        .fg_color(Some(Color::Ansi(AnsiColor::Cyan)));

    writeln!(
        config.stdout(),
        "{bold_cyan}\
        System information:{Reset}\n\
        -------------------"
    )
    .expect("Failed to print bug report system information to stdout");
    bug_report.print::<Markdown>();

    let bug_report = bug_report.format::<Markdown>();
    let bug_report_url = urlencoding::encode(&bug_report);

    let cargo_config = match Config::load() {
        Ok(c) => toml::to_string(&c).unwrap_or_else(|s| {
            writeln!(
                config.stderr(),
                "Error serializing cargo build configuration: {s}"
            )
            .expect("Failed to print error");
            String::default()
        }),
        Err(e) => {
            writeln!(
                config.stderr(),
                "Error loading cargo build configuration: {e}"
            )
            .expect("Failed to print error");
            String::default()
        }
    };

    writeln!(
        config.stdout(),
        "{bold_cyan}\
        Cargo build configuration:{Reset}\n\
        --------------------------\n\
        {cargo_config}"
    )
    .expect("Failed to print bug report Cargo configuration to stdout");

    let cargo_config_url: String = urlencoding::encode(&cargo_config).into_owned();

    let bold = Style::new().bold();
    writeln!(
        config.stdout(),
        "{bold}Please file an issue on GitHub reporting your bug.\n\
        Consider adding the diagnostic information above, either manually or automatically through the link below:{Reset}\n\n\
        {other_bug_url}&sys-info={bug_report_url}&build-config={cargo_config_url}",
    )
    .expect("Failed to print bug report generated github issue link");
}

#[derive(Debug, Parser)]
#[command(name = "cargo")]
#[command(bin_name = "cargo")]
#[command(version, propagate_version = true)]
enum Cargo {
    SemverChecks(SemverChecks),
}

#[derive(Debug, Args)]
#[command(args_conflicts_with_subcommands = true)]
struct SemverChecks {
    #[arg(long, global = true, exclusive = true)]
    bugreport: bool,

    #[arg(long, global = true, exclusive = true)]
    explain: Option<String>,

    #[arg(long, global = true, exclusive = true)]
    list: bool,

    #[clap(flatten)]
    check_release: CheckRelease,

    #[command(subcommand)]
    command: Option<SemverChecksCommands>,

    // we need to use clap::ColorChoice instead of anstream::ColorChoice
    // because ValueEnum is implemented for it.
    /// Choose whether to output colors
    #[arg(long = "color", global = true, value_name = "WHEN", value_enum)]
    color_choice: Option<clap::ColorChoice>,

    // docstring for help is on the `clap_verbosity_flag::Verbosity` struct itself
    #[command(flatten)]
    verbosity: clap_verbosity_flag::Verbosity<clap_verbosity_flag::InfoLevel>,

    /// Enable unstable feature flags, run `cargo semver-checks -Z help` for more help.
    #[arg(
        short = 'Z',
        value_name = "FLAG",
        global = true,
        hide_possible_values = true // show explictly with -Z help
    )]
    unstable_features: Vec<FeatureFlag>,
}

/// Encapsulated unstable CLI flags.  These will only be used if
/// `-Z unstable-options` is passed to `cargo-semver-checks`.
///
/// Note for adding arguments: make sure your added argument has a default value to detect
/// when arguments are passed without `-Z unstable-options`, so make sure the behavior
/// when the arg is its default value is the same as the behavior on stable
/// `cargo-semver-checks` when this flag is not passed.
///
/// Also make sure to add `#[arg(hide = true)]` to your argument so it doesn't show
/// up in stable help when it is not valid.  Users can run
/// `cargo semver-checks -Z help` to show help messages
/// instead, so a docstring help message will be shown then.
#[derive(Debug, Clone, Args, Default, PartialEq, Eq)]
#[command(hide = true)]
#[non_exhaustive]
struct UnstableOptions {
    /// Enable printing witness hints, examples of potentially-broken downstream code.
    #[arg(long, hide = true)]
    witness_hints: bool,

    /// Enable generating and testing witness programs, full examples of potentially-broken downstream code.
    #[arg(long, hide = true)]
    witnesses: bool,
}

impl UnstableOptions {
    /// Returns a list of command line flags set when fields in this struct are
    /// not their default values, used for detecting and printing when unstable options
    /// are set without `-Z unstable-options`.
    ///
    /// When you add a new unstable option, the exhaustive let pattern below will not compile.
    /// Fix this by adding the new field to the let pattern, then adding a similar if statement
    /// to the ones below to detect when the field is not its default value, and insert the
    /// command line flag that caused this into the list.  See the implementation
    /// for examples.
    ///
    /// When you remove an unstable option (e.g., to stabilize it), remove the field from
    /// the match pattern, and remove the if block corresponding to that struct field.
    #[must_use]
    fn non_default(&self) -> Vec<String> {
        let mut list = Vec::new();

        // If this has a compilation error from adding or removing fields, see this function's
        // docstring for how to fix this function's implementation.
        let Self {
            witness_hints,
            witnesses,
        } = self;

        if *witness_hints {
            list.push("--witness-hints".into());
        }

        if *witnesses {
            list.push("--witnesses".into())
        }

        list
    }
}

/// Check your crate for semver violations.
#[derive(Debug, Subcommand)]
enum SemverChecksCommands {
    #[command(alias = "diff-files")]
    CheckRelease(CheckRelease),
}

#[derive(Debug, Args, Clone)]
struct CheckRelease {
    #[command(flatten, next_help_heading = "Current")]
    pub manifest: clap_cargo::Manifest,

    #[command(flatten, next_help_heading = "Current")]
    pub workspace: clap_cargo::Workspace,

    /// The current rustdoc json output to test for semver violations.
    #[arg(
        long,
        short_alias = 'c',
        alias = "current",
        value_name = "JSON_PATH",
        help_heading = "Current",
        requires = "baseline_rustdoc",
        conflicts_with_all = [
            "default_features",
            "only_explicit_features",
            "features",
            "baseline_features",
            "current_features",
            "all_features",
            "baseline_version",
            "baseline_rev",
            "baseline_root",
        ]
    )]
    current_rustdoc: Option<PathBuf>,

    /// Version from registry to lookup for a baseline
    #[arg(
        long,
        value_name = "X.Y.Z",
        help_heading = "Baseline",
        group = "baseline"
    )]
    baseline_version: Option<String>,

    /// Git revision to lookup for a baseline
    #[arg(
        long,
        value_name = "REV",
        help_heading = "Baseline",
        group = "baseline"
    )]
    baseline_rev: Option<String>,

    /// Directory containing baseline crate source
    #[arg(
        long,
        value_name = "MANIFEST_ROOT",
        help_heading = "Baseline",
        group = "baseline"
    )]
    baseline_root: Option<PathBuf>,

    /// The rustdoc json file to use as a semver baseline.
    #[arg(
        long,
        short_alias = 'b',
        alias = "baseline",
        value_name = "JSON_PATH",
        help_heading = "Baseline",
        group = "baseline",
        conflicts_with_all = [
            "default_features",
            "only_explicit_features",
            "features",
            "baseline_features",
            "current_features",
            "all_features",
        ]
    )]
    baseline_rustdoc: Option<PathBuf>,

    /// Sets the release type instead of deriving it from the version number.
    #[arg(
        value_enum,
        long,
        value_name = "TYPE",
        help_heading = "Overrides",
        group = "overrides"
    )]
    release_type: Option<ReleaseType>,

    /// Use only the crate-defined default features, as well as any features
    /// added explicitly via other flags.
    ///
    /// Using this flag disables the heuristic that enables all features
    /// except `unstable`, `nightly`, `bench`, `no_std`, and ones starting with prefixes
    /// `_`, `unstable_`, `unstable-`.
    #[arg(
        long,
        help_heading = "Features",
        conflicts_with = "only_explicit_features"
    )]
    default_features: bool,

    /// Use no features except ones explicitly added by other flags.
    ///
    /// Using this flag disables the heuristic that enables all features
    /// except `unstable`, `nightly`, `bench`, `no_std`, and ones starting with prefixes
    /// `_`, `unstable_`, `unstable-`.
    #[arg(long, help_heading = "Features")]
    only_explicit_features: bool,

    /// Add a feature to the set of features being checked.
    /// The feature will be used in both the baseline and the current version
    /// of the crate.
    #[arg(
        long,
        value_delimiter = ',',
        value_name = "NAME",
        help_heading = "Features"
    )]
    features: Vec<String>,

    /// Add a feature to the set of features being checked.
    /// The feature will be used in the baseline version of the crate only.
    #[arg(
        long,
        value_delimiter = ',',
        value_name = "NAME",
        help_heading = "Features"
    )]
    baseline_features: Vec<String>,
    /// Add a feature to the set of features being checked.
    /// The feature will be used in the current version of the crate only.
    #[arg(
        long,
        value_delimiter = ',',
        value_name = "NAME",
        help_heading = "Features"
    )]
    current_features: Vec<String>,

    /// Use all the features, including features named
    /// `unstable`, `nightly`, `bench`, `no_std` or starting with prefixes
    /// `_`, `unstable_`, `unstable-` that are otherwise disabled by default.
    #[arg(
        long,
        help_heading = "Features",
        conflicts_with_all = [
            "default_features",
            "only_explicit_features",
            "features",
            "baseline_features",
            "current_features",
        ]
    )]
    all_features: bool,

    /// Which target to build the crate for, to check platform-specific APIs, e.g.
    /// `x86_64-unknown-linux-gnu`.
    #[arg(long = "target")]
    build_target: Option<String>,

    #[clap(flatten)]
    unstable_options: UnstableOptions,
}

impl From<CheckRelease> for cargo_semver_checks::Check {
    fn from(value: CheckRelease) -> Self {
        let (current, current_project_root) = if let Some(current_rustdoc) = value.current_rustdoc {
            (Rustdoc::from_path(current_rustdoc), None)
        } else if let Some(manifest) = value.manifest.manifest_path {
            let project_root = if manifest.is_dir() {
                manifest
            } else {
                let parent = manifest
                    .parent()
                    .expect("manifest path doesn't have a parent");

                // Special case: if `manifest` is `"Cargo.toml"` then
                // Rust makes `parent` be the empty path.
                // In that case, the argument meant `"./Cargo.toml"` so
                // the parent is the current directory.
                if parent.to_string_lossy().is_empty() {
                    std::env::current_dir().expect("can't determine current directory")
                } else {
                    parent.to_path_buf()
                }
            };
            (Rustdoc::from_root(&project_root), Some(project_root))
        } else {
            let project_root = std::env::current_dir().expect("can't determine current directory");
            (Rustdoc::from_root(&project_root), Some(project_root))
        };
        let mut check = Self::new(current);
        if value.workspace.all || value.workspace.workspace {
            // Specified explicit `--workspace` or `--all`.
            let mut selection = PackageSelection::new(ScopeSelection::Workspace);
            selection.set_excluded_packages(value.workspace.exclude);
            check.set_package_selection(selection);
        } else if !value.workspace.package.is_empty() {
            // Specified explicit `--package`.
            check.set_packages(value.workspace.package);
        } else if !value.workspace.exclude.is_empty() {
            // Specified `--exclude` without `--workspace/--all`.
            // Leave the scope selection to the default ("workspace if the manifest is a workspace")
            // while excluding any specified packages.
            let mut selection = PackageSelection::new(ScopeSelection::DefaultMembers);
            selection.set_excluded_packages(value.workspace.exclude);
            check.set_package_selection(selection);
        }
        let custom_baseline = {
            if let Some(baseline_version) = value.baseline_version {
                Some(Rustdoc::from_registry(baseline_version))
            } else if let Some(baseline_rev) = value.baseline_rev {
                let root = if let Some(baseline_root) = value.baseline_root {
                    lenient_baseline_root(baseline_root)
                } else if let Some(current_root) = current_project_root {
                    current_root
                } else {
                    std::env::current_dir().expect("can't determine current directory")
                };
                Some(Rustdoc::from_git_revision(root, baseline_rev))
            } else if let Some(baseline_rustdoc) = value.baseline_rustdoc {
                Some(Rustdoc::from_path(baseline_rustdoc))
            } else {
                // Either there's a manually-set baseline root path, or fall through
                // to the default behavior.
                value
                    .baseline_root
                    .map(lenient_baseline_root)
                    .map(Rustdoc::from_root)
            }
        };
        if let Some(baseline) = custom_baseline {
            check.set_baseline(baseline);
        }

        if let Some(release_type) = value.release_type {
            check.set_release_type(release_type);
        }

        if value.all_features {
            check.with_all_features();
        } else if value.default_features {
            check.with_default_features();
        } else if value.only_explicit_features {
            check.with_only_explicit_features();
        } else {
            check.with_heuristically_included_features();
        }
        let mut mutual_features = value.features;
        let mut current_features = value.current_features;
        let mut baseline_features = value.baseline_features;
        current_features.append(&mut mutual_features.clone());
        baseline_features.append(&mut mutual_features);

        // Treat --features="" as a no-op like cargo does
        let trim_features = |features: &mut Vec<String>| {
            features.retain(|feature| !(feature.is_empty() || feature == "\"\""));
        };
        trim_features(&mut current_features);
        trim_features(&mut baseline_features);

        check.set_extra_features(current_features, baseline_features);

        if let Some(build_target) = value.build_target {
            check.set_build_target(build_target);
        }

        let mut witness_generation = WitnessGeneration::new();
        witness_generation.show_hints = value.unstable_options.witness_hints;
        witness_generation.generate_witnesses = value.unstable_options.witnesses;
        check.set_witness_generation(witness_generation);

        check
    }
}

/// Replace baseline root paths that point to `Cargo.toml` with ones to its directory.
///
/// Be lenient when people pass a path to a *manifest* to `--baseline-root`
/// instead of a directory. They are confusing it with `--manifest-path` which
/// requires a manifest instead of a directory.
///
/// We know what they meant, so apply it.
fn lenient_baseline_root(baseline_root: PathBuf) -> PathBuf {
    if baseline_root.is_file()
        && baseline_root.file_name().and_then(OsStr::to_str) == Some("Cargo.toml")
    {
        let parent = baseline_root.parent().expect("file doesn't have a parent");
        // Special case: if `baseline_root` is `"Cargo.toml"` then
        // Rust makes `parent` be the empty path.
        // In that case, the argument meant `"./Cargo.toml"` so
        // the parent is the current directory.
        if parent.to_string_lossy().is_empty() {
            std::env::current_dir().expect("can't determine current directory")
        } else {
            parent.to_path_buf()
        }
    } else {
        baseline_root
    }
}

/// Helper function to encapsulate the logic of validating that unstable options
/// were not used without `-Z unstable-options` and issuing deprecation warnings
/// for any stable feature flags that were explicitly specified.
fn validate_feature_flags(config: &mut GlobalConfig, args: &SemverChecks) -> anyhow::Result<()> {
    // needed to avoid borrow checker errors when printing with config.
    let stable_flags: Vec<_> = config
        .feature_flags()
        .iter()
        .filter(|x| x.stable)
        .copied()
        .collect();

    for stable_flag in stable_flags {
        config
            .shell_warn(format_args!(
                "the feature flag {} has been stabilized and may be removed
            from the list of feature flags in a future release.",
                stable_flag.id
            ))
            .expect("printing failed");
    }

    if !config.feature_flag_enabled(FeatureFlag::UNSTABLE_OPTIONS) {
        let unstable_options = match &args.command {
            Some(SemverChecksCommands::CheckRelease(cr)) => &cr.unstable_options,
            None => &args.check_release.unstable_options,
        };

        let non_default_options = unstable_options.non_default();

        if !non_default_options.is_empty() {
            let mut message = String::from(
                "the following options are not supported without `-Z unstable-options`:\n",
            );

            for option in non_default_options {
                use std::fmt::Write as _;

                writeln!(&mut message, " - `{option}`").expect("writes to strings are infallible");
            }

            anyhow::bail!(message);
        }
    }

    Ok(())
}

#[test]
fn verify_cli() {
    use clap::CommandFactory;
    Cargo::command().debug_assert()
}

#[test]
fn features_empty_string_is_no_op() {
    use cargo_semver_checks::Check;

    let Cargo::SemverChecks(SemverChecks {
        check_release: no_features,
        ..
    }) = Cargo::parse_from(["cargo", "semver-checks"]);

    let empty_features = CheckRelease {
        features: vec![String::new()],
        current_features: vec![String::new(), "\"\"".to_string()],
        baseline_features: vec!["\"\"".to_string()],
        ..no_features.clone()
    };

    assert_eq!(Check::from(no_features), Check::from(empty_features));
}

/// Test to assert that all flags added to the [`UnstableOptions`] are
/// hidden and won't show up in stable `--help`.
#[test]
fn all_unstable_features_are_hidden() {
    // Helper struct to get a `Command` to use reflection on the unstable options.
    #[derive(Debug, Parser)]
    struct Wrapper {
        #[clap(flatten)]
        inner: UnstableOptions,
    }

    let unstable_options = Wrapper::command();
    let cargo_command = Cargo::command();
    let semver_checks = cargo_command
        .find_subcommand("semver-checks")
        .expect("expected semver-checks command");

    for option in unstable_options.get_arguments() {
        let argument = semver_checks
            .get_arguments()
            .find(|x| x.get_id() == option.get_id())
            .expect("expected unstable argument");

        assert!(
            argument.is_hide_set(),
            "unstable argument {} should be hidden by default",
            argument.get_id()
        );
    }
}

#[test]
fn current_rustdoc_conflict_errors() {
    use clap::CommandFactory as _;

    // Only --current-rustdoc provided: missing required --baseline-rustdoc
    assert!(
        Cargo::command()
            .try_get_matches_from([
                "cargo",
                "semver-checks",
                "check-release",
                "--current-rustdoc",
                "foo.json",
            ])
            .is_err()
    );

    // Conflicts with --baseline-version
    assert!(
        Cargo::command()
            .try_get_matches_from([
                "cargo",
                "semver-checks",
                "check-release",
                "--current-rustdoc",
                "foo.json",
                "--baseline-version",
                "1.0.0",
            ])
            .is_err()
    );

    // Conflicts with --baseline-root
    assert!(
        Cargo::command()
            .try_get_matches_from([
                "cargo",
                "semver-checks",
                "check-release",
                "--current-rustdoc",
                "foo.json",
                "--baseline-root",
                ".",
            ])
            .is_err()
    );

    // Conflicts with --baseline-rev
    assert!(
        Cargo::command()
            .try_get_matches_from([
                "cargo",
                "semver-checks",
                "check-release",
                "--current-rustdoc",
                "foo.json",
                "--baseline-rev",
                "main",
            ])
            .is_err()
    );
}