chore: add no-async-foreach-callback eslint rule

nicktrn · nicktrn · commit 53dfbcf64d6e · 2023-08-24T13:22:55.000Z
diff --git a/packages/eslint-plugin/src/configs/recommended.ts b/packages/eslint-plugin/src/configs/recommended.ts
@@ -5,6 +5,7 @@ const recommended = {
     "@calcom/eslint/deprecated-imports": "error",
     "@calcom/eslint/avoid-web-storage": "error",
     "@calcom/eslint/avoid-prisma-client-import-for-enums": "error",
+    "@calcom/eslint/no-async-foreach-callback": "error",
   },
 };
 
diff --git a/packages/eslint-plugin/src/rules/index.ts b/packages/eslint-plugin/src/rules/index.ts
@@ -5,4 +5,5 @@ export default {
   "deprecated-imports": require("./deprecated-imports").default,
   "avoid-web-storage": require("./avoid-web-storage").default,
   "avoid-prisma-client-import-for-enums": require("./avoid-prisma-client-import-for-enums").default,
+  "no-async-foreach-callback": require("./no-async-foreach-callback").default,
 } as ESLint.Plugin["rules"];
diff --git a/packages/eslint-plugin/src/rules/no-async-foreach-callback.ts b/packages/eslint-plugin/src/rules/no-async-foreach-callback.ts
@@ -0,0 +1,44 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+
+const createRule = ESLintUtils.RuleCreator((name) => `https://developer.cal.com/eslint/rule/${name}`);
+
+const rule = createRule({
+  create(context) {
+    return {
+      CallExpression(node) {
+        const { callee } = node;
+        if (
+          callee.type === "MemberExpression" &&
+          callee.property.type === "Identifier" &&
+          callee.property.name === "forEach"
+        ) {
+          const firstArg = node.arguments[0];
+          if (
+            (firstArg.type === "ArrowFunctionExpression" || firstArg.type === "FunctionExpression") &&
+            firstArg.async
+          ) {
+            context.report({
+              node,
+              messageId: "async-foreach",
+            });
+          }
+        }
+      },
+    };
+  },
+  name: "no-async-foreach-callback",
+  meta: {
+    docs: {
+      description: "Disallow using an async function as a forEach callback",
+      recommended: "warn",
+    },
+    messages: {
+      "async-foreach": "forEach callbacks should not be async, did you mean to use Promise.all?",
+    },
+    type: "suggestion",
+    schema: [],
+  },
+  defaultOptions: [],
+});
+
+export default rule;
