Merge branch 'main' into fix-setup-async-methods

puglyfe · web-flow · commit 347b2cd03334 · 2025-08-02T14:42:04.000-05:00
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -738,6 +738,15 @@
         "code",
         "test"
       ]
+    },
+    {
+      "login": "andreww2012",
+      "name": "Andrew Kazakov",
+      "avatar_url": "https://avatars.githubusercontent.com/u/6554045?v=4",
+      "profile": "https://github.com/andreww2012",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,
diff --git a/README.md b/README.md
@@ -555,6 +555,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/y-hsgw"><img src="https://avatars.githubusercontent.com/u/49516827?v=4?s=100" width="100px;" alt="Yukihiro Hasegawa"/><br /><sub><b>Yukihiro Hasegawa</b></sub></a><br /><a href="https://github.com/testing-library/eslint-plugin-testing-library/commits?author=y-hsgw" title="Code">💻</a> <a href="https://github.com/testing-library/eslint-plugin-testing-library/commits?author=y-hsgw" title="Tests">⚠️</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://www.charleypugmire.me"><img src="https://avatars.githubusercontent.com/u/3228931?v=4?s=100" width="100px;" alt="Charley Pugmire"/><br /><sub><b>Charley Pugmire</b></sub></a><br /><a href="https://github.com/testing-library/eslint-plugin-testing-library/commits?author=puglyfe" title="Code">💻</a> <a href="https://github.com/testing-library/eslint-plugin-testing-library/commits?author=puglyfe" title="Tests">⚠️</a></td>
     </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/andreww2012"><img src="https://avatars.githubusercontent.com/u/6554045?v=4?s=100" width="100px;" alt="Andrew Kazakov"/><br /><sub><b>Andrew Kazakov</b></sub></a><br /><a href="https://github.com/testing-library/eslint-plugin-testing-library/commits?author=andreww2012" title="Code">💻</a></td>
+    </tr>
   </tbody>
 </table>
 
diff --git a/lib/create-testing-library-rule/detect-testing-library-utils.ts b/lib/create-testing-library-rule/detect-testing-library-utils.ts
@@ -23,7 +23,13 @@ import {
 	ASYNC_UTILS,
 	DEBUG_UTILS,
 	PRESENCE_MATCHERS,
+	USER_EVENT_MODULE,
 } from '../utils';
+import {
+	isCustomTestingLibraryModule,
+	isOfficialTestingLibraryModule,
+	isTestingLibraryModule,
+} from '../utils/is-testing-library-module';
 
 const SETTING_OPTION_OFF = 'off';
 
@@ -136,7 +142,6 @@ export interface DetectionHelpers {
 	isNodeComingFromTestingLibrary: IsNodeComingFromTestingLibraryFn;
 }
 
-const USER_EVENT_PACKAGE = '@testing-library/user-event';
 const REACT_DOM_TEST_UTILS_PACKAGE = 'react-dom/test-utils';
 const FIRE_EVENT_NAME = 'fireEvent';
 const CREATE_EVENT_NAME = 'createEvent';
@@ -977,12 +982,11 @@ export function detectTestingLibraryUtils<
 			}
 
 			const hasImportElementMatch = hasImportMatch(importNode, identifierName);
-			const hasImportModuleMatch =
-				/testing-library/g.test(importDeclarationName) ||
-				(typeof customModuleSetting === 'string' &&
-					importDeclarationName.endsWith(customModuleSetting));
 
-			return hasImportElementMatch && hasImportModuleMatch;
+			return (
+				hasImportElementMatch &&
+				isTestingLibraryModule(importDeclarationName, customModuleSetting)
+			);
 		};
 
 		const helpers: DetectionHelpers = {
@@ -1034,17 +1038,16 @@ export function detectTestingLibraryUtils<
 				}
 				// check only if testing library import not found yet so we avoid
 				// to override importedTestingLibraryNodes after it's found
