cargo-mend 0.15.0

Opinionated visibility auditing for Rust crates and workspaces
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

use std::path::Path;

use rustc_span::Span;
use rustc_span::def_id::LocalDefId;

use super::classify::CrateKind;
use super::classify::ModuleLocation;
use super::classify::ParentVisibility;
use crate::compiler::facade::ParentFacadeExportStatus;
use crate::config::DiagnosticCode;
use crate::reporting::FixSupport;
use crate::reporting::Severity;

pub struct SuspiciousPubInput<'a> {
    pub def_id:            LocalDefId,
    pub file_path:         &'a Path,
    pub config_rel_path:   Option<&'a str>,
    pub parent_visibility: ParentVisibility,
    pub module_location:   ModuleLocation,
    pub crate_kind:        CrateKind,
    pub kind_label:        Option<&'static str>,
    pub name:              Option<&'a str>,
    pub highlight_span:    Span,
}

pub struct FindingParams {
    pub severity:                Severity,
    pub diagnostic_code:         DiagnosticCode,
    pub item:                    Option<String>,
    pub message:                 String,
    pub suggestion:              Option<String>,
    pub fixability:              FixSupport,
    pub related:                 Option<String>,
    pub item_def_path:           Option<String>,
    pub narrower_scope_def_path: Option<String>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum AllowanceReason {
    Allowlist,
    ParentIsPublic,
    ShallowPrivatePolicy,
    ReachablePublicApi,
    ParentFacadeUsedOutsideParent,
    InternalParentFacadeBoundary,
    ExposedByOtherCrateVisibleSignature,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum SuspiciousPubAssessment {
    Allowed(AllowanceReason),
    ReviewInternalParentFacade {
        related: Option<String>,
    },
    Warn {
        fixability:           FixSupport,
        related:              Option<String>,
        stale_parent_pub_use: Option<ParentFacadeExportStatus>,
    },
}