Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
feat(eslint-plugin): [no-floating-promises] add checkThenables option#9263
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
JoshuaKGoldberg merged 7 commits intotypescript-eslint:mainfromJoshuaKGoldberg:no-floating-promises-check-all-thenablesJul 6, 2024
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
7 commits Select commitHold shift + click to select a range
5242c41 feat(eslint-plugin): [no-floating-promises] add checkAllThenables option
JoshuaKGoldbergdfd8c41 update docs snapshots
JoshuaKGoldberg83b264e update snapshots
JoshuaKGoldberg8813a10 update snapshots
JoshuaKGoldbergd66dbea invalid tests part one: still Promise
JoshuaKGoldberg6078b07 isBuiltinSymbolLike
JoshuaKGoldbergdac381c Apply suggestions from code review
JoshuaKGoldbergFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
49 changes: 49 additions & 0 deletionspackages/eslint-plugin/docs/rules/no-floating-promises.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -84,6 +84,55 @@ await Promise.all([1, 2, 3].map(async x => x + 1)); | ||
| ## Options | ||
| ### `checkThenables` | ||
JoshuaKGoldberg marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| A ["Thenable"](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise#thenables) value is an object which has a `then` method, such as a `Promise`. | ||
| Other Thenables include TypeScript's built-in `PromiseLike` interface and any custom object that happens to have a `.then()`. | ||
| The `checkThenables` option triggers `no-floating-promises` to also consider all values that satisfy the Thenable shape (a `.then()` method that takes two callback parameters), not just Promises. | ||
| This can be useful if your code works with older `Promise` polyfills instead of the native `Promise` class. | ||
| <Tabs> | ||
| <TabItem value="❌ Incorrect"> | ||
| ```ts option='{"checkThenables": true}' | ||
| declare function createPromiseLike(): PromiseLike<string>; | ||
| createPromiseLike(); | ||
| interface MyThenable { | ||
| then(onFulfilled: () => void, onRejected: () => void): MyThenable; | ||
| } | ||
| declare function createMyThenable(): MyThenable; | ||
| createMyThenable(); | ||
| ``` | ||
| </TabItem> | ||
| <TabItem value="✅ Correct"> | ||
| ```ts option='{"checkThenables": true}' | ||
| declare function createPromiseLike(): PromiseLike<string>; | ||
| await createPromiseLike(); | ||
| interface MyThenable { | ||
| then(onFulfilled: () => void, onRejected: () => void): MyThenable; | ||
| } | ||
| declare function createMyThenable(): MyThenable; | ||
| await createMyThenable(); | ||
| ``` | ||
| </TabItem> | ||
| </Tabs> | ||
| :::info | ||
| This option is enabled by default in v7 but will be turned off by default in v8. | ||
| ::: | ||
| ### `ignoreVoid` | ||
| This option, which is `true` by default, allows you to stop the rule reporting promises consumed with void operator. | ||
45 changes: 35 additions & 10 deletionspackages/eslint-plugin/src/rules/no-floating-promises.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
44 changes: 41 additions & 3 deletionspackages/eslint-plugin/tests/docs-eslint-output-snapshots/no-floating-promises.shot
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
84 changes: 84 additions & 0 deletionspackages/eslint-plugin/tests/rules/no-floating-promises.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -733,6 +733,41 @@ promise().then(() => {}); | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| code: ` | ||
| interface SafePromise<T> extends Promise<T> { | ||
| brand: 'safe'; | ||
| } | ||
| declare const createSafePromise: () => SafePromise<string>; | ||
| createSafePromise(); | ||
| `, | ||
| options: [ | ||
| { | ||
| allowForKnownSafePromises: [{ from: 'file', name: 'SafePromise' }], | ||
| checkThenables: true, | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| code: ` | ||
| declare const createPromise: () => PromiseLike<number>; | ||
| createPromise(); | ||
| `, | ||
| options: [{ checkThenables: false }], | ||
| }, | ||
| { | ||
| code: ` | ||
| interface MyThenable { | ||
| then(onFulfilled: () => void, onRejected: () => void): MyThenable; | ||
| } | ||
| declare function createMyThenable(): MyThenable; | ||
| createMyThenable(); | ||
| `, | ||
| options: [{ checkThenables: false }], | ||
| }, | ||
| ], | ||
| invalid: [ | ||
JoshuaKGoldberg marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| @@ -2181,5 +2216,54 @@ myTag\`abc\`; | ||
| options: [{ allowForKnownSafePromises: [{ from: 'file', name: 'Foo' }] }], | ||
| errors: [{ line: 4, messageId: 'floatingVoid' }], | ||
| }, | ||
| { | ||
| code: ` | ||
| declare const createPromise: () => PromiseLike<number>; | ||
| createPromise(); | ||
| `, | ||
| errors: [{ line: 3, messageId: 'floatingVoid' }], | ||
| options: [{ checkThenables: true }], | ||
| }, | ||
| { | ||
| code: ` | ||
| interface MyThenable { | ||
| then(onFulfilled: () => void, onRejected: () => void): MyThenable; | ||
| } | ||
| declare function createMyThenable(): MyThenable; | ||
| createMyThenable(); | ||
| `, | ||
| errors: [{ line: 8, messageId: 'floatingVoid' }], | ||
| options: [{ checkThenables: true }], | ||
| }, | ||
| { | ||
| code: ` | ||
| declare const createPromise: () => Promise<number>; | ||
| createPromise(); | ||
| `, | ||
| errors: [{ line: 3, messageId: 'floatingVoid' }], | ||
| options: [{ checkThenables: false }], | ||
| }, | ||
| { | ||
| code: ` | ||
| class MyPromise<T> extends Promise<T> {} | ||
| declare const createMyPromise: () => MyPromise<number>; | ||
| createMyPromise(); | ||
| `, | ||
| errors: [{ line: 4, messageId: 'floatingVoid' }], | ||
| options: [{ checkThenables: false }], | ||
| }, | ||
| { | ||
| code: ` | ||
| class MyPromise<T> extends Promise<T> { | ||
| additional: string; | ||
| } | ||
| declare const createMyPromise: () => MyPromise<number>; | ||
| createMyPromise(); | ||
| `, | ||
| errors: [{ line: 6, messageId: 'floatingVoid' }], | ||
| options: [{ checkThenables: false }], | ||
| }, | ||
| ], | ||
| }); | ||
6 changes: 6 additions & 0 deletionspackages/eslint-plugin/tests/schema-snapshots/no-floating-promises.shot
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.