cargo-shear 1.12.4

Detect and fix unused/misplaced dependencies from Cargo.toml
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
use std::{collections::BTreeSet, error::Error, fmt, path::PathBuf};

use miette::{Diagnostic, LabeledSpan, NamedSource, Severity, SourceSpan};
use rustc_hash::FxHashSet;

use crate::{
    CargoShearOptions,
    context::{PackageContext, WorkspaceContext},
    manifest::{DepTable, FeatureRef},
    package_processor::{
        DoctestDisabledWithDoctests, DoctestEnabledWithoutDoctests, EmptyFile, MisplacedDependency,
        MisplacedOptionalDependency, PackageAnalysis, RedundantIgnore, RedundantIgnorePath,
        TestDisabledWithTests, TestEnabledWithoutTests, UnknownIgnore, UnlinkedFile,
        UnusedDependency, UnusedFeatureDependency, UnusedOptionalDependency,
        UnusedWorkspaceDependency, WorkspaceAnalysis,
    },
};

/// Known crates that generate code at build time, and may require `--expand`.
const KNOWN_CODEGEN_PKGS: &[&str] =
    &["automod", "prost-build", "tonic-build", "tonic-prost-build", "trybuild"];

/// Aggregated diagnostics and counts across every package and the workspace root.
#[derive(Debug)]
pub struct ShearAnalysis {
    /// Options the run was invoked with (kept for renderers and exit-code logic).
    pub options: CargoShearOptions,

    /// Every diagnostic produced by this run, in the order they were emitted.
    pub findings: Vec<ShearDiagnostic>,

    /// Names of all packages whose imports were observed somewhere in the workspace.
    pub packages: FxHashSet<String>,

    /// Number of error-severity findings.
    pub errors: usize,

    /// Number of non-error findings.
    /// Anything that `--fix` can't repair is classified as a warning.
    pub warnings: usize,

    /// Findings that `--fix` could repair but were left untouched (no `--fix` was passed).
    pub fixable: usize,

    /// Number of findings actually rewritten on disk during this run.
    pub fixed: usize,

    /// Suggest `--expand` because a known codegen crate is in play.
    pub show_expand: bool,

    /// Suggest `--fix` because at least one fixable diagnostic is unfixed.
    pub show_fix: bool,

    /// Surface the `ignored = [...]` snippet in the rendered output.
    pub show_ignored: bool,

    /// Surface the `ignored-paths = [...]` snippet in the rendered output.
    pub show_ignored_paths: bool,
}

impl ShearAnalysis {
    #[must_use]
    pub fn new(options: CargoShearOptions) -> Self {
        Self {
            options,
            findings: Vec::new(),
            packages: FxHashSet::default(),
            errors: 0,
            warnings: 0,
            fixable: 0,
            fixed: 0,
            show_expand: false,
            show_fix: false,
            show_ignored: false,
            show_ignored_paths: false,
        }
    }

    pub fn add_package_result(
        &mut self,
        ctx: &PackageContext<'_>,
        result: &PackageAnalysis,
        fixed: usize,
    ) {
        let relative_path = ctx
            .manifest_path
            .strip_prefix(&ctx.workspace.root)
            .unwrap_or(&ctx.manifest_path)
            .display()
            .to_string()
            .replace('\\', "/");

        let src = NamedSource::new(relative_path, ctx.manifest_content.clone());
        self.packages.extend(result.used_packages.iter().cloned());
        self.fixed += fixed;

        for finding in &result.unused_dependencies {
            self.insert(ShearDiagnostic::unused_dependency(finding, &src));
        }

        for finding in &result.unused_optional_dependencies {
            self.insert(ShearDiagnostic::unused_optional_dependency(finding, &src));
        }

        for finding in &result.unused_feature_dependencies {
            self.insert(ShearDiagnostic::unused_feature_dependency(finding, &src));
        }

        for finding in &result.misplaced_dependencies {
            self.insert(ShearDiagnostic::misplaced_dependency(finding, &src));
        }

        for finding in &result.misplaced_optional_dependencies {
            self.insert(ShearDiagnostic::misplaced_optional_dependency(finding, &src));
        }

        if !result.unlinked_files.is_empty() {
            self.insert(ShearDiagnostic::unlinked_files(&result.unlinked_files, &ctx.name));
        }

        if !result.empty_files.is_empty() {
            self.insert(ShearDiagnostic::empty_files(&result.empty_files, &ctx.name));
        }

        for finding in &result.unknown_ignores {
            self.insert(ShearDiagnostic::unknown_ignore(finding, &src));
        }

        for finding in &result.redundant_ignores {
            self.insert(ShearDiagnostic::redundant_ignore(finding, &src));
        }

        for finding in &result.redundant_ignore_paths {
            self.insert(ShearDiagnostic::redundant_ignore_path(finding, &src));
        }

        for finding in &result.test_disabled_with_tests {
            self.insert(ShearDiagnostic::test_disabled_with_tests(finding));
        }

        for finding in &result.test_enabled_without_tests {
            self.insert(ShearDiagnostic::test_enabled_without_tests(finding));
        }

        for finding in &result.doctest_disabled_with_doctests {
            self.insert(ShearDiagnostic::doctest_disabled_with_doctests(finding));
        }

        for finding in &result.doctest_enabled_without_doctests {
            self.insert(ShearDiagnostic::doctest_enabled_without_doctests(finding));
        }

        if !self.show_expand {
            self.show_expand =
                KNOWN_CODEGEN_PKGS.iter().any(|pkg| ctx.pkg_to_import.contains_key(*pkg));
        }
    }

