Skip to content

Commit af1cc5c

Browse files
committed
add suspicious_operation_groupings lint
run `cargo dev new_lint --category correctness --name suspicious_chained_operators --pass early` add (currently failing) tests for suspicious_chained_operators add some tests to answer a question that came up during implementation write usage code for functions we'll need to find or create Complete left-right tracking TODO get it compiling with several `todo!` invocations. refactor to a set of incomplete functions that don't expect to be able to edit a `Span` create placeholder for `suggestion_with_swapped_ident` function and correct some comments add `inside_larger_boolean_expression` test fill out `get_ident` and `suggestion_with_swapped_ident` Implementi the `IdentIter` start on implementing the `IdentIter` handle the `ExprKind::Path` case in `IdentIter` on second thought, make the iterator type dynamic so we don't need an explicit type for each one we will need handle `ExprKind::MacCall` in `IdentIter` Try handling `box x` expressions restructure `IdentIter` set `self.done` when returning `None` Handle `ExprKind::Array` reduce duplication with a macro that we expect to use several more times handle ExprKind::Call add `new_p` convenience method handle `MethodCall` handle `Tup` and `Binary` handle `Unary` simplify by not returning an additional `Expr` from the `IdentIter` add cross product test against false positives rename suspicious_chained_operators to suspicious_operation_groupings within files For the record, the exact commands run were: find . -type f -name "*.md" -exec sed -i 's/suspicious_chained_operators/suspicious_operation_groupings/g' {} + find . -type f -name "*.rs" -exec sed -i 's/suspicious_chained_operators/suspicious_operation_groupings/g' {} + find . -type f -name "*.rs" -exec sed -i 's/SUSPICIOUS_CHAINED_OPERATORS/SUSPICIOUS_OPERATION_GROUPINGS/g' {} + find . -type f -name "*.rs" -exec sed -i 's/SuspiciousChainedOperators/SuspiciousOperationGroupings/g' {} + Also: rename file to match module name rename test file to match lint name start implementing `IdentDifference` creation add `IdentIter` utility use `ident_iter::IdentIter` fix bug in `suggestion_with_swapped_ident` add `inside_if_statements` test implement `Add` `todo`s register `SuspiciousOperationGroupings` lint pass fill in `chained_binops`, and fill in a stopgap version of `ident_difference_expr`, but then notice that the lint does not seem to ever be run in the tests run `cargo dev update_lints` and not that the `suspicious_operation_groupings` lint still does not seem to be run fix base index incrementing bug fix paired_identifiers bug, and remove ident from `Single` change help prefix and note our first successful lint messages! add odd_number_of_pairs test get the `non_boolean_operators` test passing, with two copies of the error message extract `is_useless_with_eq_exprs` so we can know when `eq_op` will already handle something add `not_caught_by_eq_op` tests since `s1.b * s1.b` was (reasonably) not caught by `eq_op` cover the case where the change should be made on either side of the expression with `not_caught_by_eq_op` tests produce the expected suggestion on the `not_caught_by_eq_op_middle_change_left` test confirm that the previous tests still pass and update references fix early continue bug and get `not_caught_by_eq_op_middle_change_right` passing note that `not_caught_by_eq_op_start` already passes fix bugs based on misunderstanding of what `Iterator::skip` does, and note that `not_caught_by_eq_op_end` now passes add several parens tests and make some of them pass handle parens inside `chained_binops_helper` and note that this makes several tests pass get `inside_larger_boolean_expression_with_unsorted_ops` test passing by extracting out `check_same_op_binops` function also run `cargo dev fmt` note that `inside_function_call` already passes add another `if_statement` test remove the matching op requirement, making `inside_larger_boolean_expression_with_unsorted_ops` pass prevent non-change suggestions from being emitted get the `Nested` tests passing, and remove apparently false note about eq_op add a test to justify comment in `ident_difference_expr_with_base_location` but find that the failure mode seems different than expected complete `todo` making `do_not_give_bad_suggestions_for_this_unusual_expr` pass and add some more tests that already pass add test to `eq_op` note that `inside_fn_with_similar_expression` already passes fix `inside_an_if_statement` and note that it already passes attempt to implement if statement extraction and notice that we don't seem to handle unary ops correctly add `maximum_unary_minus_right_tree` test and make it pass add two tests and note one of them passes filter out unary operations in several places, and find that the issue seems to be that we don't currently recognize the error in `multiple_comparison_types_and_unary_minus` even so. remove filtering that was causing bad suggestions remove tests that were deemed too much for now run `cargo dev fmt` correct eq_op post-merge fill out the description and delete debugging code run `cargo dev update_lints` update eq_op references add parens to work around rustfmt issue #3666 and run rustfmt rust-lang/rustfmt#3666 (comment) update references after formatting fix dogfood issues fix multi-cursor edit fix missed dogfood error fix more dogfood pedantic issues, including function length even more nesting insert hidden definition of Vec3 so docs compile add spaces to second struct def reword test description comment Co-authored-by: llogiq <[email protected]> add local `use BinOpKind::*;` Apply suggestions from code review Co-authored-by: llogiq <[email protected]> switch `SUSPICIOUS_OPERATION_GROUPINGS` to a style lint run `cargo dev update_lints` put both usages of `op_types` in the same closure to satisfy `borrowck` fix compile error
1 parent 84ba08f commit af1cc5c

File tree

10 files changed

+1150
-24
lines changed

10 files changed

