From afce5ea7888db3070711c39baf470e46a01f99a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20De=20Boey?= Date: Wed, 5 Oct 2022 12:30:03 +0200 Subject: [PATCH] feat(no-await-sync-events): add to DOM, Angular & React configs by default (#667) BREAKING CHANGE: `no-await-sync-events` is now enabled by default in the DOM, Angular & React configs --- README.md | 2 +- lib/configs/angular.ts | 1 + lib/configs/dom.ts | 1 + lib/configs/react.ts | 1 + lib/rules/no-await-sync-events.ts | 6 +++--- tests/__snapshots__/index.test.ts.snap | 3 +++ 6 files changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 392dfa9e..e37f89e4 100644 --- a/README.md +++ b/README.md @@ -210,7 +210,7 @@ To enable this configuration use the `extends` property in your | [`await-async-query`](./docs/rules/await-async-query.md) | Enforce promises from async queries to be handled | | ![dom-badge][] ![angular-badge][] ![react-badge][] ![vue-badge][] ![marko-badge][] | | [`await-async-utils`](./docs/rules/await-async-utils.md) | Enforce promises from async utils to be awaited properly | | ![dom-badge][] ![angular-badge][] ![react-badge][] ![vue-badge][] ![marko-badge][] | | [`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 | | | +| [`no-await-sync-events`](./docs/rules/no-await-sync-events.md) | Disallow unnecessary `await` for sync events | | ![dom-badge][] ![angular-badge][] ![react-badge][] | | [`no-await-sync-queries`](./docs/rules/no-await-sync-queries.md) | Disallow unnecessary `await` for sync queries | | ![dom-badge][] ![angular-badge][] ![react-badge][] ![vue-badge][] ![marko-badge][] | | [`no-container`](./docs/rules/no-container.md) | Disallow the use of `container` methods | | ![angular-badge][] ![react-badge][] ![vue-badge][] ![marko-badge][] | | [`no-debugging-utils`](./docs/rules/no-debugging-utils.md) | Disallow the use of debugging utilities like `debug` | | ![angular-badge][] ![react-badge][] ![vue-badge][] ![marko-badge][] | diff --git a/lib/configs/angular.ts b/lib/configs/angular.ts index 3b2594ba..de23cedc 100644 --- a/lib/configs/angular.ts +++ b/lib/configs/angular.ts @@ -11,6 +11,7 @@ export = { ], 'testing-library/await-async-query': 'error', 'testing-library/await-async-utils': 'error', + 'testing-library/no-await-sync-events': 'error', 'testing-library/no-await-sync-queries': 'error', 'testing-library/no-container': 'error', 'testing-library/no-debugging-utils': 'warn', diff --git a/lib/configs/dom.ts b/lib/configs/dom.ts index 80aaf58e..4360414a 100644 --- a/lib/configs/dom.ts +++ b/lib/configs/dom.ts @@ -11,6 +11,7 @@ export = { ], 'testing-library/await-async-query': 'error', 'testing-library/await-async-utils': 'error', + 'testing-library/no-await-sync-events': 'error', 'testing-library/no-await-sync-queries': 'error', 'testing-library/no-global-regexp-flag-in-query': 'error', 'testing-library/no-node-access': 'error', diff --git a/lib/configs/react.ts b/lib/configs/react.ts index ab3b12d4..8d766247 100644 --- a/lib/configs/react.ts +++ b/lib/configs/react.ts @@ -11,6 +11,7 @@ export = { ], 'testing-library/await-async-query': 'error', 'testing-library/await-async-utils': 'error', + 'testing-library/no-await-sync-events': 'error', 'testing-library/no-await-sync-queries': 'error', 'testing-library/no-container': 'error', 'testing-library/no-debugging-utils': 'warn', diff --git a/lib/rules/no-await-sync-events.ts b/lib/rules/no-await-sync-events.ts index ebb0b5bc..8c7b0244 100644 --- a/lib/rules/no-await-sync-events.ts +++ b/lib/rules/no-await-sync-events.ts @@ -25,9 +25,9 @@ export default createTestingLibraryRule({ docs: { description: 'Disallow unnecessary `await` for sync events', recommendedConfig: { - dom: false, - angular: false, - react: false, + dom: 'error', + angular: 'error', + react: 'error', vue: false, marko: false, }, diff --git a/tests/__snapshots__/index.test.ts.snap b/tests/__snapshots__/index.test.ts.snap index bfece0f2..ccaa271a 100644 --- a/tests/__snapshots__/index.test.ts.snap +++ b/tests/__snapshots__/index.test.ts.snap @@ -15,6 +15,7 @@ Object { ], "testing-library/await-async-query": "error", "testing-library/await-async-utils": "error", + "testing-library/no-await-sync-events": "error", "testing-library/no-await-sync-queries": "error", "testing-library/no-container": "error", "testing-library/no-debugging-utils": "warn", @@ -50,6 +51,7 @@ Object { ], "testing-library/await-async-query": "error", "testing-library/await-async-utils": "error", + "testing-library/no-await-sync-events": "error", "testing-library/no-await-sync-queries": "error", "testing-library/no-global-regexp-flag-in-query": "error", "testing-library/no-node-access": "error", @@ -116,6 +118,7 @@ Object { ], "testing-library/await-async-query": "error", "testing-library/await-async-utils": "error", + "testing-library/no-await-sync-events": "error", "testing-library/no-await-sync-queries": "error", "testing-library/no-container": "error", "testing-library/no-debugging-utils": "warn",