marker_lints 0.5.0

Lints for the marker_api and marker_utils crate
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

use marker_api::prelude::*;

marker_api::declare_lint! {
    /// ### What it does
    /// Suggests using `impl HasSpan` for functions that need to take `Span` as
    /// a parameter to make them more ergonomic.
    ///
    /// This function only triggers on public items, as it's targeted to towards
    /// the public interface of crates.
    NOT_USING_HAS_SPAN_TRAIT,
    Allow,
}

pub(crate) fn check_item<'ast>(cx: &'ast MarkerContext<'ast>, item: ItemKind<'ast>) {
    let ItemKind::Fn(func) = item else { return };
    if !func.visibility().semantics().is_pub() {
        return;
    }

    for param in func.params() {
        let ast::TyKind::Path(path) = param.ty().peel_refs() else {
            continue;
        };

        let ident = path
            .path()
            .segments()
            .last()
            .unwrap_or_else(|| panic!("BUG: path must have at least one segment, but got: {path:#?}"))
            .ident();

        if ident != "Span" {
            continue;
        }

        cx.emit_lint(
            NOT_USING_HAS_SPAN_TRAIT,
            func,
            "use impl HasSpan instead of Span for more flexibility",
        )
        .span(param.ty().span());
    }
}