1 use crate::utils::{snippet_opt, span_help_and_lint, span_lint_and_sugg};
2 use rustc::lint::{EarlyContext, EarlyLintPass, LintArray, LintPass};
3 use rustc::{declare_lint_pass, declare_tool_lint};
4 use rustc_errors::Applicability;
6 use syntax::source_map::Span;
7 use syntax::tokenstream::TokenStream;
10 /// **What it does:** Checks for usage of dbg!() macro.
12 /// **Why is this bad?** `dbg!` macro is intended as a debugging tool. It
13 /// should not be in version control.
15 /// **Known problems:** None.
27 "`dbg!` macro is intended as a debugging tool"
30 declare_lint_pass!(DbgMacro => [DBG_MACRO]);
32 impl EarlyLintPass for DbgMacro {
33 fn check_mac(&mut self, cx: &EarlyContext<'_>, mac: &ast::Mac) {
34 if mac.path == sym!(dbg) {
35 if let Some(sugg) = tts_span(mac.tts.clone()).and_then(|span| snippet_opt(cx, span)) {
40 "`dbg!` macro is intended as a debugging tool",
41 "ensure to avoid having uses of it in version control",
43 Applicability::MaybeIncorrect,
50 "`dbg!` macro is intended as a debugging tool",
51 "ensure to avoid having uses of it in version control",
58 // Get span enclosing entire the token stream.
59 fn tts_span(tts: TokenStream) -> Option<Span> {
60 let mut cursor = tts.into_trees();
61 let first = cursor.next()?.span();
62 let span = cursor.last().map_or(first, |tree| first.to(tree.span()));