src/tools/clippy/clippy_lints/src/default_trait_access.rs

   1 use if_chain::if_chain;
   2 use rustc_errors::Applicability;
   3 use rustc_hir::{Expr, ExprKind, QPath};
   4 use rustc_lint::{LateContext, LateLintPass};
   5 use rustc_middle::ty;
   6 use rustc_session::{declare_lint_pass, declare_tool_lint};
   7
   8 use crate::utils::{any_parent_is_automatically_derived, match_def_path, paths, span_lint_and_sugg};
   9
  10 declare_clippy_lint! {
  11     /// **What it does:** Checks for literal calls to `Default::default()`.
  12     ///
  13     /// **Why is this bad?** It's more clear to the reader to use the name of the type whose default is
  14     /// being gotten than the generic `Default`.
  15     ///
  16     /// **Known problems:** None.
  17     ///
  18     /// **Example:**
  19     /// ```rust
  20     /// // Bad
  21     /// let s: String = Default::default();
  22     ///
  23     /// // Good
  24     /// let s = String::default();
  25     /// ```
  26     pub DEFAULT_TRAIT_ACCESS,
  27     pedantic,
  28     "checks for literal calls to `Default::default()`"
  29 }
  30
  31 declare_lint_pass!(DefaultTraitAccess => [DEFAULT_TRAIT_ACCESS]);
  32
  33 impl<'tcx> LateLintPass<'tcx> for DefaultTraitAccess {
  34     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
  35         if_chain! {
  36             if let ExprKind::Call(ref path, ..) = expr.kind;
  37             if !any_parent_is_automatically_derived(cx.tcx, expr.hir_id);
  38             if let ExprKind::Path(ref qpath) = path.kind;
  39             if let Some(def_id) = cx.qpath_res(qpath, path.hir_id).opt_def_id();
  40             if match_def_path(cx, def_id, &paths::DEFAULT_TRAIT_METHOD);
  41             // Detect and ignore <Foo as Default>::default() because these calls do explicitly name the type.
  42             if let QPath::Resolved(None, _path) = qpath;
  43             then {
  44                 let expr_ty = cx.typeck_results().expr_ty(expr);
  45                 if let ty::Adt(def, ..) = expr_ty.kind() {
  46                     // TODO: Work out a way to put "whatever the imported way of referencing
  47                     // this type in this file" rather than a fully-qualified type.
  48                     let replacement = format!("{}::default()", cx.tcx.def_path_str(def.did));
  49                     span_lint_and_sugg(
  50                         cx,
  51                         DEFAULT_TRAIT_ACCESS,
  52                         expr.span,
  53                         &format!("calling `{}` is more clear than this expression", replacement),
  54                         "try",
  55                         replacement,
  56                         Applicability::Unspecified, // First resolve the TODO above
  57                     );
  58                 }
  59             }
  60         }
  61     }
  62 }