//! Checks for if expressions that contain only an if expression. //! //! For example, the lint would catch: //! //! ```rust,ignore //! if x { //! if y { //! println!("Hello world"); //! } //! } //! ``` //! //! This lint is **warn** by default use clippy_utils::diagnostics::{span_lint_and_sugg, span_lint_and_then}; use clippy_utils::source::{snippet, snippet_block, snippet_block_with_applicability}; use clippy_utils::sugg::Sugg; use if_chain::if_chain; use rustc_ast::ast; use rustc_errors::Applicability; use rustc_lint::{EarlyContext, EarlyLintPass}; use rustc_session::{declare_lint_pass, declare_tool_lint}; use rustc_span::Span; declare_clippy_lint! { /// ### What it does /// Checks for nested `if` statements which can be collapsed /// by `&&`-combining their conditions. /// /// ### Why is this bad? /// Each `if`-statement adds one level of nesting, which /// makes code look more complex than it really is. /// /// ### Example /// ```rust /// # let (x, y) = (true, true); /// if x { /// if y { /// // … /// } /// } /// ``` /// /// Use instead: /// ```rust /// # let (x, y) = (true, true); /// if x && y { /// // … /// } /// ``` #[clippy::version = "pre 1.29.0"] pub COLLAPSIBLE_IF, style, "nested `if`s that can be collapsed (e.g., `if x { if y { ... } }`" } declare_clippy_lint! { /// ### What it does /// Checks for collapsible `else { if ... }` expressions /// that can be collapsed to `else if ...`. /// /// ### Why is this bad? /// Each `if`-statement adds one level of nesting, which /// makes code look more complex than it really is. /// /// ### Example /// ```rust,ignore /// /// if x { /// … /// } else { /// if y { /// … /// } /// } /// ``` /// /// Should be written: /// /// ```rust,ignore /// if x { /// … /// } else if y { /// … /// } /// ``` #[clippy::version = "1.51.0"] pub COLLAPSIBLE_ELSE_IF, style, "nested `else`-`if` expressions that can be collapsed (e.g., `else { if x { ... } }`)" } declare_lint_pass!(CollapsibleIf => [COLLAPSIBLE_IF, COLLAPSIBLE_ELSE_IF]); impl EarlyLintPass for CollapsibleIf { fn check_expr(&mut self, cx: &EarlyContext<'_>, expr: &ast::Expr) { if !expr.span.from_expansion() { check_if(cx, expr); } } } fn check_if(cx: &EarlyContext<'_>, expr: &ast::Expr) { if let ast::ExprKind::If(check, then, else_) = &expr.kind { if let Some(else_) = else_ { check_collapsible_maybe_if_let(cx, then.span, else_); } else if let ast::ExprKind::Let(..) = check.kind { // Prevent triggering on `if let a = b { if c { .. } }`. } else { check_collapsible_no_if_let(cx, expr, check, then); } } } fn block_starts_with_comment(cx: &EarlyContext<'_>, expr: &ast::Block) -> bool { // We trim all opening braces and whitespaces and then check if the next string is a comment. let trimmed_block_text = snippet_block(cx, expr.span, "..", None) .trim_start_matches(|c: char| c.is_whitespace() || c == '{') .to_owned(); trimmed_block_text.starts_with("//") || trimmed_block_text.starts_with("/*") } fn check_collapsible_maybe_if_let(cx: &EarlyContext<'_>, then_span: Span, else_: &ast::Expr) { if_chain! { if let ast::ExprKind::Block(ref block, _) = else_.kind; if !block_starts_with_comment(cx, block); if let Some(else_) = expr_block(block); if else_.attrs.is_empty(); if !else_.span.from_expansion(); if let ast::ExprKind::If(..) = else_.kind; then { // Prevent "elseif" // Check that the "else" is followed by whitespace let up_to_else = then_span.between(block.span); let requires_space = if let Some(c) = snippet(cx, up_to_else, "..").chars().last() { !c.is_whitespace() } else { false }; let mut applicability = Applicability::MachineApplicable; span_lint_and_sugg( cx, COLLAPSIBLE_ELSE_IF, block.span, "this `else { if .. }` block can be collapsed", "collapse nested if block", format!( "{}{}", if requires_space { " " } else { "" }, snippet_block_with_applicability(cx, else_.span, "..", Some(block.span), &mut applicability) ), applicability, ); } } } fn check_collapsible_no_if_let(cx: &EarlyContext<'_>, expr: &ast::Expr, check: &ast::Expr, then: &ast::Block) { if_chain! { if !block_starts_with_comment(cx, then); if let Some(inner) = expr_block(then); if inner.attrs.is_empty(); if let ast::ExprKind::If(ref check_inner, ref content, None) = inner.kind; // Prevent triggering on `if c { if let a = b { .. } }`. if !matches!(check_inner.kind, ast::ExprKind::Let(..)); let ctxt = expr.span.ctxt(); if inner.span.ctxt() == ctxt; then { span_lint_and_then(cx, COLLAPSIBLE_IF, expr.span, "this `if` statement can be collapsed", |diag| { let mut app = Applicability::MachineApplicable; let lhs = Sugg::ast(cx, check, "..", ctxt, &mut app); let rhs = Sugg::ast(cx, check_inner, "..", ctxt, &mut app); diag.span_suggestion( expr.span, "collapse nested if block", format!( "if {} {}", lhs.and(&rhs), snippet_block(cx, content.span, "..", Some(expr.span)), ), app, // snippet ); }); } } } /// If the block contains only one expression, return it. fn expr_block(block: &ast::Block) -> Option<&ast::Expr> { let mut it = block.stmts.iter(); if let (Some(stmt), None) = (it.next(), it.next()) { match stmt.kind { ast::StmtKind::Expr(ref expr) | ast::StmtKind::Semi(ref expr) => Some(expr), _ => None, } } else { None } }