work in progress: review comments

rust-lang · Feb 1, 2019 · 5d9aec4 · 5d9aec4
1 parent f894adc
commit 5d9aec4
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 12 deletions.
diff --git 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"
 }
 
@@ -39,12 +40,16 @@ impl LintPass for Pass {
 
 impl EarlyLintPass for Pass {
     fn check_mac(&mut self, cx: &EarlyContext<'_>, mac: &ast::Mac) {
+        println!("{:?}", 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, // TODO: to string
+                Applicability::MaybeIncorrect,
             );
         }
     }

diff --git 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
@@ -1,10 +1,8 @@
-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 used
+  --> $DIR/dbg_macro.rs:4:5
    |
 LL |     dbg!(42);
-   |     ^^^^^^^^
+   |     ^^^^^^^^ help: `dbg!` macro is intended as a debugging tool: `ensure to avoid having uses of it in version control`
    |
    = note: `-D clippy::dbg-macro` implied by `-D warnings`
 
-error: aborting due to previous error
-