    pub fn add_workspace_result(
        &mut self,
        ctx: &WorkspaceContext,
        result: &WorkspaceAnalysis,
        fixed: usize,
    ) {
        let src = NamedSource::new("Cargo.toml", ctx.manifest_content.clone());
        self.fixed += fixed;

        for finding in &result.unused_dependencies {
            self.insert(ShearDiagnostic::unused_workspace_dependency(finding, &src));
        }

        for finding in &result.unknown_ignores {
            self.insert(ShearDiagnostic::unknown_ignore(finding, &src));
        }

        for finding in &result.redundant_ignores {
            self.insert(ShearDiagnostic::redundant_ignore(finding, &src));
        }

        for finding in &result.redundant_ignore_paths {
            self.insert(ShearDiagnostic::redundant_ignore_path(finding, &src));
        }
    }

    fn insert(&mut self, diagnostic: ShearDiagnostic) {
        if diagnostic.kind.is_fixable() {
            self.fixable += 1;
            self.show_fix = true;
        }

        match diagnostic.kind.severity() {
            Severity::Error => self.errors += 1,
            Severity::Warning | Severity::Advice => self.warnings += 1,
        }

        match &diagnostic.kind {
            DiagnosticKind::UnusedDependency { .. }
            | DiagnosticKind::UnusedWorkspaceDependency { .. }
            | DiagnosticKind::UnusedOptionalDependency { .. }
            | DiagnosticKind::UnusedFeatureDependency { .. }
            | DiagnosticKind::MisplacedDependency { .. }
            | DiagnosticKind::MisplacedOptionalDependency { .. } => {
                self.show_ignored = true;
            }
            DiagnosticKind::UnlinkedFiles { .. } | DiagnosticKind::EmptyFiles { .. } => {
                self.show_ignored_paths = true;
            }
            DiagnosticKind::UnknownIgnore { .. }
            | DiagnosticKind::RedundantIgnore { .. }
            | DiagnosticKind::RedundantIgnorePath { .. }
            | DiagnosticKind::TestDisabledWithTests { .. }
            | DiagnosticKind::TestEnabledWithoutTests { .. }
            | DiagnosticKind::DoctestDisabledWithDoctests { .. }
            | DiagnosticKind::DoctestEnabledWithoutDoctests { .. } => {}
        }

        self.findings.push(diagnostic);
    }
}

/// A renderer-ready diagnostic: payload plus everything needed to point at source.
pub struct ShearDiagnostic {
    /// Which diagnostic this is, with the data needed to format its message.
    pub kind: DiagnosticKind,

    /// The source file (typically a `Cargo.toml`) that `span` points into.
    pub source: Option<NamedSource<String>>,

    /// Primary span within `source` to highlight.
    pub span: Option<SourceSpan>,

    /// Secondary diagnostics that get rendered alongside this one (e.g. feature locations).
    pub related: Vec<Box<dyn Diagnostic + Send + Sync>>,

    /// Suggested fix shown to the user.
    pub help: Option<String>,
}

impl fmt::Debug for ShearDiagnostic {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("ShearDiagnostic")
            .field("kind", &self.kind)
            .field("source", &self.source)
            .field("span", &self.span)
            .field("related", &format!("[{} related diagnostics]", self.related.len()))
            .field("help", &self.help)
            .finish()
    }
}

