@agilebot/eslint-plugin 0.5.2 → 0.5.3

package/dist/index.js

@@ -1,5 +1,5 @@
 /**
- * @license @agilebot/eslint-plugin v0.5.2
+ * @license @agilebot/eslint-plugin v0.5.3
  *
  * Copyright (c) Agilebot, Inc. and its affiliates.
  *
@@ -792,6 +792,14 @@ var reactBetterExhaustiveDeps = {
         enableDangerousAutofixThisMayCauseInfiniteLoops: {
           type: 'boolean'
         },
+        customHooks: {
+          type: 'object',
+          additionalProperties: {
+            callbackIndex: {
+              type: 'number'
+            }
+          }
+        },
         staticHooks: {
           type: 'object',
           additionalProperties: {
@@ -819,11 +827,13 @@ var reactBetterExhaustiveDeps = {
   create(context) {
     const additionalHooks = context.options && context.options[0] && context.options[0].additionalHooks ? new RegExp(context.options[0].additionalHooks) : undefined;
     const enableDangerousAutofixThisMayCauseInfiniteLoops = context.options && context.options[0] && context.options[0].enableDangerousAutofixThisMayCauseInfiniteLoops || false;
+    const customHooks = context.options && context.options[0] && context.options[0].customHooks || {};
     const staticHooks = context.options && context.options[0] && context.options[0].staticHooks || {};
     const checkMemoizedVariableIsStatic = context.options && context.options[0] && context.options[0].checkMemoizedVariableIsStatic || false;
     const options = {
       additionalHooks,
       enableDangerousAutofixThisMayCauseInfiniteLoops,
+      customHooks,
       staticHooks,
       checkMemoizedVariableIsStatic
     };
@@ -861,10 +871,20 @@ var reactBetterExhaustiveDeps = {
     }
     function visitFunctionWithDependencies(node, declaredDependenciesNode, reactiveHook, reactiveHookName, isEffect) {
       if (isEffect && node.async) {
-        reportProblem({
-          node: node,
-          message: "Effect callbacks are synchronous to prevent race conditions. " + "Put the async function inside:\n\n" + 'useEffect(() => {\n' + '  async function fetchData() {\n' + '    // You can await here\n' + '    const response = await MyAPI.getData(someId);\n' + '    // ...\n' + '  }\n' + '  fetchData();\n' + "}, [someId]); // Or [] if effect doesn't need props or state\n\n" + 'Learn more about data fetching with Hooks: https://reactjs.org/link/hooks-data-fetching'
-        });
+        let isCustomHook = false;
+        if (options.customHooks) {
+          Object.entries(options.customHooks).forEach(([key, customParts]) => {
+            if (typeof customParts === 'object' && new RegExp(key).test(reactiveHookName)) {
+              isCustomHook = true;
+            }
+          });
+        }
+        if (!isCustomHook) {
+          reportProblem({
+            node: node,
+            message: "Effect callbacks are synchronous to prevent race conditions. " + "Put the async function inside:\n\n" + 'useEffect(() => {\n' + '  async function fetchData() {\n' + '    // You can await here\n' + '    const response = await MyAPI.getData(someId);\n' + '    // ...\n' + '  }\n' + '  fetchData();\n' + "}, [someId]); // Or [] if effect doesn't need props or state\n\n" + 'Learn more about data fetching with Hooks: https://reactjs.org/link/hooks-data-fetching'
+          });
+        }
       }
       const scope = scopeManager.acquire(node);
       const pureScopes = new Set();
@@ -1904,6 +1924,22 @@ function getReactiveHookCallbackIndex(calleeNode, options) {
     case 'useImperativeHandle':
       return 1;
     default:
+      if (node === calleeNode && options && options.customHooks) {
+        let name;
+        try {
+          name = analyzePropertyChain(node, null);
+        } catch (err) {
+          if (/Unsupported node type/.test(err.message)) {
+            return 0;
+          }
+          throw err;
+        }
+        for (const [key, customParts] of Object.entries(options.customHooks)) {
+          if (typeof customParts === 'object' && typeof customParts.callbackIndex === 'number' && new RegExp(key).test(name)) {
+            return customParts.callbackIndex;
+          }
+        }
+      }
       if (node === calleeNode && options && options.additionalHooks) {
         let name;
         try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agilebot/eslint-plugin",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "description": "Agilebot's ESLint plugin",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -23,7 +23,7 @@
     "eslint-plugin-deprecation": "^3.0.0",
     "eslint-plugin-react": "^7.35.0",
     "eslint-plugin-react-hooks": "^4.6.2",
-    "@agilebot/eslint-utils": "0.5.2"
+    "@agilebot/eslint-utils": "0.5.3"
   },
   "peerDependencies": {
     "eslint": "^7.0.0 || ^8.0.0 || ^9.0.0"