feat: add autofix

Author: neriyarden

lib/rules/no-await-sync-queries.ts

@@ -1,4 +1,4 @@
-import { TSESTree } from '@typescript-eslint/utils';
+import { ASTUtils, TSESTree } from '@typescript-eslint/utils';
 
 import { createTestingLibraryRule } from '../create-testing-library-rule';
 import { getDeepestIdentifierNode } from '../node-utils';
@@ -26,15 +26,20 @@ export default createTestingLibraryRule<Options, MessageIds>({
 				'`{{ name }}` query is sync so it does not need to be awaited',
 		},
 		schema: [],
+		fixable: 'code',
 	},
 	defaultOptions: [],
 
 	create(context, _, helpers) {
 		return {
 			'AwaitExpression > CallExpression'(node: TSESTree.CallExpression) {
+				const awaitExpression = node.parent;
 				const deepestIdentifierNode = getDeepestIdentifierNode(node);
 
-				if (!deepestIdentifierNode) {
+				if (
+					!ASTUtils.isAwaitExpression(awaitExpression) ||
+					!deepestIdentifierNode
+				) {
 					return;
 				}
 
@@ -45,6 +50,15 @@ export default createTestingLibraryRule<Options, MessageIds>({
 						data: {
 							name: deepestIdentifierNode.name,
 						},
+						fix: (fixer) => {
+							const awaitRangeStart = awaitExpression.range[0];
+							const awaitRangeEnd = awaitExpression.range[0] + 'await '.length;
+
+							return fixer.replaceTextRange(
+								[awaitRangeStart, awaitRangeEnd],
+								''
+							);
+						},
 					});
 				}
 			},

tests/lib/rules/no-await-sync-queries.test.ts

@@ -142,6 +142,10 @@ ruleTester.run(RULE_NAME, rule, {
 							column: 31,
 						},
 					],
+					output: `async () => {
+        const element = ${query}('foo')
+      }
+      `,
 				} as const)
 		),
 		// custom sync queries with await operator are not valid
@@ -152,6 +156,11 @@ ruleTester.run(RULE_NAME, rule, {
       }
       `,
 			errors: [{ messageId: 'noAwaitSyncQuery', line: 3, column: 31 }],
+			output: `
+      async () => {
+        const element = getByIcon('search')
+      }
+      `,
 		},
 		{
 			code: `
@@ -160,6 +169,11 @@ ruleTester.run(RULE_NAME, rule, {
       }
       `,
 			errors: [{ messageId: 'noAwaitSyncQuery', line: 3, column: 31 }],
+			output: `
+      async () => {
+        const element = queryByIcon('search')
+      }
+      `,
 		},
 		{
 			code: `
@@ -168,6 +182,11 @@ ruleTester.run(RULE_NAME, rule, {
       }
       `,
 			errors: [{ messageId: 'noAwaitSyncQuery', line: 3, column: 38 }],
+			output: `
+      async () => {
+        const element = screen.getAllByIcon('search')
+      }
+      `,
 		},
 		{
 			code: `
@@ -176,6 +195,11 @@ ruleTester.run(RULE_NAME, rule, {
       }
       `,
 			errors: [{ messageId: 'noAwaitSyncQuery', line: 3, column: 38 }],
+			output: `
+      async () => {
+        const element = screen.queryAllByIcon('search')
+      }
+      `,
 		},
 		// sync queries with await operator inside assert are not valid
 		...SYNC_QUERIES_COMBINATIONS.map(
@@ -192,6 +216,10 @@ ruleTester.run(RULE_NAME, rule, {
 							column: 22,
 						},
 					],
+					output: `async () => {
+        expect(${query}('foo')).toBeEnabled()
+      }
+      `,
 				} as const)
 		),
 
@@ -210,6 +238,10 @@ ruleTester.run(RULE_NAME, rule, {
 							column: 38,
 						},
 					],
+					output: `async () => {
+        const element = screen.${query}('foo')
+      }
+      `,
 				} as const)
 		),
 
@@ -228,6 +260,10 @@ ruleTester.run(RULE_NAME, rule, {
 							column: 29,
 						},
 					],
+					output: `async () => {
+        expect(screen.${query}('foo')).toBeEnabled()
+      }
+      `,
 				} as const)
 		),
 
@@ -244,6 +280,12 @@ ruleTester.run(RULE_NAME, rule, {
       }
       `,
 					errors: [{ messageId: 'noAwaitSyncQuery', line: 4, column: 38 }],
+					output: `
+      import { screen } from '${testingFramework}'
+      () => {
+        const element = screen.getByRole('button')
+      }
+      `,
 				} as const)
 		),
 		// sync query awaited and related to custom module is not valid
@@ -256,6 +298,12 @@ ruleTester.run(RULE_NAME, rule, {
       }
       `,
 			errors: [{ messageId: 'noAwaitSyncQuery', line: 4, column: 38 }],
+			output: `
+      import { screen } from 'test-utils'
+      () => {
+        const element = screen.getByRole('button')
+      }
+      `,
 		},
 
 		// awaited custom sync query matching custom-queries setting is invalid
@@ -269,6 +317,11 @@ ruleTester.run(RULE_NAME, rule, {
       })
       `,
 			errors: [{ messageId: 'noAwaitSyncQuery', line: 3, column: 31 }],
+			output: `
+      test('A valid example test', async () => {
+        const element = queryByIcon('search')
+      })
+      `,
 		},
 	],
 });