Skip to content
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

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

Conversation

papermana
Copy link
Contributor

PR Checklist

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
Copy link
Contributor

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
Copy link

netlify bot commented May 23, 2022

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...

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
Copy link

nx-cloud bot commented May 23, 2022

☁️ 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.

@bradzacher bradzacher added the enhancement New feature or request label May 23, 2022
@codecov
Copy link

codecov bot commented May 23, 2022

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

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

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@bradzacher bradzacher added the awaiting response Issues waiting for a reply from the OP or another party label May 23, 2022
@bradzacher bradzacher removed the awaiting response Issues waiting for a reply from the OP or another party label May 24, 2022
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastic, thanks @papermana! 🙌

@JoshuaKGoldberg JoshuaKGoldberg enabled auto-merge (squash) May 25, 2022 04:50
@JoshuaKGoldberg JoshuaKGoldberg merged commit 61ffa9e into typescript-eslint:main May 25, 2022
@papermana papermana deleted the no-misused-promises-check-object-spread branch May 25, 2022 08:11
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request Jun 5, 2022
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 (@&#8203;typescript-eslint/eslint-plugin)</summary>

### [`v5.27.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;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 ([#&#8203;5092](typescript-eslint/typescript-eslint#5092)) ([8febf11](typescript-eslint/typescript-eslint@8febf11))

##### Features

-   \[4.7] support new extensions ([#&#8203;5027](typescript-eslint/typescript-eslint#5027)) ([efc147b](typescript-eslint/typescript-eslint@efc147b))
-   **eslint-plugin:** \[ban-ts-comment] add descriptionFormat option ([#&#8203;5026](typescript-eslint/typescript-eslint#5026)) ([1fb31a4](typescript-eslint/typescript-eslint@1fb31a4))
-   **eslint-plugin:** \[no-misused-promises] warn when spreading promises ([#&#8203;5053](typescript-eslint/typescript-eslint#5053)) ([61ffa9e](typescript-eslint/typescript-eslint@61ffa9e))
-   **eslint-plugin:** \[space-infix-ops] missing error report for conditional types ([#&#8203;5041](typescript-eslint/typescript-eslint#5041)) ([0bfab6c](typescript-eslint/typescript-eslint@0bfab6c))

</details>

<details>
<summary>typescript-eslint/typescript-eslint (@&#8203;typescript-eslint/parser)</summary>

### [`v5.27.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;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 ([#&#8203;5091](typescript-eslint/typescript-eslint#5091)) ([f9c3647](typescript-eslint/typescript-eslint@f9c3647))

##### Features

-   \[4.7] support new extensions ([#&#8203;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.

---

 - [ ] <!-- rebase-check -->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>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 25, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhancement: [no-misused-promises] Warn when spreading a promise
3 participants