impl ShearDiagnostic {
    pub fn unused_dependency(diagnostic: &UnusedDependency, source: &NamedSource<String>) -> Self {
        Self {
            kind: DiagnosticKind::UnusedDependency { name: diagnostic.name.get_ref().clone() },
            source: Some(source.clone()),
            span: Some(diagnostic.name.span().into()),
            related: Vec::new(),
            help: Some("remove this dependency".to_owned()),
        }
    }

    pub fn unused_workspace_dependency(
        diagnostic: &UnusedWorkspaceDependency,
        source: &NamedSource<String>,
    ) -> Self {
        Self {
            kind: DiagnosticKind::UnusedWorkspaceDependency {
                name: diagnostic.name.get_ref().clone(),
            },
            source: Some(source.clone()),
            span: Some(diagnostic.name.span().into()),
            related: Vec::new(),
            help: Some("remove this dependency".to_owned()),
        }
    }

    pub fn unused_optional_dependency(
        diagnostic: &UnusedOptionalDependency,
        source: &NamedSource<String>,
    ) -> Self {
        Self {
            kind: DiagnosticKind::UnusedOptionalDependency {
                name: diagnostic.name.get_ref().clone(),
            },
            source: Some(source.clone()),
            span: Some(diagnostic.name.span().into()),
            related: ShearRelatedDiagnostic::from_features(
                Some("removing an optional dependency may be a breaking change"),
                &diagnostic.features,
                source,
            ),
            help: None,
        }
    }

    pub fn unused_feature_dependency(
        diagnostic: &UnusedFeatureDependency,
        source: &NamedSource<String>,
    ) -> Self {
        Self {
            kind: DiagnosticKind::UnusedFeatureDependency {
                name: diagnostic.name.get_ref().clone(),
            },
            source: Some(source.clone()),
            span: Some(diagnostic.name.span().into()),
            related: ShearRelatedDiagnostic::from_features(None, &diagnostic.features, source),
            help: None,
        }
    }

    pub fn misplaced_dependency(
        diagnostic: &MisplacedDependency,
        source: &NamedSource<String>,
    ) -> Self {
        let target = diagnostic.location.as_table(DepTable::Dev);
        Self {
            kind: DiagnosticKind::MisplacedDependency { name: diagnostic.name.get_ref().clone() },
            source: Some(source.clone()),
            span: Some(diagnostic.name.span().into()),
            related: Vec::new(),
            help: Some(format!("move this dependency to `{target}`")),
        }
    }

    pub fn misplaced_optional_dependency(
        diagnostic: &MisplacedOptionalDependency,
        source: &NamedSource<String>,
    ) -> Self {
        let target = diagnostic.location.as_table(DepTable::Dev);
        Self {
            kind: DiagnosticKind::MisplacedOptionalDependency {
                name: diagnostic.name.get_ref().clone(),
            },
            source: Some(source.clone()),
            span: Some(diagnostic.name.span().into()),
            related: ShearRelatedDiagnostic::from_features(
                Some("removing an optional dependency may be a breaking change"),
                &diagnostic.features,
                source,
            ),
            help: Some(format!("remove the `optional` flag and move to `{target}`")),
        }
    }

    pub fn unlinked_files(diagnostics: &[UnlinkedFile], package: &str) -> Self {
        let paths: BTreeSet<_> = diagnostics.iter().map(|file| file.path.clone()).collect();
        let help = if paths.len() == 1 {
            "delete this file".to_owned()
        } else {
            "delete these files".to_owned()
        };

        Self {
            kind: DiagnosticKind::UnlinkedFiles { package: package.to_owned(), paths },
            source: None,
            span: None,
            related: Vec::new(),
            help: Some(help),
        }
    }

    pub fn empty_files(diagnostics: &[EmptyFile], package: &str) -> Self {
        let paths: BTreeSet<_> = diagnostics.iter().map(|file| file.path.clone()).collect();
        let help = if paths.len() == 1 {
            "delete this file".to_owned()
        } else {
            "delete these files".to_owned()
        };

        Self {
            kind: DiagnosticKind::EmptyFiles { package: package.to_owned(), paths },
            source: None,
            span: None,
            related: Vec::new(),
            help: Some(help),
        }
    }

