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