cargo_pup_lint_impl 0.1.7

Core lint implementations and rustc integration for cargo-pup architectural linting
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

// This product includes software developed at Datadog (https://www.datadoghq.com/) Copyright 2024 Datadog, Inc.

//! Cargo-pup wrappers around rustc's diagnostic functions.
//!
//! This module contains code derived from rust-clippy, which is dual-licensed under
//! Apache 2.0 and MIT licenses. Original copyright:
//! Copyright (c) 2014 The Rust Project Developers

use rustc_errors::{DiagMessage, MultiSpan, SubdiagMessage};
use rustc_lint::{Lint, LintContext};
use rustc_span::Span;

/// Emit a lint message with an extra `help` message.
///
/// Use this if you want to provide some general help but
/// can't provide a specific machine applicable suggestion.
///
/// The `help` message can be optionally attached to a `Span`.
pub fn span_lint_and_help<T: LintContext>(
    cx: &T,
    lint: &'static Lint,
    rule_name: &str,
    span: impl Into<MultiSpan>,
    msg: impl Into<DiagMessage>,
    help_span: Option<Span>,
    help: impl Into<SubdiagMessage>,
) {
    cx.span_lint(lint, span, |diag| {
        diag.primary_message(msg);
        if let Some(help_span) = help_span {
            diag.span_help(help_span, help.into());
        } else {
            diag.help(help.into());
        }
        diag.note(format!("Applied by cargo-pup rule '{rule_name}'."));
    });
}