    pub fn unknown_ignore(diagnostic: &UnknownIgnore, source: &NamedSource<String>) -> Self {
        Self {
            kind: DiagnosticKind::UnknownIgnore { name: diagnostic.name.get_ref().clone() },
            source: Some(source.clone()),
            span: Some(diagnostic.name.span().into()),
            related: Vec::new(),
            help: Some("remove from ignored list".to_owned()),
        }
    }

    pub fn redundant_ignore(diagnostic: &RedundantIgnore, source: &NamedSource<String>) -> Self {
        Self {
            kind: DiagnosticKind::RedundantIgnore { name: diagnostic.name.get_ref().clone() },
            source: Some(source.clone()),
            span: Some(diagnostic.name.span().into()),
            related: Vec::new(),
            help: Some("remove from ignored list".to_owned()),
        }
    }

    pub fn redundant_ignore_path(
        diagnostic: &RedundantIgnorePath,
        source: &NamedSource<String>,
    ) -> Self {
        Self {
            kind: DiagnosticKind::RedundantIgnorePath {
                pattern: diagnostic.pattern.get_ref().clone(),
            },
            source: Some(source.clone()),
            span: Some(diagnostic.pattern.span().into()),
            related: Vec::new(),
            help: Some("remove from ignored paths list".to_owned()),
        }
    }

    pub fn test_disabled_with_tests(diagnostic: &TestDisabledWithTests) -> Self {
        Self::sourceless(
            DiagnosticKind::TestDisabledWithTests {
                target_name: diagnostic.target_name.clone(),
                target_kind: diagnostic.target_kind.clone(),
            },
            "set `test = true` or remove the `test = false` setting",
        )
    }

    pub fn test_enabled_without_tests(diagnostic: &TestEnabledWithoutTests) -> Self {
        Self::sourceless(
            DiagnosticKind::TestEnabledWithoutTests {
                target_name: diagnostic.target_name.clone(),
                target_kind: diagnostic.target_kind.clone(),
            },
            "set `test = false` to avoid compiling a test harness for this target",
        )
    }

    pub fn doctest_disabled_with_doctests(diagnostic: &DoctestDisabledWithDoctests) -> Self {
        Self::sourceless(
            DiagnosticKind::DoctestDisabledWithDoctests {
                target_name: diagnostic.target_name.clone(),
            },
            "set `doctest = true` or remove the `doctest = false` setting",
        )
    }

    pub fn doctest_enabled_without_doctests(diagnostic: &DoctestEnabledWithoutDoctests) -> Self {
        Self::sourceless(
            DiagnosticKind::DoctestEnabledWithoutDoctests {
                target_name: diagnostic.target_name.clone(),
            },
            "set `doctest = false` to avoid running doc tests for this target",
        )
    }

    fn sourceless(kind: DiagnosticKind, help: &str) -> Self {
        Self { kind, source: None, span: None, related: Vec::new(), help: Some(help.to_owned()) }
    }
}

#[derive(Debug)]
pub enum DiagnosticKind {
    UnusedDependency { name: String },
    UnusedWorkspaceDependency { name: String },
    UnusedOptionalDependency { name: String },
    UnusedFeatureDependency { name: String },
    MisplacedDependency { name: String },
    MisplacedOptionalDependency { name: String },
    UnlinkedFiles { package: String, paths: BTreeSet<PathBuf> },
    EmptyFiles { package: String, paths: BTreeSet<PathBuf> },
    UnknownIgnore { name: String },
    RedundantIgnore { name: String },
    RedundantIgnorePath { pattern: String },
    TestDisabledWithTests { target_name: String, target_kind: String },
    TestEnabledWithoutTests { target_name: String, target_kind: String },
    DoctestDisabledWithDoctests { target_name: String },
    DoctestEnabledWithoutDoctests { target_name: String },
}