-				if (/testing-library/g.test(node.source.value)) {
+				if (isOfficialTestingLibraryModule(node.source.value)) {
 					importedTestingLibraryNodes.push(node);
 				}
 
 				// check only if custom module import not found yet so we avoid
 				// to override importedCustomModuleNode after it's found
 				const customModule = getCustomModule();
 				if (
-					customModule &&
 					!importedCustomModuleNode &&
-					node.source.value.endsWith(customModule)
+					isCustomTestingLibraryModule(node.source.value, customModule)
 				) {
 					importedCustomModuleNode = node;
 				}
@@ -1053,7 +1056,7 @@ export function detectTestingLibraryUtils<
 				// to override importedUserEventLibraryNode after it's found
 				if (
 					!importedUserEventLibraryNode &&
-					node.source.value === USER_EVENT_PACKAGE
+					node.source.value === USER_EVENT_MODULE
 				) {
 					importedUserEventLibraryNode = node;
 				}
@@ -1080,7 +1083,7 @@ export function detectTestingLibraryUtils<
 						(arg) =>
 							isLiteral(arg) &&
 							typeof arg.value === 'string' &&
-							/testing-library/g.test(arg.value)
+							isOfficialTestingLibraryModule(arg.value)
 					)
 				) {
 					importedTestingLibraryNodes.push(callExpression);
@@ -1091,10 +1094,9 @@ export function detectTestingLibraryUtils<
 					!importedCustomModuleNode &&
 					args.some(
 						(arg) =>
-							customModule &&
 							isLiteral(arg) &&
 							typeof arg.value === 'string' &&
-							arg.value.endsWith(customModule)
+							isCustomTestingLibraryModule(arg.value, customModule)
 					)
 				) {
 					importedCustomModuleNode = callExpression;
@@ -1106,7 +1108,7 @@ export function detectTestingLibraryUtils<
 						(arg) =>
 							isLiteral(arg) &&
 							typeof arg.value === 'string' &&
-							arg.value === USER_EVENT_PACKAGE
+							arg.value === USER_EVENT_MODULE
 					)
 				) {
 					importedUserEventLibraryNode = callExpression;
diff --git a/lib/rules/await-async-utils.ts b/lib/rules/await-async-utils.ts
@@ -7,6 +7,7 @@ import {
 	getFunctionName,
 	getInnermostReturningFunction,
 	getVariableReferences,
+	isCallExpression,
 	isObjectPattern,
 	isPromiseHandled,
 	isProperty,
@@ -110,6 +111,8 @@ export default createTestingLibraryRule<Options, MessageIds>({
 				const isAssigningKnownAsyncFunctionWrapper =
 					ASTUtils.isIdentifier(node.id) &&
 					node.init !== null &&
+					!isCallExpression(node.init) &&
+					!ASTUtils.isAwaitExpression(node.init) &&
 					functionWrappersNames.includes(
 						getDeepestIdentifierNode(node.init)?.name ?? ''
 					);
diff --git a/lib/rules/no-node-access.ts b/lib/rules/no-node-access.ts
@@ -41,6 +41,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
 						type: 'boolean',
 					},
 				},
+				additionalProperties: false,
 			},
 		],
 	},
diff --git a/lib/rules/no-render-in-lifecycle.ts b/lib/rules/no-render-in-lifecycle.ts
@@ -72,6 +72,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
 						type: 'string',
 					},
 				},
+				additionalProperties: false,
 			},
 		],
 	},
diff --git a/lib/rules/no-unnecessary-act.ts b/lib/rules/no-unnecessary-act.ts
@@ -45,6 +45,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
 						type: 'boolean',
 					},
 				},
+				additionalProperties: false,
 			},
 		],
 	},
diff --git a/lib/rules/prefer-query-matchers.ts b/lib/rules/prefer-query-matchers.ts
@@ -50,6 +50,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
 									type: 'string',
 								},
 							},
+							additionalProperties: false,
 						},
 					},
 				},
diff --git a/lib/rules/prefer-user-event.ts b/lib/rules/prefer-user-event.ts
@@ -90,6 +90,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
 				properties: {
 					allowedMethods: { type: 'array' },
 				},
+				additionalProperties: false,
 			},
 		],
 	},
