clippy_lints/src/collapsible_if.rs

   1 //! Checks for if expressions that contain only an if expression.
   2 //!
   3 //! For example, the lint would catch:
   4 //!
   5 //! ```rust,ignore
   6 //! if x {
   7 //!     if y {
   8 //!         println!("Hello world");
   9 //!     }
  10 //! }
  11 //! ```
  12 //!
  13 //! This lint is **warn** by default
  14
  15 use if_chain::if_chain;
  16 use rustc_lint::{EarlyContext, EarlyLintPass};
  17 use rustc_session::{declare_lint_pass, declare_tool_lint};
  18 use syntax::ast;
  19
  20 use crate::utils::sugg::Sugg;
  21 use crate::utils::{snippet_block, snippet_block_with_applicability, span_lint_and_sugg, span_lint_and_then};
  22 use rustc_errors::Applicability;
  23
  24 declare_clippy_lint! {
  25     /// **What it does:** Checks for nested `if` statements which can be collapsed
  26     /// by `&&`-combining their conditions and for `else { if ... }` expressions
  27     /// that
  28     /// can be collapsed to `else if ...`.
  29     ///
  30     /// **Why is this bad?** Each `if`-statement adds one level of nesting, which
  31     /// makes code look more complex than it really is.
  32     ///
  33     /// **Known problems:** None.
  34     ///
  35     /// **Example:**
  36     /// ```rust,ignore
  37     /// if x {
  38     ///     if y {
  39     ///         …
  40     ///     }
  41     /// }
  42     ///
  43     /// // or
  44     ///
  45     /// if x {
  46     ///     …
  47     /// } else {
  48     ///     if y {
  49     ///         …
  50     ///     }
  51     /// }
  52     /// ```
  53     ///
  54     /// Should be written:
  55     ///
  56     /// ```rust.ignore
  57     /// if x && y {
  58     ///     …
  59     /// }
  60     ///
  61     /// // or
  62     ///
  63     /// if x {
  64     ///     …
  65     /// } else if y {
  66     ///     …
  67     /// }
  68     /// ```
  69     pub COLLAPSIBLE_IF,
  70     style,
  71     "`if`s that can be collapsed (e.g., `if x { if y { ... } }` and `else { if x { ... } }`)"
  72 }
  73
  74 declare_lint_pass!(CollapsibleIf => [COLLAPSIBLE_IF]);
  75
  76 impl EarlyLintPass for CollapsibleIf {
  77     fn check_expr(&mut self, cx: &EarlyContext<'_>, expr: &ast::Expr) {
  78         if !expr.span.from_expansion() {
  79             check_if(cx, expr)
  80         }
  81     }
  82 }
  83
  84 fn check_if(cx: &EarlyContext<'_>, expr: &ast::Expr) {
  85     if let ast::ExprKind::If(check, then, else_) = &expr.kind {
  86         if let Some(else_) = else_ {
  87             check_collapsible_maybe_if_let(cx, else_);
  88         } else if let ast::ExprKind::Let(..) = check.kind {
  89             // Prevent triggering on `if let a = b { if c { .. } }`.
  90         } else {
  91             check_collapsible_no_if_let(cx, expr, check, then);
  92         }
  93     }
  94 }
  95
  96 fn block_starts_with_comment(cx: &EarlyContext<'_>, expr: &ast::Block) -> bool {
  97     // We trim all opening braces and whitespaces and then check if the next string is a comment.
  98     let trimmed_block_text = snippet_block(cx, expr.span, "..", None)
  99         .trim_start_matches(|c: char| c.is_whitespace() || c == '{')
 100         .to_owned();
 101     trimmed_block_text.starts_with("//") || trimmed_block_text.starts_with("/*")
 102 }
 103
 104 fn check_collapsible_maybe_if_let(cx: &EarlyContext<'_>, else_: &ast::Expr) {
 105     if_chain! {
 106         if let ast::ExprKind::Block(ref block, _) = else_.kind;
 107         if !block_starts_with_comment(cx, block);
 108         if let Some(else_) = expr_block(block);
 109         if !else_.span.from_expansion();
 110         if let ast::ExprKind::If(..) = else_.kind;
 111         then {
 112             let mut applicability = Applicability::MachineApplicable;
 113             span_lint_and_sugg(
 114                 cx,
 115                 COLLAPSIBLE_IF,
 116                 block.span,
 117                 "this `else { if .. }` block can be collapsed",
 118                 "try",
 119                 snippet_block_with_applicability(cx, else_.span, "..", Some(block.span), &mut applicability).into_owned(),
 120                 applicability,
 121             );
 122         }
 123     }
 124 }
 125
 126 fn check_collapsible_no_if_let(cx: &EarlyContext<'_>, expr: &ast::Expr, check: &ast::Expr, then: &ast::Block) {
 127     if_chain! {
 128         if !block_starts_with_comment(cx, then);
 129         if let Some(inner) = expr_block(then);
 130         if let ast::ExprKind::If(ref check_inner, ref content, None) = inner.kind;
 131         then {
 132             if let ast::ExprKind::Let(..) = check_inner.kind {
 133                 // Prevent triggering on `if c { if let a = b { .. } }`.
 134                 return;
 135             }
 136
 137             if expr.span.ctxt() != inner.span.ctxt() {
 138                 return;
 139             }
 140             span_lint_and_then(cx, COLLAPSIBLE_IF, expr.span, "this `if` statement can be collapsed", |db| {
 141                 let lhs = Sugg::ast(cx, check, "..");
 142                 let rhs = Sugg::ast(cx, check_inner, "..");
 143                 db.span_suggestion(
 144                     expr.span,
 145                     "try",
 146                     format!(
 147                         "if {} {}",
 148                         lhs.and(&rhs),
 149                         snippet_block(cx, content.span, "..", Some(expr.span)),
 150                     ),
 151                     Applicability::MachineApplicable, // snippet
 152                 );
 153             });
 154         }
 155     }
 156 }
 157
 158 /// If the block contains only one expression, return it.
 159 fn expr_block(block: &ast::Block) -> Option<&ast::Expr> {
 160     let mut it = block.stmts.iter();
 161
 162     if let (Some(stmt), None) = (it.next(), it.next()) {
 163         match stmt.kind {
 164             ast::StmtKind::Expr(ref expr) | ast::StmtKind::Semi(ref expr) => Some(expr),
 165             _ => None,
 166         }
 167     } else {
 168         None
 169     }
 170 }