Add new lint unneeded_struct_pattern

This commit is contained in:
Asuna 2024-09-27 02:58:14 +08:00
parent 2ddfc92ea2
commit 52abb8f9f0
9 changed files with 660 additions and 2 deletions

View file

@ -6133,6 +6133,7 @@ Released 2018-09-13
[`unnecessary_unwrap`]: https://rust-lang.github.io/rust-clippy/master/index.html#unnecessary_unwrap
[`unnecessary_wraps`]: https://rust-lang.github.io/rust-clippy/master/index.html#unnecessary_wraps
[`unneeded_field_pattern`]: https://rust-lang.github.io/rust-clippy/master/index.html#unneeded_field_pattern
[`unneeded_struct_pattern`]: https://rust-lang.github.io/rust-clippy/master/index.html#unneeded_struct_pattern
[`unneeded_wildcard_pattern`]: https://rust-lang.github.io/rust-clippy/master/index.html#unneeded_wildcard_pattern
[`unnested_or_patterns`]: https://rust-lang.github.io/rust-clippy/master/index.html#unnested_or_patterns
[`unreachable`]: https://rust-lang.github.io/rust-clippy/master/index.html#unreachable

View file

@ -445,8 +445,8 @@ fn convert_assoc_item_kind(value: AssocItemKind) -> SourceItemOrderingTraitAssoc
#[allow(clippy::enum_glob_use)] // Very local glob use for legibility.
use SourceItemOrderingTraitAssocItemKind::*;
match value {
AssocItemKind::Const { .. } => Const,
AssocItemKind::Type { .. } => Type,
AssocItemKind::Const => Const,
AssocItemKind::Type => Type,
AssocItemKind::Fn { .. } => Fn,
}
}

View file

@ -753,6 +753,7 @@ pub static LINTS: &[&crate::LintInfo] = &[
crate::unnecessary_self_imports::UNNECESSARY_SELF_IMPORTS_INFO,
crate::unnecessary_struct_initialization::UNNECESSARY_STRUCT_INITIALIZATION_INFO,
crate::unnecessary_wraps::UNNECESSARY_WRAPS_INFO,
crate::unneeded_struct_pattern::UNNEEDED_STRUCT_PATTERN_INFO,
crate::unnested_or_patterns::UNNESTED_OR_PATTERNS_INFO,
crate::unsafe_removed_from_name::UNSAFE_REMOVED_FROM_NAME_INFO,
crate::unused_async::UNUSED_ASYNC_INFO,

View file

@ -374,6 +374,7 @@ mod unnecessary_owned_empty_strings;
mod unnecessary_self_imports;
mod unnecessary_struct_initialization;
mod unnecessary_wraps;
mod unneeded_struct_pattern;
mod unnested_or_patterns;
mod unsafe_removed_from_name;
mod unused_async;
@ -967,5 +968,6 @@ pub fn register_lints(store: &mut rustc_lint::LintStore, conf: &'static Conf) {
store.register_late_pass(|_| Box::new(manual_ignore_case_cmp::ManualIgnoreCaseCmp));
store.register_late_pass(|_| Box::new(unnecessary_literal_bound::UnnecessaryLiteralBound));
store.register_late_pass(move |_| Box::new(arbitrary_source_item_ordering::ArbitrarySourceItemOrdering::new(conf)));
store.register_late_pass(|_| Box::new(unneeded_struct_pattern::UnneededStructPattern));
// add lints here, do not remove this comment, it's used in `new_lint`
}

View file

@ -0,0 +1,76 @@
use clippy_utils::diagnostics::span_lint_and_sugg;
use clippy_utils::is_from_proc_macro;
use rustc_errors::Applicability;
use rustc_hir::def::{DefKind, Res};
use rustc_hir::{Pat, PatKind, QPath};
use rustc_lint::{LateContext, LateLintPass};
use rustc_session::declare_lint_pass;
declare_clippy_lint! {
/// ### What it does
/// Checks for struct patterns that match against unit variant.
///
/// ### Why is this bad?
/// Struct pattern `{ }` or `{ .. }` is not needed for unit variant.
///
/// ### Example
/// ```no_run
/// match Some(42) {
/// Some(v) => v,
/// None { .. } => 0,
/// };
/// // Or
/// match Some(42) {
/// Some(v) => v,
/// None { } => 0,
/// };
/// ```
/// Use instead:
/// ```no_run
/// match Some(42) {
/// Some(v) => v,
/// None => 0,
/// };
/// ```
#[clippy::version = "1.83.0"]
pub UNNEEDED_STRUCT_PATTERN,
style,
"using struct pattern to match against unit variant"
}
declare_lint_pass!(UnneededStructPattern => [UNNEEDED_STRUCT_PATTERN]);
impl LateLintPass<'_> for UnneededStructPattern {
fn check_pat(&mut self, cx: &LateContext<'_>, pat: &Pat<'_>) {
if !pat.span.from_expansion()
&& let PatKind::Struct(path, [], _) = &pat.kind
&& let QPath::Resolved(_, path) = path
&& let Res::Def(DefKind::Variant, did) = path.res
{
let enum_did = cx.tcx.parent(did);
let variant = cx.tcx.adt_def(enum_did).variant_with_id(did);
let has_only_fields_brackets = variant.ctor.is_some() && variant.fields.is_empty();
let non_exhaustive_activated = !variant.def_id.is_local() && variant.is_field_list_non_exhaustive();
if !has_only_fields_brackets || non_exhaustive_activated {
return;
}
if is_from_proc_macro(cx, *path) {
return;
}
if let Some(brackets_span) = pat.span.trim_start(path.span) {
span_lint_and_sugg(
cx,
UNNEEDED_STRUCT_PATTERN,
brackets_span,
"struct pattern is not needed for a unit variant",
"remove the struct pattern",
String::new(),
Applicability::MachineApplicable,
);
}
}
}
}

