-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Add new lint unneeded_struct_pattern
#13465
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) { | ||
Centri3 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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, | ||
); | ||
} | ||
} | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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, | ||
}; | ||
} |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.