rust-lang/rust-clippy

Manual assert_eq! (enhance `if_then_panic`)

Open

#7,716 opened on Sep 24, 2021

View on GitHub
 (7 comments) (0 reactions) (1 assignee)Rust (10,406 stars) (1,391 forks)batch import
C-enhancementgood first issue

Description

We just added if_then_panic, but then I realized there's a possible enhancement for assert_eq!/assert_ne!:

// before
if a != b {
    panic!("hi");
}
// after
assert_eq!(a, b, "hi");

I think a rename to manual_assert would be best. But we could also keep the current name (it still kinda makes sense) or create a new lint for this case.

Contributor guide

Tech stack
rust
Domain
toolingdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Rust programmingclippy internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Explore the existing `if then panic` lint implementation in rust clippy. The issue suggests enhancing it to also trigger on `assert eq!`/`assert ne!` patterns. The main decision is whether to rename the lint to `manual assert`, keep the current name, or create a new lint. Look at the discussion in the comments and the PR #7669 for context. The assigned user is Labelray, so check their progress or comments. The implementation would involve adding a new pattern match in the lint logic. See files like `clippy lints/src/if then panic.rs` for reference.
Manual assert_eq! (enhance `if_then_panic`) · rust-lang/rust-clippy#7716 | Good First Issue