fix(no-done-callback): fix regression with it.each (#708)

* fix(no-done-callback): fix regression with it.each

* chore: apply suggestions from code review

* chore: apply another suggestion from code review

Co-authored-by: Simen Bekkhus <[email protected]>

Co-authored-by: Gareth Jones <[email protected]>
Co-authored-by: Simen Bekkhus <[email protected]>

Author: 3 people

src/rules/__tests__/no-done-callback.test.ts

@@ -15,6 +15,10 @@ ruleTester.run('no-done-callback', rule, {
     'test("something", () => {})',
     'test("something", async () => {})',
     'test("something", function() {})',
+    'test.each``("something", ({ a, b }) => {})',
+    'test.each()("something", ({ a, b }) => {})',
+    'it.each()("something", ({ a, b }) => {})',
+    'it.each``("something", ({ a, b }) => {})',
     'test("something", async function () {})',
     'test("something", someArg)',
     'beforeEach(() => {})',
@@ -385,5 +389,45 @@ ruleTester.run('no-done-callback', rule, {
         },
       ],
     },
+    {
+      code: 'test.each``("something", ({ a, b }, done) => { done(); })',
+      errors: [
+        {
+          messageId: 'noDoneCallback',
+          line: 1,
+          column: 37,
+        },
+      ],
+    },
+    {
+      code: 'test.each()("something", ({ a, b }, done) => { done(); })',
+      errors: [
+        {
+          messageId: 'noDoneCallback',
+          line: 1,
+          column: 37,
+        },
+      ],
+    },
+    {
+      code: 'it.each``("something", ({ a, b }, done) => { done(); })',
+      errors: [
+        {
+          messageId: 'noDoneCallback',
+          line: 1,
+          column: 35,
+        },
+      ],
+    },
+    {
+      code: 'it.each()("something", ({ a, b }, done) => { done(); })',
+      errors: [
+        {
+          messageId: 'noDoneCallback',
+          line: 1,
+          column: 35,
+        },
+      ],
+    },
   ],
 });

src/rules/no-done-callback.ts

@@ -2,11 +2,22 @@ import {
   AST_NODE_TYPES,
   TSESTree,
 } from '@typescript-eslint/experimental-utils';
-import { createRule, isFunction, isHook, isTestCase } from './utils';
+import {
+  createRule,
+  getNodeName,
+  isFunction,
+  isHook,
+  isTestCase,
+} from './utils';
 
 const findCallbackArg = (
   node: TSESTree.CallExpression,
+  isJestEach: boolean,
 ): TSESTree.CallExpression['arguments'][0] | null => {
+  if (isJestEach) {
+    return node.arguments[1];
+  }
+
   if (isHook(node) && node.arguments.length >= 1) {
     return node.arguments[0];
   }
@@ -41,17 +52,21 @@ export default createRule({
   create(context) {
     return {
       CallExpression(node) {
-        const callback = findCallbackArg(node);
+        // done is the second argument for it.each, not the first
+        const isJestEach = getNodeName(node.callee)?.endsWith('.each') ?? false;
+
+        const callback = findCallbackArg(node, isJestEach);
+        const callbackArgIndex = Number(isJestEach);
 
         if (
           !callback ||
           !isFunction(callback) ||
-          callback.params.length !== 1
+          callback.params.length !== 1 + callbackArgIndex
         ) {
           return;
         }
 
-        const [argument] = callback.params;
+        const argument = callback.params[callbackArgIndex];
 
         if (argument.type !== AST_NODE_TYPES.Identifier) {
           context.report({