cargo-mend 0.18.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
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

use anyhow::Result;
use rustc_hir::ForeignItem;
use rustc_hir::ImplItem;
use rustc_hir::Item;
use rustc_hir::ItemKind;

use super::FindingParams;
use super::ItemCategory;
use super::ItemInfo;
use super::VisibilityContext;
use super::record;
use crate::compiler::persistence::FindingsSink;
use crate::compiler::visibility::policy;
use crate::compiler::visibility::source;
use crate::config::DiagnosticCode;
use crate::reporting::ExactBoundarySpelling;
use crate::reporting::FixSupport;
use crate::reporting::Severity;

pub(super) fn visit_item(
    ctx: &VisibilityContext<'_, '_>,
    item: &Item<'_>,
    sink: &mut FindingsSink,
) -> Result<()> {
    if item.span.from_expansion() || item.vis_span.from_expansion() {
        return Ok(());
    }
    let Some(file_path) = source::real_file_path(ctx.tcx, item.vis_span) else {
        return Ok(());
    };
    let Some(visibility_text) = source::visibility_text(ctx.tcx, item.vis_span)? else {
        return Ok(());
    };

    let name = item.kind.ident().as_ref().map(ToString::to_string);
    let owner_module = ctx.tcx.parent_module_from_def_id(item.owner_id.def_id);

    if visibility_text == "pub"
        && policy::module_depth(ctx.tcx, owner_module.to_local_def_id()) <= 1
        && matches!(item.kind, ItemKind::Use(..))
        && source::use_item_contains_glob(ctx.tcx, item.span)?
    {
        sink.findings.push(source::build_finding(
            ctx.tcx,
            &file_path,
            item.span,
            FindingParams {
                severity:                Severity::Warning,
                diagnostic_code:         DiagnosticCode::WildcardParentPubUse,
                item:                    None,
                message:                 String::new(),
                suggestion:              None,
                fix_support:             FixSupport::None,
                related:                 None,
                visibility_annotation:   None,
                item_def_path:           None,
                narrower_scope_def_path: None,
                exact_boundary_spelling: ExactBoundarySpelling::CratePath,
            },
        )?);
    }

    record::record_visibility_findings(
        ctx,
        &ItemInfo {
            def_id:          item.owner_id.def_id,
            file_path:       &file_path,
            visibility_text: &visibility_text,
            kind_label:      source::item_kind_label(item.kind),
            name:            name.as_deref(),
            highlight_span:  source::highlight_span(
                item.vis_span,
                item.kind.ident().map(|ident| ident.span),
            ),
            category:        match item.kind {
                ItemKind::Mod(..) => ItemCategory::Module,
                ItemKind::Use(..) => ItemCategory::Use,
                _ => ItemCategory::Declaration,
            },
            facade_subject:  item.owner_id.def_id,
        },
        sink,
    )
}

pub(super) fn visit_impl_item(
    ctx: &VisibilityContext<'_, '_>,
    item: &ImplItem<'_>,
    sink: &mut FindingsSink,
) -> Result<()> {
    let Some(visibility_span) = item.vis_span() else {
        return Ok(());
    };
    if item.span.from_expansion() || visibility_span.from_expansion() {
        return Ok(());
    }
    let Some(file_path) = source::real_file_path(ctx.tcx, visibility_span) else {
        return Ok(());
    };
    let Some(visibility_text) = source::visibility_text(ctx.tcx, visibility_span)? else {
        return Ok(());
    };

    let name = item.ident.to_string();
    let facade_subject = ctx.reexport_index.facade_subject(item.owner_id.def_id);

    record::record_visibility_findings(
        ctx,
        &ItemInfo {
            def_id: item.owner_id.def_id,
            file_path: &file_path,
            visibility_text: &visibility_text,
            kind_label: Some(source::impl_item_kind_label(item.kind)),
            name: Some(name.as_str()),
            highlight_span: source::highlight_span(visibility_span, Some(item.ident.span)),
            category: ItemCategory::Declaration,
            facade_subject,
        },
        sink,
    )
}

pub(super) fn visit_foreign_item(
    ctx: &VisibilityContext<'_, '_>,
    item: &ForeignItem<'_>,
    sink: &mut FindingsSink,
) -> Result<()> {
    if item.span.from_expansion() || item.vis_span.from_expansion() {
        return Ok(());
    }
    let Some(file_path) = source::real_file_path(ctx.tcx, item.vis_span) else {
        return Ok(());
    };
    let Some(visibility_text) = source::visibility_text(ctx.tcx, item.vis_span)? else {
        return Ok(());
    };

    let name = item.ident.to_string();

    record::record_visibility_findings(
        ctx,
        &ItemInfo {
            def_id:          item.owner_id.def_id,
            file_path:       &file_path,
            visibility_text: &visibility_text,
            kind_label:      Some(source::foreign_item_kind_label(item.kind)),
            name:            Some(name.as_str()),
            highlight_span:  source::highlight_span(item.vis_span, Some(item.ident.span)),
            category:        ItemCategory::Declaration,
            facade_subject:  item.owner_id.def_id,
        },
        sink,
    )
}