Skip to content

Commit

Permalink
[New] add jsx-props-no-spread-multi
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonSchick authored and ljharb committed Apr 3, 2024
1 parent a944aa5 commit e0f2872
Show file tree
Hide file tree
Showing 6 changed files with 170 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,7 @@ module.exports = [
| [jsx-one-expression-per-line](docs/rules/jsx-one-expression-per-line.md) | Require one JSX element per line | | | 🔧 | | |
| [jsx-pascal-case](docs/rules/jsx-pascal-case.md) | Enforce PascalCase for user-defined JSX components | | | | | |
| [jsx-props-no-multi-spaces](docs/rules/jsx-props-no-multi-spaces.md) | Disallow multiple spaces between inline JSX props | | | 🔧 | | |
| [jsx-props-no-spread-multi](docs/rules/jsx-props-no-spread-multi.md) | Disallow JSX prop spreading the same expression multiple times | | | | | |
| [jsx-props-no-spreading](docs/rules/jsx-props-no-spreading.md) | Disallow JSX prop spreading | | | | | |
| [jsx-sort-default-props](docs/rules/jsx-sort-default-props.md) | Enforce defaultProps declarations alphabetical sorting | | | | ||
| [jsx-sort-props](docs/rules/jsx-sort-props.md) | Enforce props alphabetical sorting | | | 🔧 | | |
Expand Down
25 changes: 25 additions & 0 deletions docs/rules/jsx-props-no-spread-multi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Disallow JSX prop spreading the same expression multiple times (`react/jsx-props-no-spread-multi`)

<!-- end auto-generated rule header -->

Enforces that any unique express is only spread once. 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 to be performed.

## Rule Details

Examples of **incorrect** code for this rule:

```jsx
<App {...props} myAttr="1" {...props} />
```

Examples of **correct** code for this rule:

```jsx
<App myAttr="1" {...props} />
<App {...props} myAttr="1" />
```

## When Not To Use It

When spreading the same expression yields different values.
1 change: 1 addition & 0 deletions lib/rules/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ module.exports = {
'jsx-fragments': require('./jsx-fragments'),
'jsx-props-no-multi-spaces': require('./jsx-props-no-multi-spaces'),
'jsx-props-no-spreading': require('./jsx-props-no-spreading'),
'jsx-props-no-spread-multi': require('./jsx-props-no-spread-multi'),
'jsx-sort-default-props': require('./jsx-sort-default-props'),
'jsx-sort-props': require('./jsx-sort-props'),
'jsx-space-before-closing': require('./jsx-space-before-closing'),
Expand Down
63 changes: 63 additions & 0 deletions lib/rules/jsx-props-no-spread-multi.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
/**
* @fileoverview Prevent JSX prop spreading the same expression multiple times
* @author Simon Schick
*/

'use strict';

const docsUrl = require('../util/docsUrl');
const report = require('../util/report');

// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------

const messages = {
noMultiSpreading: 'Spreading the same expression multiple times is forbidden',
};

const ignoredAstProperties = new Set(['parent', 'range', 'loc', 'start', 'end', '_babelType']);

/**
* Filter for JSON.stringify that omits circular and position structures.
*
* @param {string} key
* @param {*} value
* @returns {*}
*/
const propertyFilter = (key, value) => (ignoredAstProperties.has(key) ? undefined : value);

module.exports = {
meta: {
docs: {
description: 'Disallow JSX prop spreading the same expression multiple times',
category: 'Best Practices',
recommended: false,
url: docsUrl('jsx-props-no-spread-multi'),
},
messages,
},

create(context) {
return {
JSXOpeningElement(node) {
const spreads = node.attributes.filter((attr) => attr.type === 'JSXSpreadAttribute');
if (spreads.length < 2) {
return;
}
// We detect duplicate expressions by hashing the ast nodes
const argumentHashes = new Set();
for (const spread of spreads) {
// TODO: Deep compare ast function?
const hash = JSON.stringify(spread.argument, propertyFilter);
if (argumentHashes.has(hash)) {
report(context, messages.noMultiSpreading, 'noMultiSpreading', {
node: spread,
});
}
argumentHashes.add(hash);
}
},
};
},
};
3 changes: 2 additions & 1 deletion lib/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@ declare global {
type JSXAttribute = ASTNode;
type JSXElement = ASTNode;
type JSXFragment = ASTNode;
type JSXOpeningElement = ASTNode;
type JSXSpreadAttribute = ASTNode;

type Context = eslint.Rule.RuleContext
type Context = eslint.Rule.RuleContext;

type TypeDeclarationBuilder = (annotation: ASTNode, parentName: string, seen: Set<typeof annotation>) => object;

Expand Down
78 changes: 78 additions & 0 deletions tests/lib/rules/jsx-props-no-spread-multi.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
/**
* @fileoverview Tests for jsx-props-no-spread-multi
*/

'use strict';

// -----------------------------------------------------------------------------
// Requirements
// -----------------------------------------------------------------------------

const RuleTester = require('eslint').RuleTester;
const rule = require('../../../lib/rules/jsx-props-no-spread-multi');

const parsers = require('../../helpers/parsers');

const parserOptions = {
ecmaVersion: 2018,
sourceType: 'module',
ecmaFeatures: {
jsx: true,
},
};

// -----------------------------------------------------------------------------
// Tests
// -----------------------------------------------------------------------------

const ruleTester = new RuleTester({ parserOptions });
const expectedError = { messageId: 'noMultiSpreading' };

ruleTester.run('jsx-props-no-spread-multi', rule, {
valid: parsers.all([
{
code: `
const a = {};
<App {...a} />
`,
},
{
code: `
const a = {};
const b = {};
<App {...a} {...b} />
`,
},
]),

invalid: parsers.all([
{
code: `
const props = {};
<App {...props} {...props} />
`,
errors: [expectedError],
},
{
code: `
const props = {};
<div {...props} a="a" {...props} />
`,
errors: [expectedError],
},
{
code: `
const props = {};
<div {...props} {...props} {...props} />
`,
errors: [expectedError, expectedError],
},
{
code: `
const func = () => ({});
<div {...func()} {...func()} />
`,
errors: [expectedError],
},
]),
});

0 comments on commit e0f2872

Please sign in to comment.