52 lines
1.1 KiB
Rust
52 lines
1.1 KiB
Rust
|
use rustc::lint::{EarlyContext, EarlyLintPass, LintArray, LintPass};
|
||
|
|
use rustc::{declare_tool_lint, lint_array};
|
||
|
|
use crate::utils::span_lint;
|
||
|
|
use syntax::ast;
|
||
|
|
|
||
|
|
/// **What it does:** Checks for usage of dbg!() macro not to have it in
|
||
|
|
/// version control.
|
||
|
|
///
|
||
|
|
/// **Why is this bad?** `dbg!` macro is intended as a debugging tool.
|
||
|
|
///
|
||
|
|
/// **Known problems:** None.
|
||
|
|
///
|
||
|
|
/// **Example:**
|
||
|
|
/// ```rust,ignore
|
||
|
|
/// // Bad
|
||
|
|
/// dbg!(true)
|
||
|
|
///
|
||
|
|
/// // Good
|
||
|
|
/// true
|
||
|
|
/// ```
|
||
|
|
declare_clippy_lint! {
|
||
|
|
pub DBG_MACRO,
|
||
|
|
style,
|
||
|
|
"`dbg!` macro is intended as a debugging tool"
|
||
|
|
}
|
||
|
|
|
||
|
|
#[derive(Copy, Clone, Debug)]
|
||
|
|
pub struct Pass;
|
||
|
|
|
||
|
|
impl LintPass for Pass {
|
||
|
|
fn get_lints(&self) -> LintArray {
|
||
|
|
lint_array!(DBG_MACRO)
|
||
|
|
}
|
||
|
|
|
||
|
|
fn name(&self) -> &'static str {
|
||
|
|
"DbgMacro"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
impl EarlyLintPass for Pass {
|
||
|
|
fn check_mac(&mut self, cx: &EarlyContext<'_>, mac: &ast::Mac) {
|
||
|
|
if mac.node.path == "dbg" {
|
||
|
|
span_lint(
|
||
|
|
cx,
|
||
|
|
DBG_MACRO,
|
||
|
|
mac.span,
|
||
|
|
"`dbg!` macro is intended as a debugging tool. ensure to avoid having uses of it in version control",
|
||
|
|
);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|