feat(eslint-plugin): [no-misused-promises] warn when spreading promises by papermana · Pull Request #5053 · typescript-eslint/typescript-eslint

papermana · 2022-05-23T15:47:19Z

PR Checklist

Addresses an existing open issue: fixes Enhancement: [no-misused-promises] Warn when spreading a promise #5049
That issue was marked as accepting prs
Steps in CONTRIBUTING.md were taken

Overview

This PR adds a new option for no-misused-promises, turned on by default. It will show an error if the code spreads a non-awaited promise (which is almost certainly unintended).

Object.assign could also be supported as an improvement.

typescript-eslint · 2022-05-23T15:47:22Z

Thanks for the PR, @papermana!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

netlify · 2022-05-23T15:47:26Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`f390959`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/628db597fc389d00086ae536
😎 Deploy Preview	https://deploy-preview-5053--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

nx-cloud · 2022-05-23T15:49:37Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit f390959. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 47 targets

Sent with 💌 from NxCloud.

codecov · 2022-05-23T16:22:29Z

Codecov Report

Merging #5053 (b41256c) into main (bc90ce0) will increase coverage by 2.27%.
The diff coverage is 100.00%.

❗ Current head b41256c differs from pull request most recent head f390959. Consider uploading reports for the commit f390959 to get more accurate results

@@            Coverage Diff             @@
##             main    #5053      +/-   ##
==========================================
+ Coverage   91.53%   93.80%   +2.27%     
==========================================
  Files         343      286      -57     
  Lines       10750     9815     -935     
  Branches     3147     2936     -211     
==========================================
- Hits         9840     9207     -633     
+ Misses        588      328     -260     
+ Partials      322      280      -42

Flag	Coverage Δ
unittest	`93.80% <100.00%> (+2.27%)`	⬆️

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

Impacted Files	Coverage Δ
...ges/eslint-plugin/src/rules/no-misused-promises.ts	`98.35% <100.00%> (+0.09%)`	⬆️
packages/eslint-plugin/src/util/misc.ts	`94.00% <0.00%> (-2.43%)`	⬇️
packages/utils/src/json-schema.ts
packages/utils/src/ts-eslint/index.ts
packages/utils/src/eslint-utils/nullThrows.ts
packages/type-utils/src/predicates.ts
packages/type-utils/src/isUnsafeAssignment.ts
packages/type-utils/src/getTypeArguments.ts
packages/type-utils/src/typeFlagUtils.ts
packages/utils/src/ast-utils/misc.ts
... and 49 more

JoshuaKGoldberg

Looks great so far. Thanks for sending this in! Just requesting changes to get a bit more test coverage, particularly around array spreads.

JoshuaKGoldberg

Fantastic, thanks @papermana! 🙌

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.26.0` -> `5.27.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.26.0/5.27.0) | | [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.26.0` -> `5.27.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.26.0/5.27.0) | --- ### Release Notes <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/eslint-plugin)</summary> ### [`v5.27.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5270-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5260v5270-2022-05-30) [Compare Source](typescript-eslint/typescript-eslint@v5.26.0...v5.27.0) ##### Bug Fixes - **eslint-plugin:** \[no-type-alias] handle Template Literal Types ([#5092](typescript-eslint/typescript-eslint#5092)) ([8febf11](typescript-eslint/typescript-eslint@8febf11)) ##### Features - \[4.7] support new extensions ([#5027](typescript-eslint/typescript-eslint#5027)) ([efc147b](typescript-eslint/typescript-eslint@efc147b)) - **eslint-plugin:** \[ban-ts-comment] add descriptionFormat option ([#5026](typescript-eslint/typescript-eslint#5026)) ([1fb31a4](typescript-eslint/typescript-eslint@1fb31a4)) - **eslint-plugin:** \[no-misused-promises] warn when spreading promises ([#5053](typescript-eslint/typescript-eslint#5053)) ([61ffa9e](typescript-eslint/typescript-eslint@61ffa9e)) - **eslint-plugin:** \[space-infix-ops] missing error report for conditional types ([#5041](typescript-eslint/typescript-eslint#5041)) ([0bfab6c](typescript-eslint/typescript-eslint@0bfab6c)) </details> <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/parser)</summary> ### [`v5.27.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5270-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5260v5270-2022-05-30) [Compare Source](typescript-eslint/typescript-eslint@v5.26.0...v5.27.0) ##### Bug Fixes - **types:** remove leftovers from removal of useJSXTextNode ([#5091](typescript-eslint/typescript-eslint#5091)) ([f9c3647](typescript-eslint/typescript-eslint@f9c3647)) ##### Features - \[4.7] support new extensions ([#5027](typescript-eslint/typescript-eslint#5027)) ([efc147b](typescript-eslint/typescript-eslint@efc147b)) </details> --- ### Configuration 📅 **Schedule**: At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1385 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