+1150
-24
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2073,6 +2073,7 @@ Released 2018-09-13
20732073
[`suspicious_else_formatting`]: https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_else_formatting
20742074
[`suspicious_map`]: https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_map
20752075
[`suspicious_op_assign_impl`]: https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_op_assign_impl
2076+
[`suspicious_operation_groupings`]: https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_operation_groupings
20762077
[`suspicious_unary_op_formatting`]: https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_unary_op_formatting
20772078
[`tabs_in_doc_comments`]: https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
20782079
[`temporary_assignment`]: https://rust-lang.github.io/rust-clippy/master/index.html#temporary_assignment

clippy_lints/src/eq_op.rs

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
use crate::utils::{
2-
eq_expr_value, higher, implements_trait, in_macro, is_copy, is_expn_of, multispan_sugg, snippet, span_lint,
3-
span_lint_and_then,
2+
ast_utils::is_useless_with_eq_exprs, eq_expr_value, higher, implements_trait, in_macro, is_copy, is_expn_of,
3+
multispan_sugg, snippet, span_lint, span_lint_and_then,
44
};
55
use if_chain::if_chain;
66
use rustc_errors::Applicability;
7-
use rustc_hir::{BinOp, BinOpKind, BorrowKind, Expr, ExprKind, StmtKind};
7+
use rustc_hir::{BinOpKind, BorrowKind, Expr, ExprKind, StmtKind};
88
use rustc_lint::{LateContext, LateLintPass};
99
use rustc_session::{declare_lint_pass, declare_tool_lint};
1010

@@ -102,7 +102,7 @@ impl<'tcx> LateLintPass<'tcx> for EqOp {
102102
if macro_with_not_op(&left.kind) || macro_with_not_op(&right.kind) {
103103
return;
104104
}
105-
if is_valid_operator(op) && eq_expr_value(cx, left, right) {
105+
if is_useless_with_eq_exprs(higher::binop(op.node)) && eq_expr_value(cx, left, right) {
106106
span_lint(
107107
cx,
108108
EQ_OP,
@@ -245,22 +245,3 @@ impl<'tcx> LateLintPass<'tcx> for EqOp {
245245
}
246246
}
247247
}
248-
249-
fn is_valid_operator(op: BinOp) -> bool {
250-
matches!(
251-
op.node,
252-
BinOpKind::Sub
253-
| BinOpKind::Div
254-
| BinOpKind::Eq
255-
| BinOpKind::Lt
256-
| BinOpKind::Le
257-
| BinOpKind::Gt
258-
| BinOpKind::Ge
259-
| BinOpKind::Ne
260-
| BinOpKind::And
261-
| BinOpKind::Or
262-
| BinOpKind::BitXor
263-
| BinOpKind::BitAnd
264-
| BinOpKind::BitOr
265-
)
266-
}

clippy_lints/src/lib.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,7 @@ mod single_component_path_imports;
308308
mod slow_vector_initialization;
309309
mod stable_sort_primitive;
310310
mod strings;
311+
mod suspicious_operation_groupings;
311312
mod suspicious_trait_impl;
312313
mod swap;
313314
mod tabs_in_doc_comments;
@@ -834,6 +835,7 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
834835
&strings::STRING_LIT_AS_BYTES,
835836
&strings::STRING_TO_STRING,
836837
&strings::STR_TO_STRING,
838+
&suspicious_operation_groupings::SUSPICIOUS_OPERATION_GROUPINGS,
837839
&suspicious_trait_impl::SUSPICIOUS_ARITHMETIC_IMPL,
838840
&suspicious_trait_impl::SUSPICIOUS_OP_ASSIGN_IMPL,
839841
&swap::ALMOST_SWAPPED,
@@ -1066,6 +1068,7 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
10661068
store.register_late_pass(|| box types::UnitArg);
10671069
store.register_late_pass(|| box double_comparison::DoubleComparisons);
10681070
store.register_late_pass(|| box question_mark::QuestionMark);
1071+
store.register_early_pass(|| box suspicious_operation_groupings::SuspiciousOperationGroupings);
10691072
store.register_late_pass(|| box suspicious_trait_impl::SuspiciousImpl);
10701073
store.register_late_pass(|| box map_unit_fn::MapUnit);
10711074
store.register_late_pass(|| box inherent_impl::MultipleInherentImpl::default());
@@ -1547,6 +1550,7 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
15471550
LintId::of(&slow_vector_initialization::SLOW_VECTOR_INITIALIZATION),
15481551
LintId::of(&stable_sort_primitive::STABLE_SORT_PRIMITIVE),
15491552
LintId::of(&strings::STRING_FROM_UTF8_AS_BYTES),
1553+
LintId::of(&suspicious_operation_groupings::SUSPICIOUS_OPERATION_GROUPINGS),
15501554
LintId::of(&suspicious_trait_impl::SUSPICIOUS_ARITHMETIC_IMPL),
15511555
LintId::of(&suspicious_trait_impl::SUSPICIOUS_OP_ASSIGN_IMPL),
15521556
LintId::of(&swap::ALMOST_SWAPPED),
@@ -1698,6 +1702,7 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
16981702
LintId::of(&returns::LET_AND_RETURN),
16991703
LintId::of(&returns::NEEDLESS_RETURN),
17001704
LintId::of(&single_component_path_imports::SINGLE_COMPONENT_PATH_IMPORTS),
1705+
LintId::of(&suspicious_operation_groupings::SUSPICIOUS_OPERATION_GROUPINGS),
17011706
LintId::of(&tabs_in_doc_comments::TABS_IN_DOC_COMMENTS),
17021707
LintId::of(&to_digit_is_some::TO_DIGIT_IS_SOME),
17031708
LintId::of(&try_err::TRY_ERR),

0 commit comments

Comments
 (0)