fix(await-async-event): pluralize to await-async-events (#670)

testing-library · Oct 5, 2022 · 7238f76 · 7238f76
1 parent d0a5d35
commit 7238f76
Show file tree

Hide file tree

Showing 11 changed files with 21 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -207,7 +207,7 @@ To enable this configuration use the `extends` property in your
 
 | Name                                                                                 | Description                                                                                  | 🔧  | Included in configurations                                                         |
 | ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------- | --- | ---------------------------------------------------------------------------------- |
-| [`await-async-event`](./docs/rules/await-async-event.md)                             | Enforce promises from async event methods are handled                                        | 🔧  | ![dom-badge][] ![angular-badge][] ![react-badge][] ![vue-badge][] ![marko-badge][] |
+| [`await-async-events`](./docs/rules/await-async-events.md)                           | Enforce promises from async event methods are handled                                        | 🔧  | ![dom-badge][] ![angular-badge][] ![react-badge][] ![vue-badge][] ![marko-badge][] |
 | [`await-async-queries`](./docs/rules/await-async-queries.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`                                                    |     |                                                                                    |

diff --git a/docs/rules/await-async-event.md → docs/rules/await-async-events.md b/docs/rules/await-async-event.md → docs/rules/await-async-events.md
@@ -1,4 +1,4 @@
-# Enforce promises from async event methods are handled (`testing-library/await-async-event`)
+# Enforce promises from async event methods are handled (`testing-library/await-async-events`)
 
 Ensure that promises returned by `userEvent` (v14+) async methods or `fireEvent` (only Vue and Marko) async methods are handled properly.
 
@@ -102,7 +102,7 @@ await Promise.all([
 
 ```json
 {
-	"testing-library/await-async-event": [
+	"testing-library/await-async-events": [
 		2,
 		{
 			"eventModule": "userEvent"
@@ -113,7 +113,7 @@ await Promise.all([
 
 ```json
 {
-	"testing-library/await-async-event": [
+	"testing-library/await-async-events": [
 		2,
 		{
 			"eventModule": "fireEvent"
@@ -124,7 +124,7 @@ await Promise.all([
 
 ```json
 {
-	"testing-library/await-async-event": [
+	"testing-library/await-async-events": [
 		2,
 		{
 			"eventModule": ["fireEvent", "userEvent"]

diff --git a/docs/rules/no-await-sync-events.md b/docs/rules/no-await-sync-events.md
@@ -105,4 +105,4 @@ Example:
 ## Notes
 
 - Since `user-event` v14 all its methods are async, so you should disable reporting them by setting the `eventModules` to just `"fire-event"` so `user-event` methods are not reported.
-- There is another rule `await-async-event`, which is for awaiting async events for `user-event` v14 or `fire-event` only in Vue Testing Library. Please do not confuse with this rule.
+- There is another rule `await-async-events`, which is for awaiting async events for `user-event` v14 or `fire-event` only in Vue Testing Library. Please do not confuse with this rule.
diff --git a/lib/configs/angular.ts b/lib/configs/angular.ts
@@ -5,7 +5,7 @@
 export = {
 	plugins: ['testing-library'],
 	rules: {
-		'testing-library/await-async-event': [
+		'testing-library/await-async-events': [
 			'error',
 			{ eventModule: 'userEvent' },
 		],

diff --git a/lib/configs/dom.ts b/lib/configs/dom.ts
@@ -5,7 +5,7 @@
 export = {
 	plugins: ['testing-library'],
 	rules: {
-		'testing-library/await-async-event': [
+		'testing-library/await-async-events': [
 			'error',
 			{ eventModule: 'userEvent' },
 		],

diff --git a/lib/configs/marko.ts b/lib/configs/marko.ts
@@ -5,7 +5,7 @@
 export = {
 	plugins: ['testing-library'],
 	rules: {
-		'testing-library/await-async-event': [
+		'testing-library/await-async-events': [
 			'error',
 			{ eventModule: ['fireEvent', 'userEvent'] },
 		],

diff --git a/lib/configs/react.ts b/lib/configs/react.ts
@@ -5,7 +5,7 @@
 export = {
 	plugins: ['testing-library'],
 	rules: {
-		'testing-library/await-async-event': [
+		'testing-library/await-async-events': [
 			'error',
 			{ eventModule: 'userEvent' },
 		],

diff --git a/lib/configs/vue.ts b/lib/configs/vue.ts
@@ -5,7 +5,7 @@
 export = {
 	plugins: ['testing-library'],
 	rules: {
-		'testing-library/await-async-event': [
+		'testing-library/await-async-events': [
 			'error',
 			{ eventModule: ['fireEvent', 'userEvent'] },
 		],

diff --git a/lib/rules/await-async-event.ts → lib/rules/await-async-events.ts b/lib/rules/await-async-event.ts → lib/rules/await-async-events.ts
@@ -11,7 +11,7 @@ import {
 } from '../node-utils';
 import { EVENTS_SIMULATORS } from '../utils';
 
-export const RULE_NAME = 'await-async-event';
+export const RULE_NAME = 'await-async-events';
 export type MessageIds = 'awaitAsyncEvent' | 'awaitAsyncEventWrapper';
 const FIRE_EVENT_NAME = 'fireEvent';
 const USER_EVENT_NAME = 'userEvent';

diff --git a/tests/__snapshots__/index.test.ts.snap b/tests/__snapshots__/index.test.ts.snap
@@ -7,7 +7,7 @@ Object {
       "testing-library",
     ],
     "rules": Object {
-      "testing-library/await-async-event": Array [
+      "testing-library/await-async-events": Array [
         "error",
         Object {
           "eventModule": "userEvent",
@@ -43,7 +43,7 @@ Object {
       "testing-library",
     ],
     "rules": Object {
-      "testing-library/await-async-event": Array [
+      "testing-library/await-async-events": Array [
         "error",
         Object {
           "eventModule": "userEvent",
@@ -71,7 +71,7 @@ Object {
       "testing-library",
     ],
     "rules": Object {
-      "testing-library/await-async-event": Array [
+      "testing-library/await-async-events": Array [
         "error",
         Object {
           "eventModule": Array [
@@ -110,7 +110,7 @@ Object {
       "testing-library",
     ],
     "rules": Object {
-      "testing-library/await-async-event": Array [
+      "testing-library/await-async-events": Array [
         "error",
         Object {
           "eventModule": "userEvent",
@@ -148,7 +148,7 @@ Object {
       "testing-library",
     ],
     "rules": Object {
-      "testing-library/await-async-event": Array [
+      "testing-library/await-async-events": Array [
         "error",
         Object {
           "eventModule": Array [

diff --git a/tests/lib/rules/await-async-event.test.ts → tests/lib/rules/await-async-events.test.ts b/tests/lib/rules/await-async-event.test.ts → tests/lib/rules/await-async-events.test.ts
@@ -1,4 +1,7 @@
-import rule, { Options, RULE_NAME } from '../../../lib/rules/await-async-event';
+import rule, {
+	Options,
+	RULE_NAME,
+} from '../../../lib/rules/await-async-events';
 import { createRuleTester } from '../test-utils';
 
 const ruleTester = createRuleTester();