feat(eslint-plugin): warn when spreading promises

ae2032a

feat(eslint-plugin): fix typo

3083b01

bradzacher added the enhancement New feature or request label May 23, 2022

bradzacher changed the title ~~feat(eslint-plugin): warn when spreading promises~~ feat(eslint-plugin): [no-misused-promises] warn when spreading promises May 23, 2022

JoshuaKGoldberg requested changes May 23, 2022

View reviewed changes

Comment thread packages/eslint-plugin/tests/rules/no-misused-promises.test.ts

bradzacher added the awaiting response Issues waiting for a reply from the OP or another party label May 23, 2022

papermana added 2 commits May 24, 2022 10:18

feat(eslint-plugin): handle logical expressions

bcdbc12

feat(eslint-plugin): test spreading promises in arrays

b41256c

papermana requested a review from JoshuaKGoldberg May 24, 2022 08:24

bradzacher removed the awaiting response Issues waiting for a reply from the OP or another party label May 24, 2022

JoshuaKGoldberg approved these changes May 25, 2022

View reviewed changes

Merge branch 'main' into no-misused-promises-check-object-spread

f390959

JoshuaKGoldberg enabled auto-merge (squash) May 25, 2022 04:50

JoshuaKGoldberg merged commit 61ffa9e into typescript-eslint:main May 25, 2022

papermana deleted the no-misused-promises-check-object-spread branch May 25, 2022 08:11

This was referenced May 25, 2022

Prevent spreading of promises, as it's likely not intended microsoft/TypeScript#49161

Open

chore(eslint-plugin): fix invalid code in promise spread tests #5072

Merged

github-actions Bot locked as resolved and limited conversation to collaborators Jun 25, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(eslint-plugin): [no-misused-promises] warn when spreading promises#5053

feat(eslint-plugin): [no-misused-promises] warn when spreading promises#5053
JoshuaKGoldberg merged 5 commits intotypescript-eslint:mainfrom
papermana:no-misused-promises-check-object-spread

papermana commented May 23, 2022

Uh oh!

typescript-eslint Bot commented May 23, 2022

Uh oh!

netlify Bot commented May 23, 2022 •

edited

Loading

Uh oh!

nx-cloud Bot commented May 23, 2022 •

edited

Loading

Uh oh!

codecov Bot commented May 23, 2022 •

edited

Loading

Uh oh!

JoshuaKGoldberg left a comment •

edited

Loading

Uh oh!

Uh oh!

JoshuaKGoldberg left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

papermana commented May 23, 2022

PR Checklist

Overview

Uh oh!

typescript-eslint Bot commented May 23, 2022

Uh oh!

netlify Bot commented May 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for typescript-eslint ready!

Uh oh!

nx-cloud Bot commented May 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

☁️ Nx Cloud Report

Uh oh!

codecov Bot commented May 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

JoshuaKGoldberg left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

netlify Bot commented May 23, 2022 •

edited

Loading

nx-cloud Bot commented May 23, 2022 •

edited

Loading

codecov Bot commented May 23, 2022 •

edited

Loading

JoshuaKGoldberg left a comment •

edited

Loading