Merge branch 'main' into pr/prefer-implicit-assert

Author: adevick

.all-contributorsrc

@@ -618,6 +618,16 @@
         "code",
         "test"
       ]
+    },
+    {
+      "login": "justintoman",
+      "name": "justintoman",
+      "avatar_url": "https://avatars.githubusercontent.com/u/11649507?v=4",
+      "profile": "https://github.com/justintoman",
+      "contributions": [
+        "code",
+        "test"
+      ]
     }
   ],
   "contributorsPerLine": 7,

README.md

@@ -423,6 +423,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://dale.io"><img src="https://avatars.githubusercontent.com/u/389851?v=4?s=100" width="100px;" alt="Dale Karp"/><br /><sub><b>Dale Karp</b></sub></a><br /><a href="https://github.com/testing-library/eslint-plugin-testing-library/commits?author=obsoke" title="Code">💻</a> <a href="https://github.com/testing-library/eslint-plugin-testing-library/commits?author=obsoke" title="Tests">⚠️</a> <a href="https://github.com/testing-library/eslint-plugin-testing-library/commits?author=obsoke" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/nathanmmiller"><img src="https://avatars.githubusercontent.com/u/37555055?v=4?s=100" width="100px;" alt="Nathan"/><br /><sub><b>Nathan</b></sub></a><br /><a href="https://github.com/testing-library/eslint-plugin-testing-library/commits?author=nathanmmiller" title="Code">💻</a> <a href="https://github.com/testing-library/eslint-plugin-testing-library/commits?author=nathanmmiller" title="Tests">⚠️</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/justintoman"><img src="https://avatars.githubusercontent.com/u/11649507?v=4?s=100" width="100px;" alt="justintoman"/><br /><sub><b>justintoman</b></sub></a><br /><a href="https://github.com/testing-library/eslint-plugin-testing-library/commits?author=justintoman" title="Code">💻</a> <a href="https://github.com/testing-library/eslint-plugin-testing-library/commits?author=justintoman" title="Tests">⚠️</a></td>
     </tr>
   </tbody>
 </table>

lib/rules/await-async-events.ts

@@ -16,6 +16,7 @@ export const RULE_NAME = 'await-async-events';
 export type MessageIds = 'awaitAsyncEvent' | 'awaitAsyncEventWrapper';
 const FIRE_EVENT_NAME = 'fireEvent';
 const USER_EVENT_NAME = 'userEvent';
+const USER_EVENT_SETUP_FUNCTION_NAME = 'setup';
 type EventModules = (typeof EVENTS_SIMULATORS)[number];
 export type Options = [
 	{
@@ -90,6 +91,9 @@ export default createTestingLibraryRule<Options, MessageIds>({
 			messageId?: MessageIds;
 			fix?: TSESLint.ReportFixFunction;
 		}): void {
+			if (node.name === USER_EVENT_SETUP_FUNCTION_NAME) {
+				return;
+			}
 			if (!isPromiseHandled(node)) {
 				context.report({
 					node: closestCallExpression.callee,

package-lock.json

@@ -181,6 +181,29 @@ ruleTester.run(RULE_NAME, rule, {
 		]),
 
 		...USER_EVENT_ASYNC_FRAMEWORKS.flatMap((testingFramework) => [
+			{
+				code: `
+				import userEvent from '${testingFramework}'
+				test('setup method called is valid', () => {
+					userEvent.setup()
+				})
+				`,
+				options: [{ eventModule: 'userEvent' }] as const,
+			},
+			{
+				code: `
+				import userEvent from '${testingFramework}'
+				function customSetup() {
+					return {
+						user: userEvent.setup()
+					};
+				}
+				test('setup method called and returned is valid', () => {
+					const {user} = customSetup();
+				})
+				`,
+				options: [{ eventModule: 'userEvent' }] as const,
+			},
 			...USER_EVENT_ASYNC_FUNCTIONS.map((eventMethod) => ({
 				code: `
         import userEvent from '${testingFramework}'