2021-03-15 19:55:45 -05:00
|
|
|
use clippy_utils::diagnostics::span_lint_and_sugg;
|
2021-03-16 11:06:34 -05:00
|
|
|
use clippy_utils::method_chain_args;
|
2021-03-14 18:17:44 -05:00
|
|
|
use clippy_utils::source::snippet_with_applicability;
|
2021-03-13 17:01:03 -06:00
|
|
|
use clippy_utils::ty::is_type_diagnostic_item;
|
2018-11-27 21:14:15 +01:00
|
|
|
use if_chain::if_chain;
|
2020-01-10 08:34:13 +09:00
|
|
|
use rustc_errors::Applicability;
|
2020-03-27 15:34:29 +01:00
|
|
|
use rustc_hir::{Expr, ExprKind, MatchSource, PatKind, QPath};
|
2020-01-12 15:08:41 +09:00
|
|
|
use rustc_lint::{LateContext, LateLintPass};
|
2020-01-11 20:37:08 +09:00
|
|
|
use rustc_session::{declare_lint_pass, declare_tool_lint};
|
2020-11-02 10:32:55 -06:00
|
|
|
use rustc_span::sym;
|
2016-10-02 13:48:52 -07:00
|
|
|
|
2018-03-28 15:24:26 +02:00
|
|
|
declare_clippy_lint! {
|
2019-03-05 11:50:33 -05:00
|
|
|
/// **What it does:*** Checks for unnecessary `ok()` in if let.
|
|
|
|
///
|
|
|
|
/// **Why is this bad?** Calling `ok()` in if let is unnecessary, instead match
|
|
|
|
/// on `Ok(pat)`
|
|
|
|
///
|
|
|
|
/// **Known problems:** None.
|
|
|
|
///
|
|
|
|
/// **Example:**
|
2019-03-05 17:23:50 -05:00
|
|
|
/// ```ignore
|
2020-01-04 13:47:01 +09:00
|
|
|
/// for i in iter {
|
|
|
|
/// if let Some(value) = i.parse().ok() {
|
|
|
|
/// vec.push(value)
|
2019-03-05 11:50:33 -05:00
|
|
|
/// }
|
|
|
|
/// }
|
|
|
|
/// ```
|
|
|
|
/// Could be written:
|
|
|
|
///
|
2019-03-05 17:23:50 -05:00
|
|
|
/// ```ignore
|
2020-01-04 13:47:01 +09:00
|
|
|
/// for i in iter {
|
|
|
|
/// if let Ok(value) = i.parse() {
|
|
|
|
/// vec.push(value)
|
2019-03-05 11:50:33 -05:00
|
|
|
/// }
|
|
|
|
/// }
|
|
|
|
/// ```
|
2016-10-02 13:48:52 -07:00
|
|
|
pub IF_LET_SOME_RESULT,
|
2018-03-28 15:24:26 +02:00
|
|
|
style,
|
2016-10-02 14:15:24 -07:00
|
|
|
"usage of `ok()` in `if let Some(pat)` statements is unnecessary, match on `Ok(pat)` instead"
|
2016-10-02 13:48:52 -07:00
|
|
|
}
|
|
|
|
|
2019-04-08 13:43:55 -07:00
|
|
|
declare_lint_pass!(OkIfLet => [IF_LET_SOME_RESULT]);
|
2016-10-02 13:48:52 -07:00
|
|
|
|
2020-06-25 23:41:36 +03:00
|
|
|
impl<'tcx> LateLintPass<'tcx> for OkIfLet {
|
|
|
|
fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
|
2017-10-23 15:18:02 -04:00
|
|
|
if_chain! { //begin checking variables
|
2021-04-02 17:35:32 -04:00
|
|
|
if let ExprKind::Match(op, body, MatchSource::IfLetDesugar { .. }) = expr.kind; //test if expr is if let
|
|
|
|
if let ExprKind::MethodCall(_, ok_span, result_types, _) = op.kind; //check is expr.ok() has type Result<T,E>.ok(, _)
|
|
|
|
if let PatKind::TupleStruct(QPath::Resolved(_, x), y, _) = body[0].pat.kind; //get operation
|
2019-05-17 23:53:54 +02:00
|
|
|
if method_chain_args(op, &["ok"]).is_some(); //test to see if using ok() methoduse std::marker::Sized;
|
2020-11-02 10:32:55 -06:00
|
|
|
if is_type_diagnostic_item(cx, cx.typeck_results().expr_ty(&result_types[0]), sym::result_type);
|
2020-04-12 15:23:07 +02:00
|
|
|
if rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_path(x, false)) == "Some";
|
2017-11-05 04:55:56 +09:00
|
|
|
|
2017-10-23 15:18:02 -04:00
|
|
|
then {
|
2020-01-10 08:34:13 +09:00
|
|
|
let mut applicability = Applicability::MachineApplicable;
|
|
|
|
let some_expr_string = snippet_with_applicability(cx, y[0].span, "", &mut applicability);
|
2020-01-19 10:00:34 +09:00
|
|
|
let trimmed_ok = snippet_with_applicability(cx, op.span.until(ok_span), "", &mut applicability);
|
2020-01-11 04:34:01 +09:00
|
|
|
let sugg = format!(
|
|
|
|
"if let Ok({}) = {}",
|
2020-01-10 08:34:13 +09:00
|
|
|
some_expr_string,
|
2020-01-19 10:00:34 +09:00
|
|
|
trimmed_ok.trim().trim_end_matches('.'),
|
2020-01-10 08:34:13 +09:00
|
|
|
);
|
2020-01-19 21:14:47 +09:00
|
|
|
span_lint_and_sugg(
|
|
|
|
cx,
|
|
|
|
IF_LET_SOME_RESULT,
|
|
|
|
expr.span.with_hi(op.span.hi()),
|
2020-08-11 16:40:45 +02:00
|
|
|
"matching on `Some` with `ok()` is redundant",
|
|
|
|
&format!("consider matching on `Ok({})` and removing the call to `ok` instead", some_expr_string),
|
2020-01-19 21:14:47 +09:00
|
|
|
sugg,
|
|
|
|
applicability,
|
|
|
|
);
|
2016-10-02 13:48:52 -07:00
|
|
|
}
|
2017-10-23 15:18:02 -04:00
|
|
|
}
|
2016-10-02 13:48:52 -07:00
|
|
|
}
|
|
|
|
}
|