View file

@ -6,3 +6,24 @@ pub enum ErrorKind {
#[doc(hidden)]
Uncategorized,
}
#[non_exhaustive]
pub enum ExtNonExhaustiveEnum {
Unit,
Tuple(i32),
Struct { field: i32 },
}
pub enum ExtNonExhaustiveVariant {
ExhaustiveUnit,
#[non_exhaustive]
Unit,
#[non_exhaustive]
Tuple(i32),
#[non_exhaustive]
StructNoField {},
#[non_exhaustive]
Struct {
field: i32,
},
}

View file

@ -0,0 +1,177 @@
//@aux-build:non-exhaustive-enum.rs
#![allow(
clippy::manual_unwrap_or_default,
clippy::manual_unwrap_or,
clippy::redundant_pattern_matching
)]
#![warn(clippy::unneeded_struct_pattern)]
extern crate non_exhaustive_enum;
use non_exhaustive_enum::*;
fn noop() {}
fn main() {
match Some(114514) {
Some(v) => v,
None => 0,
};
match Some(1919810) {
Some(v) => v,
None => 0,
};
match Some(123456) {
Some(v) => v,
None => 0,
};
match Some(Some(123456)) {
Some(Some(v)) => v,
Some(None) => 0,
None => 0,
};
if let None = Some(0) {}
if let None = Some(0) {}
if let Some(None) = Some(Some(0)) {}
let None = Some(0) else { panic!() };
let None = Some(0) else { panic!() };
let Some(None) = Some(Some(0)) else { panic!() };
enum Custom {
HasFields {
field: i32,
},
HasBracketsNoFields {},
NoBrackets,
#[non_exhaustive]
NoBracketsNonExhaustive,
Init,
};
match Custom::Init {
Custom::HasFields { field: value } => value,
Custom::HasBracketsNoFields {} => 0,
Custom::NoBrackets => 0, //~ ERROR: struct pattern is not needed for a unit variant
Custom::NoBracketsNonExhaustive => 0, //~ ERROR: struct pattern is not needed for a unit variant
_ => 0,
};
match Custom::Init {
Custom::HasFields { field: value } => value,
Custom::HasBracketsNoFields { .. } => 0,
Custom::NoBrackets => 0, //~ ERROR: struct pattern is not needed for a unit variant
Custom::NoBracketsNonExhaustive => 0, //~ ERROR: struct pattern is not needed for a unit variant
_ => 0,
};
match Custom::Init {
Custom::NoBrackets if true => 0, //~ ERROR: struct pattern is not needed for a unit variant
_ => 0,
};
match Custom::Init {
Custom::NoBrackets | Custom::NoBracketsNonExhaustive => 0, //~ ERROR: struct pattern is not needed for a unit variant
_ => 0,
};
if let Custom::HasFields { field: value } = Custom::Init {
noop();
}
if let Custom::HasBracketsNoFields {} = Custom::Init {
noop();
}
if let Custom::HasBracketsNoFields { .. } = Custom::Init {
noop();
}
if let Custom::NoBrackets = Custom::Init {
//~^ ERROR: struct pattern is not needed for a unit variant
noop();
}
if let Custom::NoBrackets = Custom::Init {
//~^ ERROR: struct pattern is not needed for a unit variant
noop();
}
if let Custom::NoBrackets | Custom::NoBracketsNonExhaustive = Custom::Init {
//~^ ERROR: struct pattern is not needed for a unit variant
noop();
}
if let Custom::NoBracketsNonExhaustive = Custom::Init {
//~^ ERROR: struct pattern is not needed for a unit variant
noop();
}
if let Custom::NoBracketsNonExhaustive = Custom::Init {
//~^ ERROR: struct pattern is not needed for a unit variant
noop();
}
let Custom::HasFields { field: value } = Custom::Init else {
panic!()
};
let Custom::HasBracketsNoFields {} = Custom::Init else {
panic!()
};
let Custom::HasBracketsNoFields { .. } = Custom::Init else {
panic!()
};
let Custom::NoBrackets = Custom::Init else { panic!() }; //~ ERROR: struct pattern is not needed for a unit variant
let Custom::NoBrackets = Custom::Init else {
//~^ ERROR: struct pattern is not needed for a unit variant
panic!()
};
let Custom::NoBracketsNonExhaustive = Custom::Init else {
//~^ ERROR: struct pattern is not needed for a unit variant
panic!()
};
let Custom::NoBracketsNonExhaustive = Custom::Init else {
//~^ ERROR: struct pattern is not needed for a unit variant
panic!()
};
enum Refutable {
Variant,
}
fn pat_in_fn_param_1(Refutable::Variant: Refutable) {} //~ ERROR: struct pattern is not needed for a unit variant
fn pat_in_fn_param_2(Refutable::Variant: Refutable) {} //~ ERROR: struct pattern is not needed for a unit variant
for Refutable::Variant in [] {} //~ ERROR: struct pattern is not needed for a unit variant
for Refutable::Variant in [] {} //~ ERROR: struct pattern is not needed for a unit variant
}
fn external_crate() {
use ExtNonExhaustiveVariant::*;
match ExhaustiveUnit {
// Expected
ExhaustiveUnit => 0,
_ => 0,
};
match ExhaustiveUnit {
// Exhaustive variant
ExhaustiveUnit => 0, //~ ERROR: struct pattern is not needed for a unit variant
_ => 0,
};
match ExhaustiveUnit {
// Exhaustive variant
ExhaustiveUnit => 0, //~ ERROR: struct pattern is not needed for a unit variant
_ => 0,
};
match ExhaustiveUnit {
ExhaustiveUnit => 0,
// vvvvv Non-exhaustive variants, should all be ignored
Unit { .. } => 0,
Tuple { 0: field, .. } => field,
StructNoField { .. } => 0,
Struct { field, .. } => field,
_ => 0,
};
}

