Enhancement: [no-floating-promises] Don't check coincidentally Promise-like (Thenable) type values by default #8433
Labels
accepting prs
Go ahead, send a pull request that resolves this issue
enhancement: plugin rule option
New rule option for an existing eslint-plugin rule
package: eslint-plugin
Issues related to @typescript-eslint/eslint-plugin
Before You File a Proposal Please Confirm You Have Done The Following...
My proposal is suitable for this project
Link to the rule's documentation
https://typescript-eslint.io/rules/no-floating-promises
Description
Forwarding out from conversations with @mcollina, especially nodejs/node#51292 (comment): right now
no-floating-promises
will consider anything that looks like a Promise (i.e. is "Promise-like") to be a potential floating value:typescript-eslint/packages/eslint-plugin/src/rules/no-floating-promises.ts
Line 353 in 5857356
But to my knowledge this hasn't been particularly helpful. If something coincidentally happens to match the
Thenable
interface that doesn't necessarily mean it shouldn't float!The historical context here is that it used to be common in JavaScript code to use alternative implementations of Promises, such as Bluebird. Promises were only added to some browsers in ~2014 and Node & co in ~2015 or so. Many sites still had to support old versions of Internet Explorer. The
no-floating-promises
typescript-eslint rule was implemented in 2019 when it was still not-unheard-of to use alternative Promises or at least have Promise types provided by a polyfill: #495.Now that the vast majority of projects are using built-in Promise values & types, I think the value of detecting those values automatically is no longer worth the pain of flagging general thenables. I propose we modify the rule to:
Promise
typePromise
type from the list of checked types? I don't think so, but that's not a decision we'd need to make now...I.e. this is the opposite of #7008. That issue is about adding an allowlist for types to be allowed to float. This one is adding a blocklist of types to not be allowed to float - instead of always detecting Thenables.
Fail
Pass
Additional Info
After the proposed followup, if folks still want to detect floating
PromiseLike
s, they'd be able to use this option.As to whether we'd want to give users a way to opt back into the current "check anything that looks like a Thenable" behavior... I don't see why anybody would want that, but we could always make it an option if someone asks for it.
The text was updated successfully, but these errors were encountered: