feat(await-async-utils): add auto-fix (#1086)

Closes #1083

Author: y-hsgw

README.md

@@ -326,7 +326,7 @@ module.exports = [
 | :------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------ | :-- |
 | [await-async-events](docs/rules/await-async-events.md)                           | Enforce promises from async event methods are handled                                        | ![badge-angular][] ![badge-dom][] ![badge-marko][] ![badge-react][] ![badge-svelte][] ![badge-vue][] |                                                                                       | 🔧  |
 | [await-async-queries](docs/rules/await-async-queries.md)                         | Enforce promises from async queries to be handled                                            | ![badge-angular][] ![badge-dom][] ![badge-marko][] ![badge-react][] ![badge-svelte][] ![badge-vue][] |                                                                                       | 🔧  |
-| [await-async-utils](docs/rules/await-async-utils.md)                             | Enforce promises from async utils to be awaited properly                                     | ![badge-angular][] ![badge-dom][] ![badge-marko][] ![badge-react][] ![badge-svelte][] ![badge-vue][] |                                                                                       |     |
+| [await-async-utils](docs/rules/await-async-utils.md)                             | Enforce promises from async utils to be awaited properly                                     | ![badge-angular][] ![badge-dom][] ![badge-marko][] ![badge-react][] ![badge-svelte][] ![badge-vue][] |                                                                                       | 🔧  |
 | [consistent-data-testid](docs/rules/consistent-data-testid.md)                   | Ensures consistent usage of `data-testid`                                                    |                                                                                                      |                                                                                       |     |
 | [no-await-sync-events](docs/rules/no-await-sync-events.md)                       | Disallow unnecessary `await` for sync events                                                 | ![badge-angular][] ![badge-dom][] ![badge-react][]                                                   |                                                                                       |     |
 | [no-await-sync-queries](docs/rules/no-await-sync-queries.md)                     | Disallow unnecessary `await` for sync queries                                                | ![badge-angular][] ![badge-dom][] ![badge-marko][] ![badge-react][] ![badge-svelte][] ![badge-vue][] |                                                                                       | 🔧  |

docs/rules/await-async-utils.md

@@ -2,6 +2,8 @@
 
 💼 This rule is enabled in the following configs: `angular`, `dom`, `marko`, `react`, `svelte`, `vue`.
 
+🔧 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 -->
 
 Ensure that promises returned by async utils are handled properly.

lib/rules/await-async-queries.ts

@@ -11,6 +11,7 @@ import {
 	isMemberExpression,
 	isPromiseHandled,
 } from '../node-utils';
+import { addAsyncToFunctionFix } from '../utils/add-async-to-function-fix';
 
 import type { TSESTree } from '@typescript-eslint/utils';
 
@@ -164,20 +165,11 @@ export default createTestingLibraryRule<Options, MessageIds>({
 								);
 							}
 
-							const ruleFixes = [IdentifierNodeFixer];
-							if (!functionExpression.async) {
-								/**
-								 * Mutate the actual node so if other nodes exist in this
-								 * function expression body they don't also try to fix it.
-								 */
-								functionExpression.async = true;
-
-								ruleFixes.push(
-									fixer.insertTextBefore(functionExpression, 'async ')
-								);
-							}
-
-							return ruleFixes;
+							return addAsyncToFunctionFix(
+								fixer,
+								IdentifierNodeFixer,
+								functionExpression
+							);
 						},
 					});
 				}

lib/rules/await-async-utils.ts

@@ -3,17 +3,20 @@ import { ASTUtils } from '@typescript-eslint/utils';
 import { createTestingLibraryRule } from '../create-testing-library-rule';
 import {
 	findClosestCallExpressionNode,
+	findClosestFunctionExpressionNode,
 	getDeepestIdentifierNode,
 	getFunctionName,
 	getInnermostReturningFunction,
+	getReferenceNode,
 	getVariableReferences,
 	isCallExpression,
 	isObjectPattern,
 	isPromiseHandled,
 	isProperty,
 } from '../node-utils';
+import { addAsyncToFunctionFix } from '../utils/add-async-to-function-fix';
 
-import type { TSESTree } from '@typescript-eslint/utils';
+import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
 
 export const RULE_NAME = 'await-async-utils';
 export type MessageIds = 'asyncUtilWrapper' | 'awaitAsyncUtil';
@@ -40,6 +43,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
 				'Promise returned from {{ name }} wrapper over async util must be handled',
 		},
 		schema: [],
+		fixable: 'code',
 	},
 	defaultOptions: [],
 
@@ -91,6 +95,13 @@ export default createTestingLibraryRule<Options, MessageIds>({
 			}
 		}
 
+		function insertAwaitBeforeNode(
+			fixer: TSESLint.RuleFixer,
+			node: TSESTree.Node
+		) {
+			return fixer.insertTextBefore(node, 'await ');
+		}
+
 		/*
 			Either we report a direct usage of an async util or a usage of a wrapper
 			around an async util
@@ -155,6 +166,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
 					context,
 					closestCallExpression.parent
 				);
+				const functionExpression = findClosestFunctionExpressionNode(node);
 
 				if (references.length === 0) {
 					if (!isPromiseHandled(callExpressionIdentifier)) {
@@ -164,6 +176,17 @@ export default createTestingLibraryRule<Options, MessageIds>({
 							data: {
 								name: callExpressionIdentifier.name,
 							},
+							fix: (fixer) => {
+								const referenceNode = getReferenceNode(
+									callExpressionIdentifier
+								);
+								const awaitFix = insertAwaitBeforeNode(fixer, referenceNode);
+								return addAsyncToFunctionFix(
+									fixer,
+									awaitFix,
+									functionExpression
+								);
+							},
 						});
 					}
 				} else {
@@ -176,6 +199,14 @@ export default createTestingLibraryRule<Options, MessageIds>({
 								data: {
 									name: callExpressionIdentifier.name,
 								},
+								fix: (fixer) => {
+									const awaitFix = insertAwaitBeforeNode(fixer, referenceNode);
+									return addAsyncToFunctionFix(
+										fixer,
+										awaitFix,
+										functionExpression
+									);
+								},
 							});
 							return;
 						}

lib/utils/add-async-to-function-fix.ts

@@ -0,0 +1,22 @@
+import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
+
+export const addAsyncToFunctionFix = (
+	fixer: TSESLint.RuleFixer,
+	ruleFix: TSESLint.RuleFix,
+	functionExpression:
+		| TSESTree.ArrowFunctionExpression
+		| TSESTree.FunctionDeclaration
+		| TSESTree.FunctionExpression
+		| null
+) => {
+	if (functionExpression && !functionExpression.async) {
+		/**
+		 * Mutate the actual node so if other nodes exist in this
+		 * function expression body they don't also try to fix it.
+		 */
+		functionExpression.async = true;
+
+		return [ruleFix, fixer.insertTextBefore(functionExpression, 'async ')];
+	}
+	return ruleFix;
+};