feat(eslint-plugin): [no-misused-spread] add new rule #10551

JoshuaKGoldberg · 2024-12-26T17:11:53Z

PR Checklist

Addresses an existing open issue: fixes Rule proposal: prevent array, iterable and function spreads into objects #748
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

Continuation of @StyleShit's #8509 as indicated in #8443 (comment).

Co-authored-by: @StyleShit

Closes typescript-eslint#748

…sused-spread

packages/eslint-plugin/docs/rules/no-misused-spread.mdx

ronami

Really excited to enable this on some of the projects I work on 🎉

packages/eslint-plugin/src/rules/no-misused-spread.ts

ronami · 2024-12-27T18:09:22Z

packages/eslint-plugin/src/rules/no-misused-spread.ts

+      noArraySpreadInObject:
+        'Using the spread operator on an array in an object will result in a list of indices.',
+      noClassDeclarationSpreadInObject:
+        'Using the spread operator on class declarations will spread only their static properties, and will lose their class prototype.',
+      noClassInstanceSpreadInObject:
+        'Using the spread operator on class instances will lose their class prototype.',
+      noFunctionSpreadInObject:
+        'Using the spread operator on a function without additional properties can cause unexpected behavior. Did you forget to call the function?',
+      noIterableSpreadInObject:
+        'Using the spread operator on an Iterable in an object can cause unexpected behavior.',
+      noMapSpreadInObject:
+        'Using the spread operator on a Map in an object will result in an empty object. Did you mean to use `Object.fromEntries(map)` instead?',
+      noPromiseSpreadInObject:
+        'Using the spread operator on Promise in an object can cause unexpected behavior. Did you forget to await the promise?',
+      noStringSpreadInArray:
+        "Using the spread operator on a string can cause unexpected behavior. Prefer `String.split('')` instead.",


[Feat]: What do you think about adding a suggestion fixer for some of these? Some of the error messages suggest a particular way of fixing the warning.

I really like the idea, but think it will end up being tricky like a lot of suggestion fixers. Would you be ok with it as a followup?

Sure, that sounds great 👍

For posterity: #10642

packages/eslint-plugin/src/rules/no-misused-spread.ts

codecov · 2024-12-29T08:47:13Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.95%. Comparing base (d63ea3b) to head (b52123d).
Report is 16 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #10551      +/-   ##
==========================================
+ Coverage   86.90%   86.95%   +0.05%     
==========================================
  Files         446      447       +1     
  Lines       15505    15566      +61     
  Branches     4517     4535      +18     
==========================================
+ Hits        13475    13536      +61     
  Misses       1675     1675              
  Partials      355      355

