fix(prefer-ending-with-an-expect): don't report on await expect (#1752)

Author: G-Rath

src/rules/__tests__/prefer-ending-with-an-expect.test.ts

@@ -53,7 +53,7 @@ ruleTester.run('prefer-ending-with-an-expect', rule, {
       code: dedent`
         test('verifies chained expect method call', () => {
           doSomething();
-        
+
           tester
             .foo()
             .bar()
@@ -70,6 +70,10 @@ ruleTester.run('prefer-ending-with-an-expect', rule, {
       `,
       options: [{ assertFunctionNames: ['td.verify'] }],
     },
+    {
+      code: 'it("should pass", async () => expect(true).toBeDefined())',
+      parserOptions: { ecmaVersion: 2017 },
+    },
     {
       code: 'it("should pass", () => expect(true).toBeDefined())',
       options: [
@@ -92,6 +96,34 @@ ruleTester.run('prefer-ending-with-an-expect', rule, {
         expect(container.toHTML()).toContain('Hello Bob!');
       });
     `,
+    {
+      code: dedent`
+        it('is a complete test', async () => {
+          const container = render(Greeter);
+
+          expect(container).toBeDefined();
+
+          container.setProp('name', 'Bob');
+
+          await expect(container.toHTML()).resolve.toContain('Hello Bob!');
+        });
+      `,
+      parserOptions: { ecmaVersion: 2017 },
+    },
+    {
+      code: dedent`
+        it('is a complete test', async function () {
+          const container = render(Greeter);
+
+          expect(container).toBeDefined();
+
+          container.setProp('name', 'Bob');
+
+          await expect(container.toHTML()).resolve.toContain('Hello Bob!');
+        });
+      `,
+      parserOptions: { ecmaVersion: 2017 },
+    },
     {
       code: dedent`
         describe('GET /user', function () {
@@ -280,6 +312,24 @@ ruleTester.run('prefer-ending-with-an-expect', rule, {
         },
       ],
     },
+    {
+      code: dedent`
+        it('is a complete test', async () => {
+          const container = render(Greeter);
+
+          await expect(container).toBeDefined();
+
+          await container.setProp('name', 'Bob');
+        });
+      `,
+      parserOptions: { ecmaVersion: 2017 },
+      errors: [
+        {
+          messageId: 'mustEndWithExpect',
+          type: AST_NODE_TYPES.Identifier,
+        },
+      ],
+    },
   ],
 });
 

src/rules/prefer-ending-with-an-expect.ts

@@ -118,7 +118,11 @@ export default createRule<
           return;
         }
 
-        const lastStatement = getLastStatement(node.arguments[1]);
+        let lastStatement = getLastStatement(node.arguments[1]);
+
+        if (lastStatement?.type === AST_NODE_TYPES.AwaitExpression) {
+          lastStatement = lastStatement.argument;
+        }
 
         if (
           lastStatement?.type === AST_NODE_TYPES.CallExpression &&