View file

@ -0,0 +1,177 @@
//@aux-build:non-exhaustive-enum.rs
#![allow(
clippy::manual_unwrap_or_default,
clippy::manual_unwrap_or,
clippy::redundant_pattern_matching
)]
#![warn(clippy::unneeded_struct_pattern)]
extern crate non_exhaustive_enum;
use non_exhaustive_enum::*;
fn noop() {}
fn main() {
match Some(114514) {
Some(v) => v,
None {} => 0,
};
match Some(1919810) {
Some(v) => v,
None { .. } => 0,
};
match Some(123456) {
Some(v) => v,
None => 0,
};
match Some(Some(123456)) {
Some(Some(v)) => v,
Some(None {}) => 0,
None {} => 0,
};
if let None {} = Some(0) {}
if let None { .. } = Some(0) {}
if let Some(None {}) = Some(Some(0)) {}
let None {} = Some(0) else { panic!() };
let None { .. } = Some(0) else { panic!() };
let Some(None {}) = Some(Some(0)) else { panic!() };
enum Custom {
HasFields {
field: i32,
},
HasBracketsNoFields {},
NoBrackets,
#[non_exhaustive]
NoBracketsNonExhaustive,
Init,
};
match Custom::Init {
Custom::HasFields { field: value } => value,
Custom::HasBracketsNoFields {} => 0,
Custom::NoBrackets {} => 0, //~ ERROR: struct pattern is not needed for a unit variant
Custom::NoBracketsNonExhaustive {} => 0, //~ ERROR: struct pattern is not needed for a unit variant
_ => 0,
};
match Custom::Init {
Custom::HasFields { field: value } => value,
Custom::HasBracketsNoFields { .. } => 0,
Custom::NoBrackets { .. } => 0, //~ ERROR: struct pattern is not needed for a unit variant
Custom::NoBracketsNonExhaustive { .. } => 0, //~ ERROR: struct pattern is not needed for a unit variant
_ => 0,
};
match Custom::Init {
Custom::NoBrackets {} if true => 0, //~ ERROR: struct pattern is not needed for a unit variant
_ => 0,
};
match Custom::Init {
Custom::NoBrackets {} | Custom::NoBracketsNonExhaustive {} => 0, //~ ERROR: struct pattern is not needed for a unit variant
_ => 0,
};
if let Custom::HasFields { field: value } = Custom::Init {
noop();
}
if let Custom::HasBracketsNoFields {} = Custom::Init {
noop();
}
if let Custom::HasBracketsNoFields { .. } = Custom::Init {
noop();
}
if let Custom::NoBrackets {} = Custom::Init {
//~^ ERROR: struct pattern is not needed for a unit variant
noop();
}
if let Custom::NoBrackets { .. } = Custom::Init {
//~^ ERROR: struct pattern is not needed for a unit variant
noop();
}
if let Custom::NoBrackets {} | Custom::NoBracketsNonExhaustive {} = Custom::Init {
//~^ ERROR: struct pattern is not needed for a unit variant
noop();
}
if let Custom::NoBracketsNonExhaustive {} = Custom::Init {
//~^ ERROR: struct pattern is not needed for a unit variant
noop();
}
if let Custom::NoBracketsNonExhaustive { .. } = Custom::Init {
//~^ ERROR: struct pattern is not needed for a unit variant
noop();
}
let Custom::HasFields { field: value } = Custom::Init else {
panic!()
};
let Custom::HasBracketsNoFields {} = Custom::Init else {
panic!()
};
let Custom::HasBracketsNoFields { .. } = Custom::Init else {
panic!()
};
let Custom::NoBrackets {} = Custom::Init else { panic!() }; //~ ERROR: struct pattern is not needed for a unit variant
let Custom::NoBrackets { .. } = Custom::Init else {
//~^ ERROR: struct pattern is not needed for a unit variant
panic!()
};
let Custom::NoBracketsNonExhaustive {} = Custom::Init else {
//~^ ERROR: struct pattern is not needed for a unit variant
panic!()
};
let Custom::NoBracketsNonExhaustive { .. } = Custom::Init else {
//~^ ERROR: struct pattern is not needed for a unit variant
panic!()
};
enum Refutable {
Variant,
}
fn pat_in_fn_param_1(Refutable::Variant {}: Refutable) {} //~ ERROR: struct pattern is not needed for a unit variant
fn pat_in_fn_param_2(Refutable::Variant { .. }: Refutable) {} //~ ERROR: struct pattern is not needed for a unit variant
for Refutable::Variant {} in [] {} //~ ERROR: struct pattern is not needed for a unit variant
for Refutable::Variant { .. } in [] {} //~ ERROR: struct pattern is not needed for a unit variant
}
fn external_crate() {
use ExtNonExhaustiveVariant::*;
match ExhaustiveUnit {
// Expected
ExhaustiveUnit => 0,
_ => 0,
};
match ExhaustiveUnit {
// Exhaustive variant
ExhaustiveUnit { .. } => 0, //~ ERROR: struct pattern is not needed for a unit variant
_ => 0,
};
match ExhaustiveUnit {
// Exhaustive variant
ExhaustiveUnit {} => 0, //~ ERROR: struct pattern is not needed for a unit variant
_ => 0,
};
match ExhaustiveUnit {
ExhaustiveUnit => 0,
// vvvvv Non-exhaustive variants, should all be ignored
Unit { .. } => 0,
Tuple { 0: field, .. } => field,
StructNoField { .. } => 0,
Struct { field, .. } => field,
_ => 0,
};
}