impl DiagnosticKind {
    pub fn message(&self) -> String {
        match self {
            Self::UnusedDependency { name } => format!("unused dependency `{name}`"),
            Self::UnusedWorkspaceDependency { name } => {
                format!("unused workspace dependency `{name}`")
            }
            Self::UnusedOptionalDependency { name } => {
                format!("unused optional dependency `{name}`")
            }
            Self::UnusedFeatureDependency { name } => {
                format!("dependency `{name}` only used in features")
            }
            Self::MisplacedDependency { name } => format!("misplaced dependency `{name}`"),
            Self::MisplacedOptionalDependency { name } => {
                format!("misplaced optional dependency `{name}`")
            }
            Self::UnlinkedFiles { package, paths } => {
                let count = paths.len();
                let s = if count == 1 { "" } else { "s" };
                let paths = paths
                    .iter()
                    .map(|path| path.display().to_string().replace('\\', "/"))
                    .collect::<Vec<_>>()
                    .join("\n");

                format!("{count} unlinked file{s} in `{package}`\n{paths}")
            }
            Self::EmptyFiles { package, paths } => {
                let count = paths.len();
                let s = if count == 1 { "" } else { "s" };
                let paths = paths
                    .iter()
                    .map(|path| path.display().to_string().replace('\\', "/"))
                    .collect::<Vec<_>>()
                    .join("\n");

                format!("{count} empty file{s} in `{package}`\n{paths}")
            }
            Self::UnknownIgnore { name } => format!("unknown ignore `{name}`"),
            Self::RedundantIgnore { name } => format!("redundant ignore `{name}`"),
            Self::RedundantIgnorePath { pattern } => {
                format!("redundant ignored paths pattern `{pattern}`")
            }
            Self::TestDisabledWithTests { target_name, target_kind } => {
                format!(
                    "`test = false` on {target_kind} target `{target_name}` but source contains tests"
                )
            }
            Self::TestEnabledWithoutTests { target_name, target_kind } => {
                format!(
                    "`test = true` on {target_kind} target `{target_name}` but source contains no tests"
                )
            }
            Self::DoctestDisabledWithDoctests { target_name } => {
                format!(
                    "`doctest = false` on lib target `{target_name}` but source contains doc tests"
                )
            }
            Self::DoctestEnabledWithoutDoctests { target_name } => {
                format!(
                    "`doctest = true` on lib target `{target_name}` but source contains no doc tests"
                )
            }
        }
    }

    pub const fn label(&self) -> Option<&'static str> {
        match self {
            Self::UnusedWorkspaceDependency { .. } => Some("not used by any workspace member"),
            Self::UnusedDependency { .. }
            | Self::UnusedOptionalDependency { .. }
            | Self::UnusedFeatureDependency { .. } => Some("not used in code"),
            Self::MisplacedDependency { .. } | Self::MisplacedOptionalDependency { .. } => {
                Some("only used in dev targets")
            }
            Self::UnlinkedFiles { .. }
            | Self::EmptyFiles { .. }
            | Self::TestDisabledWithTests { .. }
            | Self::TestEnabledWithoutTests { .. }
            | Self::DoctestDisabledWithDoctests { .. }
            | Self::DoctestEnabledWithoutDoctests { .. } => None,
            Self::UnknownIgnore { .. } => Some("not a dependency"),
            Self::RedundantIgnore { .. } => Some("dependency is used"),
            Self::RedundantIgnorePath { .. } => Some("pattern not matched"),
        }
    }

    pub const fn code(&self) -> &'static str {
        match self {
            Self::UnusedDependency { .. } => "shear/unused_dependency",
            Self::UnusedWorkspaceDependency { .. } => "shear/unused_workspace_dependency",
            Self::UnusedOptionalDependency { .. } => "shear/unused_optional_dependency",
            Self::UnusedFeatureDependency { .. } => "shear/unused_feature_dependency",
            Self::MisplacedDependency { .. } => "shear/misplaced_dependency",
            Self::MisplacedOptionalDependency { .. } => "shear/misplaced_optional_dependency",
            Self::UnlinkedFiles { .. } => "shear/unlinked_files",
            Self::EmptyFiles { .. } => "shear/empty_files",
            Self::UnknownIgnore { .. } => "shear/unknown_ignore",
            Self::RedundantIgnore { .. } => "shear/redundant_ignore",
            Self::RedundantIgnorePath { .. } => "shear/redundant_ignore_path",
            Self::TestDisabledWithTests { .. } => "shear/test_disabled_with_tests",
            Self::TestEnabledWithoutTests { .. } => "shear/test_enabled_without_tests",
            Self::DoctestDisabledWithDoctests { .. } => "shear/doctest_disabled_with_doctests",
            Self::DoctestEnabledWithoutDoctests { .. } => "shear/doctest_enabled_without_doctests",
        }
    }

    pub const fn severity(&self) -> Severity {
        match self {
            Self::UnusedDependency { .. }
            | Self::UnusedWorkspaceDependency { .. }
            | Self::MisplacedDependency { .. } => Severity::Error,
            Self::UnlinkedFiles { .. }
            | Self::EmptyFiles { .. }
            | Self::UnusedOptionalDependency { .. }
            | Self::UnusedFeatureDependency { .. }
            | Self::MisplacedOptionalDependency { .. }
            | Self::UnknownIgnore { .. }
            | Self::RedundantIgnore { .. }
            | Self::RedundantIgnorePath { .. }
            | Self::TestDisabledWithTests { .. }
            | Self::TestEnabledWithoutTests { .. }
            | Self::DoctestDisabledWithDoctests { .. }
            | Self::DoctestEnabledWithoutDoctests { .. } => Severity::Warning,
        }
    }

    /// Returns `true` if this diagnostic can be automatically fixed with `--fix`.
    pub const fn is_fixable(&self) -> bool {
        matches!(
            self,
            Self::UnusedDependency { .. }
                | Self::UnusedWorkspaceDependency { .. }
                | Self::MisplacedDependency { .. }
                | Self::TestDisabledWithTests { .. }
                | Self::TestEnabledWithoutTests { .. }
                | Self::DoctestDisabledWithDoctests { .. }
                | Self::DoctestEnabledWithoutDoctests { .. }
        )
    }
}

