Suppress the clippy::type_complexity lint#8313
Conversation
cart
left a comment
There was a problem hiding this comment.
I actively despise needing to copy this everywhere / keep it in sync. But Rust really doesn't give us any other better options here (which is why #7050 got locked up). Maybe rust-lang/rfcs#3389 will save us eventually.
That being said, I still think we should have exactly one source of truth for this. If we're committing to this suppression in every crate, lets remove this from the cargo run -p ci validation list to avoid disparities.
Fix that and I'm on board.
Ahhh this is how we suppress example validation in CI. Sadly we need to live in this nasty middle ground world. |
Objective
The clippy lint
type_complexityis known not to play well with bevy. It frequently triggers when writing complex queries, and taking the lint's advice of using a type alias almost always just obfuscates the code with no benefit. Because of this, this lint is currently ignored in CI, but unfortunately it still shows up when viewing bevy code in an IDE.As someone who's made a fair amount of pull requests to this repo, I will say that this issue has been a consistent thorn in my side. Since bevy code is filled with spurious, ignorable warnings, it can be very difficult to spot the real warnings that must be fixed -- most of the time I just ignore all warnings, only to later find out that one of them was real after I'm done when CI runs.
Solution
Suppress this lint in all bevy crates. This was previously attempted in #7050, but the review process ended up making it more complicated than it needs to be and landed on a subpar solution.
The discussion in rust-lang/rust-clippy#10571 explores some better long-term solutions to this problem. Since there is no timeline on when these solutions may land, we should resolve this issue in the meantime by locally suppressing these lints.
Unresolved issues
Currently, these lints are not suppressed in our examples, since that would require suppressing the lint in every single source file. They are still ignored in CI.