View file

@ -0,0 +1,203 @@
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:17:13
|
LL | None {} => 0,
| ^^^ help: remove the struct pattern
|
= note: `-D clippy::unneeded-struct-pattern` implied by `-D warnings`
= help: to override `-D warnings` add `#[allow(clippy::unneeded_struct_pattern)]`
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:22:13
|
LL | None { .. } => 0,
| ^^^^^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:32:18
|
LL | Some(None {}) => 0,
| ^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:33:13
|
LL | None {} => 0,
| ^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:36:16
|
LL | if let None {} = Some(0) {}
| ^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:37:16
|
LL | if let None { .. } = Some(0) {}
| ^^^^^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:38:21
|
LL | if let Some(None {}) = Some(Some(0)) {}
| ^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:39:13
|
LL | let None {} = Some(0) else { panic!() };
| ^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:40:13
|
LL | let None { .. } = Some(0) else { panic!() };
| ^^^^^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:41:18
|
LL | let Some(None {}) = Some(Some(0)) else { panic!() };
| ^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:57:27
|
LL | Custom::NoBrackets {} => 0,
| ^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:58:40
|
LL | Custom::NoBracketsNonExhaustive {} => 0,
| ^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:65:27
|
LL | Custom::NoBrackets { .. } => 0,
| ^^^^^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:66:40
|
LL | Custom::NoBracketsNonExhaustive { .. } => 0,
| ^^^^^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:71:27
|
LL | Custom::NoBrackets {} if true => 0,
| ^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:76:27
|
LL | Custom::NoBrackets {} | Custom::NoBracketsNonExhaustive {} => 0,
| ^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:76:64
|
LL | Custom::NoBrackets {} | Custom::NoBracketsNonExhaustive {} => 0,
| ^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:89:30
|
LL | if let Custom::NoBrackets {} = Custom::Init {
| ^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:93:30
|
LL | if let Custom::NoBrackets { .. } = Custom::Init {
| ^^^^^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:97:30
|
LL | if let Custom::NoBrackets {} | Custom::NoBracketsNonExhaustive {} = Custom::Init {
| ^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:97:67
|
LL | if let Custom::NoBrackets {} | Custom::NoBracketsNonExhaustive {} = Custom::Init {
| ^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:101:43
|
LL | if let Custom::NoBracketsNonExhaustive {} = Custom::Init {
| ^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:105:43
|
LL | if let Custom::NoBracketsNonExhaustive { .. } = Custom::Init {
| ^^^^^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:121:27
|
LL | let Custom::NoBrackets {} = Custom::Init else { panic!() };
| ^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:123:27
|
LL | let Custom::NoBrackets { .. } = Custom::Init else {
| ^^^^^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:127:40
|
LL | let Custom::NoBracketsNonExhaustive {} = Custom::Init else {
| ^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:131:40
|
LL | let Custom::NoBracketsNonExhaustive { .. } = Custom::Init else {
| ^^^^^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:140:44
|
LL | fn pat_in_fn_param_1(Refutable::Variant {}: Refutable) {}
| ^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:141:44
|
LL | fn pat_in_fn_param_2(Refutable::Variant { .. }: Refutable) {}
| ^^^^^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:143:27
|
LL | for Refutable::Variant {} in [] {}
| ^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:144:27
|
LL | for Refutable::Variant { .. } in [] {}
| ^^^^^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:158:23
|
LL | ExhaustiveUnit { .. } => 0,
| ^^^^^^^ help: remove the struct pattern
error: struct pattern is not needed for a unit variant
--> tests/ui/unneeded_struct_pattern.rs:164:23
|
LL | ExhaustiveUnit {} => 0,
| ^^^ help: remove the struct pattern
error: aborting due to 33 previous errors