-
-
Notifications
You must be signed in to change notification settings - Fork 472
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(linter): eslint-plugin-react jsx-props-no-spread-multi (#4866)
partof: #1022 docs: https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-props-no-spread-multi.md code: https://github.com/jsx-eslint/eslint-plugin-react/blob/master/lib/rules/jsx-props-no-spread-multi.js test: https://github.com/jsx-eslint/eslint-plugin-react/blob/master/tests/lib/rules/jsx-props-no-spread-multi.js --------- Co-authored-by: Don Isaac <donald.isaac@gmail.com>
- Loading branch information
1 parent
117ae36
commit 93ae1c7
Showing
3 changed files
with
136 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
105 changes: 105 additions & 0 deletions
105
crates/oxc_linter/src/rules/react/jsx_props_no_spread_multi.rs
This file contains 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,105 @@ | ||
use rustc_hash::FxHashMap; | ||
|
||
use oxc_ast::{ast::JSXAttributeItem, AstKind}; | ||
use oxc_diagnostics::OxcDiagnostic; | ||
use oxc_macros::declare_oxc_lint; | ||
use oxc_span::{Atom, Span}; | ||
|
||
use crate::{context::LintContext, rule::Rule, AstNode}; | ||
|
||
fn jsx_props_no_spread_multi_diagnostic(spans: Vec<Span>, prop_name: &str) -> OxcDiagnostic { | ||
OxcDiagnostic::warn("Disallow JSX prop spreading the same identifier multiple times.") | ||
.with_help(format!("Prop '{prop_name}' is spread multiple times.")) | ||
.with_labels(spans) | ||
} | ||
|
||
#[derive(Debug, Default, Clone)] | ||
pub struct JsxPropsNoSpreadMulti; | ||
|
||
declare_oxc_lint!( | ||
/// ### What it does | ||
/// Enforces that any unique expression is only spread once. | ||
/// | ||
/// ### Why is this bad? | ||
/// Generally spreading the same expression twice is an indicator of a mistake since any attribute between the spreads may be overridden when the intent was not to. | ||
/// Even when that is not the case this will lead to unnecessary computations being performed. | ||
/// | ||
/// ### Example | ||
/// ```jsx | ||
/// // Bad | ||
/// <App {...props} myAttr="1" {...props} /> | ||
/// | ||
/// // Good | ||
/// <App myAttr="1" {...props} /> | ||
/// <App {...props} myAttr="1" /> | ||
/// ``` | ||
JsxPropsNoSpreadMulti, | ||
correctness, | ||
pending // TODO: add auto-fix to remove the first spread. Removing the second one would change program behavior. | ||
); | ||
|
||
impl Rule for JsxPropsNoSpreadMulti { | ||
fn run<'a>(&self, node: &AstNode<'a>, ctx: &LintContext<'a>) { | ||
if let AstKind::JSXOpeningElement(jsx_opening_el) = node.kind() { | ||
let spread_attrs = | ||
jsx_opening_el.attributes.iter().filter_map(JSXAttributeItem::as_spread); | ||
|
||
let mut identifier_names: FxHashMap<&Atom, Span> = FxHashMap::default(); | ||
let mut duplicate_spreads: FxHashMap<&Atom, Vec<Span>> = FxHashMap::default(); | ||
|
||
for spread_attr in spread_attrs { | ||
if let Some(identifier_name) = | ||
spread_attr.argument.get_identifier_reference().map(|arg| &arg.name) | ||
{ | ||
identifier_names | ||
.entry(identifier_name) | ||
.and_modify(|first_span| { | ||
duplicate_spreads | ||
.entry(identifier_name) | ||
.or_insert_with(|| vec![*first_span]) | ||
.push(spread_attr.span); | ||
}) | ||
.or_insert(spread_attr.span); | ||
} | ||
} | ||
|
||
for (identifier_name, spans) in duplicate_spreads { | ||
ctx.diagnostic(jsx_props_no_spread_multi_diagnostic(spans, identifier_name)); | ||
} | ||
} | ||
} | ||
} | ||
|
||
#[test] | ||
fn test() { | ||
use crate::tester::Tester; | ||
|
||
let pass = vec![ | ||
" | ||
const a = {}; | ||
<App {...a} /> | ||
", | ||
" | ||
const a = {}; | ||
const b = {}; | ||
<App {...a} {...b} /> | ||
", | ||
]; | ||
|
||
let fail = vec![ | ||
" | ||
const props = {}; | ||
<App {...props} {...props} /> | ||
", | ||
r#" | ||
const props = {}; | ||
<div {...props} a="a" {...props} /> | ||
"#, | ||
" | ||
const props = {}; | ||
<div {...props} {...props} {...props} /> | ||
", | ||
]; | ||
|
||
Tester::new(JsxPropsNoSpreadMulti::NAME, pass, fail).test_and_snapshot(); | ||
} |
29 changes: 29 additions & 0 deletions
29
crates/oxc_linter/src/snapshots/jsx_props_no_spread_multi.snap
This file contains 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,29 @@ | ||
--- | ||
source: crates/oxc_linter/src/tester.rs | ||
--- | ||
⚠ eslint-plugin-react(jsx-props-no-spread-multi): Disallow JSX prop spreading the same identifier multiple times. | ||
╭─[jsx_props_no_spread_multi.tsx:3:16] | ||
2 │ const props = {}; | ||
3 │ <App {...props} {...props} /> | ||
· ────────── ────────── | ||
4 │ | ||
╰──── | ||
help: Prop 'props' is spread multiple times. | ||
|
||
⚠ eslint-plugin-react(jsx-props-no-spread-multi): Disallow JSX prop spreading the same identifier multiple times. | ||
╭─[jsx_props_no_spread_multi.tsx:3:16] | ||
2 │ const props = {}; | ||
3 │ <div {...props} a="a" {...props} /> | ||
· ────────── ────────── | ||
4 │ | ||
╰──── | ||
help: Prop 'props' is spread multiple times. | ||
|
||
⚠ eslint-plugin-react(jsx-props-no-spread-multi): Disallow JSX prop spreading the same identifier multiple times. | ||
╭─[jsx_props_no_spread_multi.tsx:3:16] | ||
2 │ const props = {}; | ||
3 │ <div {...props} {...props} {...props} /> | ||
· ────────── ────────── ────────── | ||
4 │ | ||
╰──── | ||
help: Prop 'props' is spread multiple times. |