Skip to content

Commit 6201fe8

Browse files
committed
[react] Disable testing-library/no-await-sync-events by default
`@testing-library/react` will require `await act()`. At that point the rule is useless. Kept for backwards compatibility.
1 parent 4f36067 commit 6201fe8

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,7 @@ module.exports = [
328328
| [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][] | | |
329329
| [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][] | | |
330330
| [consistent-data-testid](docs/rules/consistent-data-testid.md) | Ensures consistent usage of `data-testid` | | | |
331-
| [no-await-sync-events](docs/rules/no-await-sync-events.md) | Disallow unnecessary `await` for sync events | ![badge-angular][] ![badge-dom][] ![badge-react][] | | |
331+
| [no-await-sync-events](docs/rules/no-await-sync-events.md) | Disallow unnecessary `await` for sync events | ![badge-angular][] ![badge-dom][] ![badge-react][] (off by default. Enable if using `@testing-library/react < 17.0`) | | |
332332
| [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][] | | |
333333
| [no-container](docs/rules/no-container.md) | Disallow the use of `container` methods | ![badge-angular][] ![badge-marko][] ![badge-react][] ![badge-svelte][] ![badge-vue][] | | |
334334
| [no-debugging-utils](docs/rules/no-debugging-utils.md) | Disallow the use of debugging utilities like `debug` | | ![badge-angular][] ![badge-marko][] ![badge-react][] ![badge-svelte][] ![badge-vue][] | |

lib/configs/react.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ export = {
1212
'testing-library/await-async-queries': 'error',
1313
'testing-library/await-async-utils': 'error',
1414
'testing-library/no-await-sync-events': [
15-
'error',
15+
// @testing-library/react >= 17.0 requires `await act()` and therefore `await fireEvent()`
16+
'off',
1617
{ eventModules: ['fire-event'] },
1718
],
1819
'testing-library/no-await-sync-queries': 'error',

0 commit comments

Comments
 (0)