Skip to content

suggest alternatives to iterate an array of ranges #11862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 25 additions & 10 deletions clippy_lints/src/loops/single_element_loop.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use super::SINGLE_ELEMENT_LOOP;
use clippy_utils::diagnostics::span_lint_and_sugg;
use clippy_utils::source::{indent_of, snippet_with_applicability};
use clippy_utils::source::{indent_of, snippet, snippet_with_applicability};
use clippy_utils::visitors::contains_break_or_continue;
use rustc_ast::util::parser::PREC_PREFIX;
use rustc_ast::Mutability;
Expand Down Expand Up @@ -87,14 +87,29 @@ pub(super) fn check<'tcx>(
arg_snip = format!("({arg_snip})").into();
}

span_lint_and_sugg(
cx,
SINGLE_ELEMENT_LOOP,
expr.span,
"for loop over a single element",
"try",
format!("{{\n{indent}let {pat_snip} = {prefix}{arg_snip};{block_str}}}"),
applicability,
);
if clippy_utils::higher::Range::hir(arg_expression).is_some() {
let range_expr = snippet(cx, arg_expression.span, "?").to_string();

let sugg = snippet(cx, arg_expression.span, "..");
span_lint_and_sugg(
cx,
SINGLE_ELEMENT_LOOP,
arg.span,
format!("this loops only once with `{pat_snip}` being `{range_expr}`").as_str(),
"did you mean to iterate over the range instead?",
sugg.to_string(),
Applicability::Unspecified,
);
} else {
span_lint_and_sugg(
cx,
SINGLE_ELEMENT_LOOP,
expr.span,
"for loop over a single element",
"try",
format!("{{\n{indent}let {pat_snip} = {prefix}{arg_snip};{block_str}}}"),
applicability,
);
}
}
}
12 changes: 4 additions & 8 deletions tests/ui/single_element_loop.fixed
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,19 @@ fn main() {
dbg!(item);
}

{
let item = &(0..5);
for item in 0..5 {
dbg!(item);
}

{
let item = &mut (0..5);
for item in 0..5 {
dbg!(item);
}

{
let item = 0..5;
for item in 0..5 {
dbg!(item);
}

{
let item = 0..5;
for item in 0..5 {
dbg!(item);
}

Expand Down
72 changes: 16 additions & 56 deletions tests/ui/single_element_loop.stderr
Original file line number Diff line number Diff line change
Expand Up @@ -32,69 +32,29 @@ LL + dbg!(item);
LL + }
|

error: for loop over a single element
--> $DIR/single_element_loop.rs:16:5
|
LL | / for item in &[0..5] {
LL | | dbg!(item);
LL | | }
| |_____^
|
help: try
|
LL ~ {
LL + let item = &(0..5);
LL + dbg!(item);
LL + }
error: this loops only once with `item` being `0..5`
--> $DIR/single_element_loop.rs:16:17
|
LL | for item in &[0..5] {
| ^^^^^^^ help: did you mean to iterate over the range instead?: `0..5`

error: for loop over a single element
--> $DIR/single_element_loop.rs:20:5
|
LL | / for item in [0..5].iter_mut() {
LL | | dbg!(item);
LL | | }
| |_____^
|
help: try
|
LL ~ {
LL + let item = &mut (0..5);
LL + dbg!(item);
LL + }
error: this loops only once with `item` being `0..5`
--> $DIR/single_element_loop.rs:20:17
|
LL | for item in [0..5].iter_mut() {
| ^^^^^^^^^^^^^^^^^ help: did you mean to iterate over the range instead?: `0..5`

error: for loop over a single element
--> $DIR/single_element_loop.rs:24:5
|
LL | / for item in [0..5] {
LL | | dbg!(item);
LL | | }
| |_____^
|
help: try
|
LL ~ {
LL + let item = 0..5;
LL + dbg!(item);
LL + }
error: this loops only once with `item` being `0..5`
--> $DIR/single_element_loop.rs:24:17
|
LL | for item in [0..5] {
| ^^^^^^ help: did you mean to iterate over the range instead?: `0..5`

error: for loop over a single element
--> $DIR/single_element_loop.rs:28:5
|
LL | / for item in [0..5].into_iter() {
LL | | dbg!(item);
LL | | }
| |_____^
|
help: try
|
LL ~ {
LL + let item = 0..5;
LL + dbg!(item);
LL + }
error: this loops only once with `item` being `0..5`
--> $DIR/single_element_loop.rs:28:17
|
LL | for item in [0..5].into_iter() {
| ^^^^^^^^^^^^^^^^^^ help: did you mean to iterate over the range instead?: `0..5`

error: for loop over a single element
--> $DIR/single_element_loop.rs:47:5
Expand Down