-
-
Notifications
You must be signed in to change notification settings - Fork 366
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
no-await-in-promise-methods
rule
- Loading branch information
1 parent
331b306
commit 719547d
Showing
6 changed files
with
304 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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 |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Disallow using `await` in `Promise` method parameters | ||
|
||
💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/sindresorhus/eslint-plugin-unicorn#preset-configs). | ||
|
||
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix). | ||
|
||
<!-- end auto-generated rule header --> | ||
<!-- Do not manually modify this header. Run: `npm run fix:eslint-docs` --> | ||
|
||
Awaited parameters in a Promise.all(), Promise.allSettled(), Promise.any() or Promise.race() method is probably a mistake. | ||
|
||
## Fail | ||
|
||
```js | ||
Promise.all([promise, await promise, await promise, promise]) | ||
Promise['all']([promise, await promise, await promise, promise]) | ||
|
||
Promise.allSettled([promise, await promise, await promise, promise]) | ||
Promise['allSettled']([promise, await promise, await promise, promise]) | ||
|
||
Promise.any([promise, await promise, await promise, promise]) | ||
Promise['any']([promise, await promise, await promise, promise]) | ||
|
||
Promise.race([promise, await promise, await promise, promise]) | ||
Promise['race']([promise, await promise, await promise, promise]) | ||
``` | ||
|
||
## Pass | ||
|
||
```js | ||
Promise.all([promise, promise, promise, promise]) | ||
Promise['all']([promise, promise, promise, promise]) | ||
|
||
Promise.allSettled([promise, promise, promise, promise]) | ||
Promise['allSettled']([promise, promise, promise, promise]) | ||
|
||
Promise.any([promise, promise, promise, promise]) | ||
Promise['any']([promise, promise, promise, promise]) | ||
|
||
Promise.race([promise, promise, promise, promise]) | ||
Promise['race']([promise, promise, promise, promise]) | ||
|
||
Promise.resolve([await promise]) | ||
``` |
This file contains 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
This file contains 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 |
---|---|---|
@@ -0,0 +1,55 @@ | ||
'use strict'; | ||
const isPromiseMethodWithArray = require('./utils/is-promise-method-with-array.js'); | ||
|
||
const MESSAGE_ID = 'no-await-in-promise-methods'; | ||
const messages = { | ||
[MESSAGE_ID]: 'Parameters in `Promise.{{method}}` should not be awaited.', | ||
}; | ||
const METHODS = ['all', 'allSettled', 'any', 'race']; | ||
|
||
const getArrayElements = node => node.arguments[0].elements; | ||
|
||
const getMethodName = node => node.callee.property.name; | ||
|
||
const getFixer = ({sourceCode}, element) => fixer => { | ||
const {argument} = element; | ||
const text = sourceCode.getText(argument); | ||
const replacement = argument.type === 'SequenceExpression' ? `(${text})` : text; | ||
|
||
return fixer.replaceText(element, replacement); | ||
}; | ||
|
||
/** @param {import('eslint').Rule.RuleContext} context */ | ||
const create = context => ({ | ||
CallExpression(node) { | ||
if (!isPromiseMethodWithArray(node, METHODS)) { | ||
return; | ||
} | ||
|
||
for (const element of getArrayElements(node)) { | ||
if (element?.type === 'AwaitExpression') { | ||
context.report({ | ||
node: element, | ||
messageId: MESSAGE_ID, | ||
data: { | ||
method: getMethodName(node), | ||
}, | ||
fix: getFixer(context, element), | ||
}); | ||
} | ||
} | ||
}, | ||
}); | ||
|
||
/** @type {import('eslint').Rule.RuleModule} */ | ||
module.exports = { | ||
create, | ||
meta: { | ||
type: 'suggestion', | ||
docs: { | ||
description: 'Disallow using `await` in `Promise` method parameters.', | ||
}, | ||
fixable: 'code', | ||
messages, | ||
}, | ||
}; |
This file contains 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 |
---|---|---|
@@ -0,0 +1,16 @@ | ||
'use strict'; | ||
const isMethodCall = (property, methods) => | ||
(property.type === 'Identifier' && methods.includes(property.name)) | ||
|| (property.type === 'Literal' && methods.includes(property.value)); | ||
|
||
const isPromiseMethodWithArray = (node, methods) => | ||
node.callee.type === 'MemberExpression' | ||
&& node.callee.object.type === 'Identifier' | ||
&& node.callee.object.name === 'Promise' | ||
&& node.callee.property.type === 'Identifier' | ||
&& isMethodCall(node.callee.property, methods) | ||
&& node.arguments.length === 1 | ||
&& node.arguments[0].type === 'ArrayExpression' | ||
&& node.arguments[0].elements.some(element => element !== null); | ||
|
||
module.exports = isPromiseMethodWithArray; |
This file contains 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 |
---|---|---|
@@ -0,0 +1,187 @@ | ||
import outdent from 'outdent'; | ||
import {getTester} from './utils/test.mjs'; | ||
|
||
const {test} = getTester(import.meta); | ||
|
||
const error = { | ||
messageId: 'no-await-in-promise-methods', | ||
}; | ||
|
||
test({ | ||
valid: [ | ||
outdent` | ||
Promise.all([promise, promise, promise, promise]) | ||
`, | ||
outdent` | ||
Promise[all]([promise, promise, promise, promise]) | ||
`, | ||
outdent` | ||
Promise.allSettled([promise, promise, promise, promise]) | ||
`, | ||
outdent` | ||
Promise[allSettled]([promise, promise, promise, promise]) | ||
`, | ||
outdent` | ||
Promise.any([promise, promise, promise, promise]) | ||
`, | ||
outdent` | ||
Promise[any]([promise, promise, promise, promise]) | ||
`, | ||
outdent` | ||
Promise.race([promise, promise, promise, promise]) | ||
`, | ||
outdent` | ||
Promise[race]([promise, promise, promise, promise]) | ||
`, | ||
outdent` | ||
Promise.resolve([await promise]) | ||
`, | ||
], | ||
|
||
invalid: [ | ||
{ | ||
code: outdent` | ||
Promise.all([promise, await promise, await promise, promise]) | ||
`, | ||
errors: [error, error], | ||
output: outdent` | ||
Promise.all([promise, promise, promise, promise]) | ||
`, | ||
}, | ||
{ | ||
code: outdent` | ||
Promise[all]([promise, await promise, await promise, promise]) | ||
`, | ||
errors: [error, error], | ||
output: outdent` | ||
Promise[all]([promise, promise, promise, promise]) | ||
`, | ||
}, | ||
{ | ||
code: outdent` | ||
Promise.all([await (promise, promise)]) | ||
`, | ||
errors: [error], | ||
output: outdent` | ||
Promise.all([(promise, promise)]) | ||
`, | ||
}, | ||
{ | ||
code: outdent` | ||
Promise.all([, await promise]) | ||
`, | ||
errors: [error], | ||
output: outdent` | ||
Promise.all([, promise]) | ||
`, | ||
}, | ||
{ | ||
code: outdent` | ||
Promise.allSettled([promise, await promise, await promise, promise]) | ||
`, | ||
errors: [error, error], | ||
output: outdent` | ||
Promise.allSettled([promise, promise, promise, promise]) | ||
`, | ||
}, | ||
{ | ||
code: outdent` | ||
Promise[allSettled]([promise, await promise, await promise, promise]) | ||
`, | ||
errors: [error, error], | ||
output: outdent` | ||
Promise[allSettled]([promise, promise, promise, promise]) | ||
`, | ||
}, | ||
{ | ||
code: outdent` | ||
Promise.allSettled([await (promise, promise)]) | ||
`, | ||
errors: [error], | ||
output: outdent` | ||
Promise.allSettled([(promise, promise)]) | ||
`, | ||
}, | ||
{ | ||
code: outdent` | ||
Promise.allSettled([, await promise]) | ||
`, | ||
errors: [error], | ||
output: outdent` | ||
Promise.allSettled([, promise]) | ||
`, | ||
}, | ||
{ | ||
code: outdent` | ||
Promise.any([promise, await promise, await promise, promise]) | ||
`, | ||
errors: [error, error], | ||
output: outdent` | ||
Promise.any([promise, promise, promise, promise]) | ||
`, | ||
}, | ||
{ | ||
code: outdent` | ||
Promise[any]([promise, await promise, await promise, promise]) | ||
`, | ||
errors: [error, error], | ||
output: outdent` | ||
Promise[any]([promise, promise, promise, promise]) | ||
`, | ||
}, | ||
{ | ||
code: outdent` | ||
Promise.any([await (promise, promise)]) | ||
`, | ||
errors: [error], | ||
output: outdent` | ||
Promise.any([(promise, promise)]) | ||
`, | ||
}, | ||
{ | ||
code: outdent` | ||
Promise.any([, await promise]) | ||
`, | ||
errors: [error], | ||
output: outdent` | ||
Promise.any([, promise]) | ||
`, | ||
}, | ||
{ | ||
code: outdent` | ||
Promise.race([promise, await promise, await promise, promise]) | ||
`, | ||
errors: [error, error], | ||
output: outdent` | ||
Promise.race([promise, promise, promise, promise]) | ||
`, | ||
}, | ||
{ | ||
code: outdent` | ||
Promise[race]([promise, await promise, await promise, promise]) | ||
`, | ||
errors: [error, error], | ||
output: outdent` | ||
Promise[race]([promise, promise, promise, promise]) | ||
`, | ||
}, | ||
{ | ||
code: outdent` | ||
Promise.race([await (promise, promise)]) | ||
`, | ||
errors: [error], | ||
output: outdent` | ||
Promise.race([(promise, promise)]) | ||
`, | ||
}, | ||
{ | ||
code: outdent` | ||
Promise.race([, await promise]) | ||
`, | ||
errors: [error], | ||
output: outdent` | ||
Promise.race([, promise]) | ||
`, | ||
}, | ||
], | ||
}); |