rust-clippy/clippy_lints/src/let_if_seq.rs

161 lines
5.9 KiB
Rust
Raw Normal View History

use clippy_utils::diagnostics::span_lint_and_then;
use clippy_utils::source::snippet;
use clippy_utils::{path_to_local_id, visitors::is_local_used};
2018-11-27 20:14:15 +00:00
use if_chain::if_chain;
use rustc_errors::Applicability;
2020-01-06 16:39:50 +00:00
use rustc_hir as hir;
use rustc_hir::BindingAnnotation;
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-03-30 17:53:43 +00:00
2018-03-28 13:24:26 +00:00
declare_clippy_lint! {
/// ### What it does
/// Checks for variable declarations immediately followed by a
/// conditional affectation.
///
/// ### Why is this bad?
/// This is not idiomatic Rust.
///
/// ### Example
/// ```rust,ignore
/// let foo;
///
/// if bar() {
/// foo = 42;
/// } else {
/// foo = 0;
/// }
///
/// let mut baz = None;
///
/// if bar() {
/// baz = Some(42);
/// }
/// ```
///
/// should be written
///
/// ```rust,ignore
/// let foo = if bar() {
/// 42
/// } else {
/// 0
/// };
///
/// let baz = if bar() {
/// Some(42)
/// } else {
/// None
/// };
/// ```
Added `clippy::version` attribute to all normal lints So, some context for this, well, more a story. I'm not used to scripting, I've never really scripted anything, even if it's a valuable skill. I just never really needed it. Now, `@flip1995` correctly suggested using a script for this in `rust-clippy#7813`... And I decided to write a script using nushell because why not? This was a mistake... I spend way more time on this than I would like to admit. It has definitely been more than 4 hours. It shouldn't take that long, but me being new to scripting and nushell just wasn't a good mixture... Anyway, here is the script that creates another script which adds the versions. Fun... Just execute this on the `gh-pages` branch and the resulting `replacer.sh` in `clippy_lints` and it should all work. ```nu mv v0.0.212 rust-1.00.0; mv beta rust-1.57.0; mv master rust-1.58.0; let paths = (open ./rust-1.58.0/lints.json | select id id_span | flatten | select id path); let versions = ( ls | where name =~ "rust-" | select name | format {name}/lints.json | each { open $it | select id | insert version $it | str substring "5,11" version} | group-by id | rotate counter-clockwise id version | update version {get version | first 1} | flatten | select id version); $paths | each { |row| let version = ($versions | where id == ($row.id) | format {version}) let idu = ($row.id | str upcase) $"sed -i '0,/($idu),/{s/pub ($idu),/#[clippy::version = "($version)"]\n pub ($idu),/}' ($row.path)" } | str collect ";" | str find-replace --all '1.00.0' 'pre 1.29.0' | save "replacer.sh"; ``` And this still has some problems, but at this point I just want to be done -.-
2021-10-21 19:06:26 +00:00
#[clippy::version = "pre 1.29.0"]
2016-03-30 17:53:43 +00:00
pub USELESS_LET_IF_SEQ,
nursery,
"unidiomatic `let mut` declaration followed by initialization in `if`"
2016-03-30 17:53:43 +00:00
}
2019-04-08 20:43:55 +00:00
declare_lint_pass!(LetIfSeq => [USELESS_LET_IF_SEQ]);
2016-03-30 17:53:43 +00:00
impl<'tcx> LateLintPass<'tcx> for LetIfSeq {
fn check_block(&mut self, cx: &LateContext<'tcx>, block: &'tcx hir::Block<'_>) {
2016-03-30 17:53:43 +00:00
let mut it = block.stmts.iter().peekable();
2016-08-01 14:59:14 +00:00
while let Some(stmt) = it.next() {
if_chain! {
if let Some(expr) = it.peek();
if let hir::StmtKind::Local(local) = stmt.kind;
2019-09-27 15:16:06 +00:00
if let hir::PatKind::Binding(mode, canonical_id, ident, None) = local.pat.kind;
if let hir::StmtKind::Expr(if_) = expr.kind;
2021-08-08 14:49:13 +00:00
if let hir::ExprKind::If(hir::Expr { kind: hir::ExprKind::DropTemps(cond), ..}, then, else_) = if_.kind;
if !is_local_used(cx, *cond, canonical_id);
if let hir::ExprKind::Block(then, _) = then.kind;
2022-05-29 01:57:15 +00:00
if let Some(value) = check_assign(cx, canonical_id, then);
if !is_local_used(cx, value, canonical_id);
then {
let span = stmt.span.to(if_.span);
2017-11-04 19:55:56 +00:00
2020-07-17 08:47:04 +00:00
let has_interior_mutability = !cx.typeck_results().node_type(canonical_id).is_freeze(
cx.tcx.at(span),
cx.param_env,
);
if has_interior_mutability { return; }
2021-08-08 14:49:13 +00:00
let (default_multi_stmts, default) = if let Some(else_) = else_ {
if let hir::ExprKind::Block(else_, _) = else_.kind {
if let Some(default) = check_assign(cx, canonical_id, else_) {
(else_.stmts.len() > 1, default)
} else if let Some(default) = local.init {
(true, default)
} else {
continue;
}
2016-03-30 17:53:43 +00:00
} else {
continue;
}
} else if let Some(default) = local.init {
(false, default)
2016-03-30 17:53:43 +00:00
} else {
continue;
};
2017-11-04 19:55:56 +00:00
let mutability = match mode {
BindingAnnotation::RefMut | BindingAnnotation::Mutable => "<mut> ",
_ => "",
};
2017-11-04 19:55:56 +00:00
// FIXME: this should not suggest `mut` if we can detect that the variable is not
// use mutably after the `if`
2017-11-04 19:55:56 +00:00
let sug = format!(
"let {mut}{name} = if {cond} {{{then} {value} }} else {{{else} {default} }};",
mut=mutability,
2018-06-28 13:46:58 +00:00
name=ident.name,
cond=snippet(cx, cond.span, "_"),
then=if then.stmts.len() > 1 { " ..;" } else { "" },
else=if default_multi_stmts { " ..;" } else { "" },
value=snippet(cx, value.span, "<value>"),
default=snippet(cx, default.span, "<default>"),
);
span_lint_and_then(cx,
USELESS_LET_IF_SEQ,
span,
"`if _ { .. } else { .. }` is an expression",
|diag| {
diag.span_suggestion(
2018-09-18 15:07:54 +00:00
span,
"it is more idiomatic to write",
sug,
Applicability::HasPlaceholders,
2018-09-18 15:07:54 +00:00
);
if !mutability.is_empty() {
diag.note("you might not need `mut` at all");
}
});
}
}
2016-03-30 17:53:43 +00:00
}
}
}
fn check_assign<'tcx>(
cx: &LateContext<'tcx>,
2019-03-07 20:51:05 +00:00
decl: hir::HirId,
2019-12-27 07:12:26 +00:00
block: &'tcx hir::Block<'_>,
) -> Option<&'tcx hir::Expr<'tcx>> {
if_chain! {
if block.expr.is_none();
if let Some(expr) = block.stmts.iter().last();
if let hir::StmtKind::Semi(expr) = expr.kind;
if let hir::ExprKind::Assign(var, value, _) = expr.kind;
if path_to_local_id(var, decl);
then {
if block.stmts.iter().take(block.stmts.len()-1).any(|stmt| is_local_used(cx, stmt, decl)) {
None
} else {
Some(value)
}
} else {
None
2016-03-30 17:53:43 +00:00
}
}
2016-03-30 17:53:43 +00:00
}