Flag	Coverage Δ
unittest	`86.95% <100.00%> (+0.05%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...kages/eslint-plugin/src/rules/no-misused-spread.ts	`100.00% <100.00%> (ø)`

ronami

Looks amazing, thank you 🥇

@yeonjuan

##### [v8.20.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8200-2025-01-13) ##### 🚀 Features - **eslint-plugin:** \[consistent-type-assertions] add arrayLiteralTypeAssertions options ([#10565](typescript-eslint/typescript-eslint#10565)) - **eslint-plugin:** \[no-deprecated] add allow options ([#10585](typescript-eslint/typescript-eslint#10585)) - **eslint-plugin:** \[no-misused-spread] add new rule ([#10551](typescript-eslint/typescript-eslint#10551)) ##### 🩹 Fixes - **eslint-plugin:** \[no-unnecessary-condition] don't flag optional chaining for union types with an unconstrained type parameters ([#10602](typescript-eslint/typescript-eslint#10602)) - **eslint-plugin:** \[no-shadow] ignore ordering of type declarations ([#10593](typescript-eslint/typescript-eslint#10593)) ##### ❤️ Thank You - Josh Goldberg ✨ - Ronen Amiel - YeonJuan [@yeonjuan](https://github.com/yeonjuan) You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

@yeonjuan

##### [v8.20.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8200-2025-01-13) ##### 🚀 Features - **eslint-plugin:** \[consistent-type-assertions] add arrayLiteralTypeAssertions options ([#10565](typescript-eslint/typescript-eslint#10565)) - **eslint-plugin:** \[no-deprecated] add allow options ([#10585](typescript-eslint/typescript-eslint#10585)) - **eslint-plugin:** \[no-misused-spread] add new rule ([#10551](typescript-eslint/typescript-eslint#10551)) ##### 🩹 Fixes - **eslint-plugin:** \[no-unnecessary-condition] don't flag optional chaining for union types with an unconstrained type parameters ([#10602](typescript-eslint/typescript-eslint#10602)) - **eslint-plugin:** \[no-shadow] ignore ordering of type declarations ([#10593](typescript-eslint/typescript-eslint#10593)) ##### ❤️ Thank You - Josh Goldberg ✨ - Ronen Amiel - YeonJuan [@yeonjuan](https://github.com/yeonjuan) You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

@yeonjuan

##### [v8.20.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8200-2025-01-13) ##### 🚀 Features - **eslint-plugin:** \[consistent-type-assertions] add arrayLiteralTypeAssertions options ([#10565](typescript-eslint/typescript-eslint#10565)) - **eslint-plugin:** \[no-deprecated] add allow options ([#10585](typescript-eslint/typescript-eslint#10585)) - **eslint-plugin:** \[no-misused-spread] add new rule ([#10551](typescript-eslint/typescript-eslint#10551)) ##### 🩹 Fixes - **eslint-plugin:** \[no-unnecessary-condition] don't flag optional chaining for union types with an unconstrained type parameters ([#10602](typescript-eslint/typescript-eslint#10602)) - **eslint-plugin:** \[no-shadow] ignore ordering of type declarations ([#10593](typescript-eslint/typescript-eslint#10593)) ##### ❤️ Thank You - Josh Goldberg ✨ - Ronen Amiel - YeonJuan [@yeonjuan](https://github.com/yeonjuan) You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

@yeonjuan

##### [v8.20.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8200-2025-01-13) ##### 🚀 Features - **eslint-plugin:** \[consistent-type-assertions] add arrayLiteralTypeAssertions options ([#10565](typescript-eslint/typescript-eslint#10565)) - **eslint-plugin:** \[no-deprecated] add allow options ([#10585](typescript-eslint/typescript-eslint#10585)) - **eslint-plugin:** \[no-misused-spread] add new rule ([#10551](typescript-eslint/typescript-eslint#10551)) ##### 🩹 Fixes - **eslint-plugin:** \[no-unnecessary-condition] don't flag optional chaining for union types with an unconstrained type parameters ([#10602](typescript-eslint/typescript-eslint#10602)) - **eslint-plugin:** \[no-shadow] ignore ordering of type declarations ([#10593](typescript-eslint/typescript-eslint#10593)) ##### ❤️ Thank You - Josh Goldberg ✨ - Ronen Amiel - YeonJuan [@yeonjuan](https://github.com/yeonjuan) You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

boris-petrov · 2025-01-15T05:51:04Z

Once I updated, I got a conflict with unicorn/prefer-spread. They link to a comment in SO where the first example is:

// DO NOT USE THIS!
const a = '𝟘𝟙𝟚𝟛'.split('');
console.log(a);
// Output: ["�","�","�","�","�","�","�","�"]

So... who do I believe? 😄

bradzacher · 2025-01-15T09:57:29Z

As per our contributing guide - please don't comment on closed PRs. If you think the rule is wrong, please file an issue and we can discuss there.

StyleShit added 30 commits February 19, 2024 22:32

feat(eslint-plugin): [no-misused-spread] add new rule

75812fc

Closes typescript-eslint#748

fix docs

f18acb8

add tests

22a50e5

wip

985795a

fix functions

3ff215f

Merge remote-tracking branch 'typescript-eslint/main' into feat/no-mi…

8e760e0

…sused-spread

Merge remote-tracking branch 'typescript-eslint/main' into feat/no-mi…

5f9fae6

…sused-spread

change type name to Iterable

990006f

wip

49692d2

Merge remote-tracking branch 'typescript-eslint/main' into feat/no-mi…

1f76659

…sused-spread

fix lint

c45038f

Merge remote-tracking branch 'typescript-eslint/main' into feat/no-mi…

a12c9ff

…sused-spread

wip

9f07bc1

Merge remote-tracking branch 'typescript-eslint/main' into feat/no-mi…

ab20e73

…sused-spread

Merge remote-tracking branch 'typescript-eslint/main' into feat/no-mi…

3ef5a45

…sused-spread

wip

b97a397

don't flag strings spread in object

e02d7a9

Merge remote-tracking branch 'typescript-eslint/main' into feat/no-mi…

26434c3

…sused-spread

wip

0921b80

wip

b8d7e47

configs

3f9d545

snapshot

b133698

Merge remote-tracking branch 'typescript-eslint/main' into feat/no-mi…

c449dba

…sused-spread

add options

bb3031f

better message

99c67a0

add map

ef12015

messages

c3fa340

array

bc3bcf2

promise + iterable

137c371

class declaration

db72726

JoshuaKGoldberg added 3 commits December 26, 2024 14:43

empty

f49b88f

Fix .mdx docs test

e1e9c2c

Separate TSConfig for DOM

b0c3919

JoshuaKGoldberg requested a review from a team December 26, 2024 19:48

JoshuaKGoldberg force-pushed the no-misused-spread-ii-electric-boogaloo branch from 61e64b5 to b0c3919 Compare December 26, 2024 20:04

omril1 reviewed Dec 27, 2024

View reviewed changes

packages/eslint-plugin/docs/rules/no-misused-spread.mdx Outdated Show resolved Hide resolved

ronami requested changes Dec 27, 2024

View reviewed changes

ronami mentioned this pull request Dec 27, 2024

fix(eslint-plugin): [no-for-in-array] report on any type which may be an array or array-like #10535

Merged

3 tasks

JoshuaKGoldberg added 5 commits December 29, 2024 02:57

Handle function call spreads too

ca44d93

Test constrained type params too

b0d94e8

Spring

f3dbde3

Union type tests

6031579

Update docs snapshot as well

5e217c9

JoshuaKGoldberg mentioned this pull request Dec 30, 2024

Rule proposal: Prevent Object.values(...) usage with Map #6807

Open

6 tasks

JoshuaKGoldberg added 2 commits January 2, 2025 23:02

Merge branch 'main' into no-misused-spread-ii-electric-boogaloo

b8a15a1

HTMLElementLike

b52123d

JoshuaKGoldberg requested a review from ronami January 7, 2025 15:38

ronami approved these changes Jan 7, 2025

View reviewed changes

JoshuaKGoldberg added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Jan 13, 2025

JoshuaKGoldberg merged commit 04166e0 into typescript-eslint:main Jan 13, 2025
65 checks passed

JoshuaKGoldberg deleted the no-misused-spread-ii-electric-boogaloo branch January 13, 2025 00:04

JoshuaKGoldberg mentioned this pull request Jan 13, 2025

Enhancement: [no-misused-spread] Add suggestion fixers #10642

Closed

4 tasks

typescript-eslint locked and limited conversation to collaborators Jan 15, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(eslint-plugin): [no-misused-spread] add new rule #10551

feat(eslint-plugin): [no-misused-spread] add new rule #10551

JoshuaKGoldberg commented Dec 26, 2024

ronami left a comment

ronami Dec 27, 2024

JoshuaKGoldberg Dec 29, 2024

ronami Dec 29, 2024

JoshuaKGoldberg Jan 31, 2025

codecov bot commented Dec 29, 2024 •

edited

Loading

ronami left a comment

boris-petrov commented Jan 15, 2025

bradzacher commented Jan 15, 2025

feat(eslint-plugin): [no-misused-spread] add new rule #10551

feat(eslint-plugin): [no-misused-spread] add new rule #10551

Conversation

JoshuaKGoldberg commented Dec 26, 2024

PR Checklist

Overview

ronami left a comment

Choose a reason for hiding this comment

ronami Dec 27, 2024

Choose a reason for hiding this comment

JoshuaKGoldberg Dec 29, 2024

Choose a reason for hiding this comment

ronami Dec 29, 2024

Choose a reason for hiding this comment

JoshuaKGoldberg Jan 31, 2025

Choose a reason for hiding this comment

codecov bot commented Dec 29, 2024 • edited Loading

Codecov Report

ronami left a comment

Choose a reason for hiding this comment

boris-petrov commented Jan 15, 2025

bradzacher commented Jan 15, 2025

codecov bot commented Dec 29, 2024 •

edited

Loading