impl fmt::Display for ShearDiagnostic {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.kind.message())
    }
}

impl Error for ShearDiagnostic {}

impl Diagnostic for ShearDiagnostic {
    fn code<'a>(&'a self) -> Option<Box<dyn fmt::Display + 'a>> {
        Some(Box::new(self.kind.code()))
    }

    fn severity(&self) -> Option<Severity> {
        Some(self.kind.severity())
    }

    fn help<'a>(&'a self) -> Option<Box<dyn fmt::Display + 'a>> {
        self.help.as_ref().map(|help| Box::new(help.as_str()) as Box<dyn fmt::Display>)
    }

    fn source_code(&self) -> Option<&dyn miette::SourceCode> {
        self.source.as_ref().map(|source| source as &dyn miette::SourceCode)
    }

    fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>> {
        let label = self.kind.label()?;
        let span = self.span?;
        Some(Box::new(std::iter::once(LabeledSpan::new_with_span(Some(label.to_owned()), span))))
    }

    fn related<'a>(&'a self) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>> {
        if self.related.is_empty() {
            return None;
        }

        Some(Box::new(self.related.iter().map(|diagnostic| diagnostic.as_ref() as &dyn Diagnostic)))
    }
}

/// A secondary diagnostic attached to a primary one — used to point at the
/// `[features]` entries that reference an optional/feature-only dependency.
#[derive(Debug)]
struct ShearRelatedDiagnostic {
    message: String,
    label: Option<(String, SourceSpan, NamedSource<String>)>,
}

impl ShearRelatedDiagnostic {
    fn from_features(
        message: Option<&str>,
        features: &[FeatureRef],
        source: &NamedSource<String>,
    ) -> Vec<Box<dyn Diagnostic + Send + Sync>> {
        let mut related: Vec<Box<dyn Diagnostic + Send + Sync>> = Vec::new();

        if let Some(message) = message {
            related.push(Self { message: message.to_owned(), label: None }.into());
        }

        for feature in features {
            match feature {
                FeatureRef::Explicit { feature, value }
                | FeatureRef::DepFeature { feature, value }
                | FeatureRef::WeakDepFeature { feature, value } => {
                    let name = feature.get_ref();
                    related.push(
                        Self {
                            message: format!("used in feature `{name}`"),
                            label: Some((
                                "enabled here".to_owned(),
                                value.span().into(),
                                source.clone(),
                            )),
                        }
                        .into(),
                    );
                }
                FeatureRef::Implicit => {}
            }
        }

        related
    }
}

impl fmt::Display for ShearRelatedDiagnostic {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.message)
    }
}

impl Error for ShearRelatedDiagnostic {}

impl Diagnostic for ShearRelatedDiagnostic {
    fn severity(&self) -> Option<Severity> {
        Some(Severity::Advice)
    }

    fn source_code(&self) -> Option<&dyn miette::SourceCode> {
        self.label.as_ref().map(|(_, _, source)| source as &dyn miette::SourceCode)
    }

    fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>> {
        self.label.as_ref().map(|(label, span, _)| {
            Box::new(std::iter::once(LabeledSpan::new_with_span(Some(label.clone()), *span)))
                as Box<dyn Iterator<Item = LabeledSpan> + '_>
        })
    }
}