diff --git a/lib/utils/index.ts b/lib/utils/index.ts
@@ -33,6 +33,12 @@ const LIBRARY_MODULES = [
 
 const USER_EVENT_MODULE = '@testing-library/user-event';
 
+const OLD_LIBRARY_MODULES = [
+	'dom-testing-library',
+	'vue-testing-library',
+	'react-testing-library',
+] as const;
+
 const SYNC_QUERIES_VARIANTS = [
 	'getBy',
 	'getAllBy',
@@ -154,4 +160,5 @@ export {
 	ABSENCE_MATCHERS,
 	EVENT_HANDLER_METHODS,
 	USER_EVENT_MODULE,
+	OLD_LIBRARY_MODULES,
 };
diff --git a/lib/utils/is-testing-library-module.ts b/lib/utils/is-testing-library-module.ts
@@ -0,0 +1,22 @@
+import { TestingLibrarySettings } from '../create-testing-library-rule/detect-testing-library-utils';
+
+import { LIBRARY_MODULES, OLD_LIBRARY_MODULES, USER_EVENT_MODULE } from '.';
+
+export const isOfficialTestingLibraryModule = (importSourceName: string) =>
+	[...OLD_LIBRARY_MODULES, ...LIBRARY_MODULES, USER_EVENT_MODULE].includes(
+		importSourceName
+	);
+
+export const isCustomTestingLibraryModule = (
+	importSourceName: string,
+	customModuleSetting: TestingLibrarySettings['testing-library/utils-module']
+) =>
+	typeof customModuleSetting === 'string' &&
+	importSourceName.endsWith(customModuleSetting);
+
+export const isTestingLibraryModule = (
+	importSourceName: string,
+	customModuleSetting?: TestingLibrarySettings['testing-library/utils-module']
+) =>
+	isOfficialTestingLibraryModule(importSourceName) ||
+	isCustomTestingLibraryModule(importSourceName, customModuleSetting);
diff --git a/lib/utils/resolve-to-testing-library-fn.ts b/lib/utils/resolve-to-testing-library-fn.ts
@@ -24,7 +24,7 @@ import {
 	isSupportedAccessor,
 } from '../node-utils/accessors';
 
-import { LIBRARY_MODULES, USER_EVENT_MODULE } from '.';
+import { isTestingLibraryModule } from './is-testing-library-module';
 
 interface ImportDetails {
 	source: string;
@@ -171,11 +171,8 @@ export const resolveToTestingLibraryFn = <
 	}
 
 	const customModuleSetting = context.settings['testing-library/utils-module'];
-	if (
-		[...LIBRARY_MODULES, USER_EVENT_MODULE, customModuleSetting].some(
-			(module) => module === maybeImport.source
-		)
-	) {
+
+	if (isTestingLibraryModule(maybeImport.source, customModuleSetting)) {
 		return {
 			original: maybeImport.imported,
 			local: maybeImport.local,
diff --git a/tests/lib/rules/await-async-events.test.ts b/tests/lib/rules/await-async-events.test.ts
@@ -134,6 +134,21 @@ ruleTester.run(RULE_NAME, rule, {
 
           await triggerEvent()
         })
+        `,
+				options: [{ eventModule: 'fireEvent' }] as const,
+			})),
+			...FIRE_EVENT_ASYNC_FUNCTIONS.map((eventMethod) => ({
+				code: `
+        import { fireEvent } from '${testingFramework}'
+        test('await promise assigned to a variable from function wrapping event method is valid', () => {
+          function triggerEvent() {
+            doSomething()
+            return fireEvent.${eventMethod}(getByLabelText('username'))
+          }
+
+          const result = await triggerEvent()
+          expect(result).toBe(undefined)
+        })
         `,
 				options: [{ eventModule: 'fireEvent' }] as const,
 			})),
@@ -364,6 +379,21 @@ ruleTester.run(RULE_NAME, rule, {
 			...USER_EVENT_ASYNC_FUNCTIONS.map((eventMethod) => ({
 				code: `
         import userEvent from '${testingFramework}'
+        test('await promise assigned to a variable from function wrapping event method is valid', () => {
+          function triggerEvent() {
+            doSomething()
+            return userEvent.${eventMethod}(getByLabelText('username'))
+          }
+
+          const result = await triggerEvent()
+          expect(result).toBe(undefined)
+        })
+        `,
+				options: [{ eventModule: 'userEvent' }] as const,
+			})),
+			...USER_EVENT_ASYNC_FUNCTIONS.map((eventMethod) => ({
+				code: `
+        import userEvent from '${testingFramework}'
         test('await expression that evaluates to promise is valid', async () => {
           await (null, userEvent.${eventMethod}(getByLabelText('username')));
 		  await (condition ? null : userEvent.${eventMethod}(getByLabelText('username')));
@@ -775,6 +805,44 @@ ruleTester.run(RULE_NAME, rule, {
 					({
 						code: `
       import { fireEvent } from '${testingFramework}'
+      test('unhandled promise assigned to a variable returned from function wrapping event method is invalid', () => {
+        function triggerEvent() {
+          doSomething()
+          return fireEvent.${eventMethod}(getByLabelText('username'))
+        }
+
+        const result = triggerEvent()
+        expect(result).toBe(undefined)
+      })
+      `,
+						errors: [
+							{
+								line: 9,
+								column: 24,
+								messageId: 'awaitAsyncEventWrapper',
+								data: { name: 'triggerEvent' },
+							},
+						],
+						options: [{ eventModule: 'fireEvent' }],
+						output: `
+      import { fireEvent } from '${testingFramework}'
+      test('unhandled promise assigned to a variable returned from function wrapping event method is invalid', async () => {
+        function triggerEvent() {
+          doSomething()
+          return fireEvent.${eventMethod}(getByLabelText('username'))
+        }
+
+        const result = await triggerEvent()
+        expect(result).toBe(undefined)
+      })
+      `,
+					}) as const
+			),
+			...FIRE_EVENT_ASYNC_FUNCTIONS.map(
+				(eventMethod) =>
+					({
+						code: `
+      import { fireEvent } from '${testingFramework}'
 
       function triggerEvent() {
         doSomething()
@@ -977,6 +1045,44 @@ ruleTester.run(RULE_NAME, rule, {
 					({
 						code: `
       import userEvent from '${testingFramework}'
+      test('unhandled promise assigned to a variable returned from function wrapping event method is invalid', function() {
+        function triggerEvent() {
+          doSomething()
+          return userEvent.${eventMethod}(getByLabelText('username'))
+        }
+
+        const result = triggerEvent()
+        expect(result).toBe(undefined)
+      })
+      `,
+						errors: [
+							{
+								line: 9,
+								column: 24,
+								messageId: 'awaitAsyncEventWrapper',
+								data: { name: 'triggerEvent' },
+							},
+						],
+						options: [{ eventModule: 'userEvent' }],
+						output: `
+      import userEvent from '${testingFramework}'
+      test('unhandled promise assigned to a variable returned from function wrapping event method is invalid', async function() {
+        function triggerEvent() {
+          doSomething()
+          return userEvent.${eventMethod}(getByLabelText('username'))
+        }
+
+        const result = await triggerEvent()
+        expect(result).toBe(undefined)
+      })
+      `,
+					}) as const
+			),
+			...USER_EVENT_ASYNC_FUNCTIONS.map(
+				(eventMethod) =>
+					({
+						code: `
+      import userEvent from '${testingFramework}'
 
       function triggerEvent() {
         doSomething()
diff --git a/tests/lib/rules/await-async-queries.test.ts b/tests/lib/rules/await-async-queries.test.ts
diff --git a/tests/lib/rules/await-async-utils.test.ts b/tests/lib/rules/await-async-utils.test.ts
diff --git a/tests/lib/rules/no-node-access.test.ts b/tests/lib/rules/no-node-access.test.ts
diff --git a/tests/lib/utils/is-testing-library-module.test.ts b/tests/lib/utils/is-testing-library-module.test.ts
diff --git a/tests/lib/utils/resolve-to-testing-library-fn.test.ts b/tests/lib/utils/resolve-to-testing-library-fn.test.ts
