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,42 @@
+# 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
+const func = () => Promise.resolve('promise');
+const promise = func();
+
+await Promise.all([func(), await func(), await promise, promise]);
+
+await Promise.allSettled([func(), await func(), await promise, promise]);
+
+await Promise.any([func(), await func(), await promise, promise]);
+
+await Promise.race([func(), await func(), await promise, promise]);
+```
+
+## Pass
+
+```js
+const func = () => Promise.resolve('promise');
+const promise = func();
+
+await Promise.all([func(), func(), promise, promise]);
+
+await Promise.allSettled([func(), func(), promise, promise]);
+
+await Promise.any([func(), func(), promise, promise]);
+
+await Promise.race([func(), func(), promise, promise]);
+
+await Promise.resolve([await func()]);
+```

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,49 @@
+'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 getArrayElements = node => node.arguments[0].elements;
+
+const isAwait = element => element.type === 'AwaitExpression';
+
+const getMethodName = node => node.callee.property.name;
+
+const getFixer = ({sourceCode}, element) => fixer =>
+	fixer.replaceText(element, sourceCode.getText(element.argument));
+
+/** @param {import('eslint').Rule.RuleContext} context */
+const create = context => ({
+	CallExpression(node) {
+		if (isPromiseMethodWithArray(node)) {
+			for (const element of getArrayElements(node)) {
+				if (isAwait(element)) {
+					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,
+	},
+};

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

@@ -0,0 +1,13 @@
+'use strict';
+const METHODS = new Set(['all', 'allSettled', 'any', 'race']);
+
+const isPromiseMethodWithArray = node =>
+	node.callee.type === 'MemberExpression'
+	&& node.callee.object.type === 'Identifier'
+	&& node.callee.object.name === 'Promise'
+	&& node.callee.property.type === 'Identifier'
+	&& METHODS.has(node.callee.property.name)
+	&& node.arguments.length === 1
+	&& node.arguments[0].type === 'ArrayExpression';
+
+module.exports = isPromiseMethodWithArray;

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

@@ -0,0 +1,92 @@
+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`
+			const func = () => Promise.resolve('promise');
+			const promise = func();
+			await Promise.all([func(), func(), promise, promise]);
+		`,
+		outdent`
+			const func = () => Promise.resolve('promise');
+			const promise = func();
+			await Promise.allSettled([func(), func(), promise, promise]);
+		`,
+		outdent`
+			const func = () => Promise.resolve('promise');
+			const promise = func();
+			await Promise.any([func(), func(), promise, promise]);
+		`,
+		outdent`
+			const func = () => Promise.resolve('promise');
+			const promise = func();
+			await Promise.race([func(), func(), promise, promise]);
+		`,
+		outdent`
+			const func = () => Promise.resolve('promise');
+			await Promise.resolve([await func()]);
+		`,
+	],
+
+	invalid: [
+		{
+			code: outdent`
+				const func = () => Promise.resolve('promise');
+				const promise = func();
+				await Promise.all([func(), await func(), await promise, promise]);
+			`,
+			errors: [error, error],
+			output: outdent`
+				const func = () => Promise.resolve('promise');
+				const promise = func();
+				await Promise.all([func(), func(), promise, promise]);
+			`,
+		},
+		{
+			code: outdent`
+				const func = () => Promise.resolve('promise');
+				const promise = func();
+				await Promise.allSettled([func(), await func(), await promise, promise]);
+			`,
+			errors: [error, error],
+			output: outdent`
+				const func = () => Promise.resolve('promise');
+				const promise = func();
+				await Promise.allSettled([func(), func(), promise, promise]);
+			`,
+		},
+		{
+			code: outdent`
+				const func = () => Promise.resolve('promise');
+				const promise = func();
+				await Promise.any([func(), await func(), await promise, promise]);
+			`,
+			errors: [error, error],
+			output: outdent`
+				const func = () => Promise.resolve('promise');
+				const promise = func();
+				await Promise.any([func(), func(), promise, promise]);
+			`,
+		},
+		{
+			code: outdent`
+				const func = () => Promise.resolve('promise');
+				const promise = func();
+				await Promise.race([func(), await func(), await promise, promise]);
+			`,
+			errors: [error, error],
+			output: outdent`
+				const func = () => Promise.resolve('promise');
+				const promise = func();
+				await Promise.race([func(), func(), promise, promise]);
+			`,
+		},
+	],
+});