From 7ec5528e0c92f15f74c1e8b48502ce3a07a419cd Mon Sep 17 00:00:00 2001 From: rhysd Date: Fri, 1 Feb 2019 09:23:40 +0900 Subject: [PATCH] fix category and use suggestion --- clippy_lints/src/dbg_macro.rs | 18 +++++++++++------- tests/ui/dbg_macro.rs | 2 ++ tests/ui/dbg_macro.stderr | 8 ++++++-- 3 files changed, 19 insertions(+), 9 deletions(-) diff --git a/clippy_lints/src/dbg_macro.rs b/clippy_lints/src/dbg_macro.rs index fad012bf7a25..3dce8189b711 100644 --- a/clippy_lints/src/dbg_macro.rs +++ b/clippy_lints/src/dbg_macro.rs @@ -1,12 +1,13 @@ use rustc::lint::{EarlyContext, EarlyLintPass, LintArray, LintPass}; use rustc::{declare_tool_lint, lint_array}; -use crate::utils::span_lint; +use crate::utils::span_lint_and_sugg; use syntax::ast; +use rustc_errors::Applicability; -/// **What it does:** Checks for usage of dbg!() macro not to have it in -/// version control. +/// **What it does:** Checks for usage of dbg!() macro. /// -/// **Why is this bad?** `dbg!` macro is intended as a debugging tool. +/// **Why is this bad?** `dbg!` macro is intended as a debugging tool. It +/// should not be in version control. /// /// **Known problems:** None. /// @@ -20,7 +21,7 @@ use syntax::ast; /// ``` declare_clippy_lint! { pub DBG_MACRO, - style, + restriction, "`dbg!` macro is intended as a debugging tool" } @@ -40,11 +41,14 @@ impl LintPass for Pass { impl EarlyLintPass for Pass { fn check_mac(&mut self, cx: &EarlyContext<'_>, mac: &ast::Mac) { if mac.node.path == "dbg" { - span_lint( + span_lint_and_sugg( cx, DBG_MACRO, mac.span, - "`dbg!` macro is intended as a debugging tool. ensure to avoid having uses of it in version control", + "`dbg!` macro is intended as a debugging tool", + "ensure to avoid having uses of it in version control", + mac.node.tts.to_string(), // TODO: to string + Applicability::MaybeIncorrect, ); } } diff --git a/tests/ui/dbg_macro.rs b/tests/ui/dbg_macro.rs index cf113050c267..dc96c7da0ace 100644 --- a/tests/ui/dbg_macro.rs +++ b/tests/ui/dbg_macro.rs @@ -1,3 +1,5 @@ +#![warn(clippy::dbg_macro)] + fn main() { dbg!(42); } diff --git a/tests/ui/dbg_macro.stderr b/tests/ui/dbg_macro.stderr index cb5389c6e765..4b8501462ff5 100644 --- a/tests/ui/dbg_macro.stderr +++ b/tests/ui/dbg_macro.stderr @@ -1,10 +1,14 @@ -error: `dbg!` macro is intended as a debugging tool. ensure to avoid having uses of it in version control - --> $DIR/dbg_macro.rs:2:5 +error: `dbg!` macro is intended as a debugging tool + --> $DIR/dbg_macro.rs:4:5 | LL | dbg!(42); | ^^^^^^^^ | = note: `-D clippy::dbg-macro` implied by `-D warnings` +help: ensure to avoid having uses of it in version control + | +LL | 42; + | ^^ error: aborting due to previous error