Add no-await-in-promise-methods rule

Author: Clement398

configs/recommended.js

@@ -20,6 +20,7 @@ module.exports = {
 	'unicorn/no-array-push-push': 'error',
 	'unicorn/no-array-reduce': 'error',
 	'unicorn/no-await-expression-member': 'error',
+	'unicorn/no-await-in-promise-methods': 'error',
 	'unicorn/no-console-spaces': 'error',
 	'unicorn/no-document-cookie': 'error',
 	'unicorn/no-empty-file': 'error',

docs/rules/no-await-in-promise-methods.md

@@ -0,0 +1,36 @@
+# 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 manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+
+<!-- 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.allSettled([promise, await promise, await promise, promise])
+
+Promise.any([promise, await promise, await promise, promise])
+
+Promise.race([promise, await promise, await promise, promise])
+```
+
+## Pass
+
+```js
+Promise.all([promise, promise, promise, promise])
+
+Promise.allSettled([promise, promise, promise, promise])
+
+Promise.any([promise, promise, promise, promise])
+
+Promise.race([promise, promise, promise, promise])
+
+Promise.resolve([await promise])
+```

readme.md

@@ -130,6 +130,7 @@ If you don't use the preset, ensure you use the same `env` and `parserOptions` c
 | [no-array-push-push](docs/rules/no-array-push-push.md)                                           | Enforce combining multiple `Array#push()` into one call.                                                                                                                                                          | ✅  | 🔧 | 💡 |
 | [no-array-reduce](docs/rules/no-array-reduce.md)                                                 | Disallow `Array#reduce()` and `Array#reduceRight()`.                                                                                                                                                              | ✅  |    |    |
 | [no-await-expression-member](docs/rules/no-await-expression-member.md)                           | Disallow member access from await expression.                                                                                                                                                                     | ✅  | 🔧 |    |
+| [no-await-in-promise-methods](docs/rules/no-await-in-promise-methods.md)                         | Disallow using `await` in `Promise` method parameters.                                                                                                                                                            | ✅  |    | 💡 |
 | [no-console-spaces](docs/rules/no-console-spaces.md)                                             | Do not use leading/trailing space between `console.log` parameters.                                                                                                                                               | ✅  | 🔧 |    |
 | [no-document-cookie](docs/rules/no-document-cookie.md)                                           | Do not use `document.cookie` directly.                                                                                                                                                                            | ✅  |    |    |
 | [no-empty-file](docs/rules/no-empty-file.md)                                                     | Disallow empty files.                                                                                                                                                                                             | ✅  |    |    |

rules/no-await-in-promise-methods.js

@@ -0,0 +1,65 @@
+'use strict';
+const isPromiseMethodWithArray = require('./utils/is-promise-method-with-array.js');
+
+const MESSAGE_ID_ERROR = 'no-await-in-promise-methods/error';
+const MESSAGE_ID_SUGGESTION = 'no-await-in-promise-methods/suggestion';
+const messages = {
+	[MESSAGE_ID_ERROR]: 'Parameters in `Promise.{{method}}` should not be awaited.',
+	[MESSAGE_ID_SUGGESTION]: 'Remove `await`.',
+};
+const METHODS = ['all', 'allSettled', 'any', 'race'];
+
+const getArrayElements = node => node.arguments[0].elements;
+
+const getMethodName = node => node.callee.property.name;
+
+const getFixer = ({sourceCode}, awaitedElements) => function * (fixer) {
+	for (const awaitedElement of awaitedElements) {
+		const firstToken = sourceCode.getFirstToken(awaitedElement);
+		const secondToken = sourceCode.getTokenAfter(firstToken);
+
+		yield fixer.removeRange([firstToken.range[0], secondToken.range[0]]);
+	}
+};
+
+/** @param {import('eslint').Rule.RuleContext} context */
+const create = context => ({
+	CallExpression(node) {
+		if (!isPromiseMethodWithArray(node, METHODS)) {
+			return;
+		}
+
+		const awaitedElements = getArrayElements(node).filter(element => element?.type === 'AwaitExpression');
+
+		if (awaitedElements.length === 0) {
+			return;
+		}
+
+		context.report({
+			node,
+			messageId: MESSAGE_ID_ERROR,
+			data: {
+				method: getMethodName(node),
+			},
+			suggest: [
+				{
+					messageId: MESSAGE_ID_SUGGESTION,
+					fix: getFixer(context, awaitedElements),
+				},
+			],
+		});
+	},
+});
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+	create,
+	meta: {
+		type: 'suggestion',
+		docs: {
+			description: 'Disallow using `await` in `Promise` method parameters.',
+		},
+		hasSuggestions: true,
+		messages,
+	},
+};

rules/utils/is-promise-method-with-array.js

@@ -0,0 +1,13 @@
+'use strict';
+const {isMethodCall} = require('../ast/index.js');
+
+const isPromiseMethodWithArray = (node, methods) =>
+	node.callee.type === 'MemberExpression'
+	&& node.callee.object.type === 'Identifier'
+	&& node.callee.object.name === 'Promise'
+	&& isMethodCall(node, methods)
+	&& node.arguments.length === 1
+	&& node.arguments[0].type === 'ArrayExpression'
+	&& node.arguments[0].elements.some(element => element !== null);
+
+module.exports = isPromiseMethodWithArray;

test/no-await-in-promise-methods.mjs

@@ -0,0 +1,48 @@
+import {getTester} from './utils/test.mjs';
+
+const {test} = getTester(import.meta);
+
+const createSuggestionError = output => [{
+	messageId: 'no-await-in-promise-methods/error',
+	suggestions: [
+		{
+			messageId: 'no-await-in-promise-methods/suggestion',
+			output,
+		},
+	],
+}];
+
+test({
+	valid: [
+		'Promise.all([promise, promise, promise, promise])',
+		'Promise.allSettled([promise, promise, promise, promise])',
+		'Promise.any([promise, promise, promise, promise])',
+		'Promise.race([promise, promise, promise, promise])',
+		'Promise.resolve([await promise])',
+		'Promise[all]([await promise])',
+		'Promise.all([,])',
+	],
+
+	invalid: [
+		{
+			code: 'Promise.all([promise, await promise, await promise, promise])',
+			suggestion: 'Promise.all([promise, promise, promise, promise])',
+		},
+		{
+			code: 'Promise.all([, await promise])',
+			suggestion: 'Promise.all([, promise])',
+		},
+		{
+			code: 'Promise.allSettled([promise, await promise, await promise, promise])',
+			suggestion: 'Promise.allSettled([promise, promise, promise, promise])',
+		},
+		{
+			code: 'Promise.any([promise, await promise, await promise, promise])',
+			suggestion: 'Promise.any([promise, promise, promise, promise])',
+		},
+		{
+			code: 'Promise.race([promise, await promise, await promise, promise])',
+			suggestion: 'Promise.race([promise, promise, promise, promise])',
+		},
+	].map(({code, suggestion}) => ({code, errors: createSuggestionError(suggestion)})),
+});