@agilebot/eslint-plugin 0.5.2 → 0.5.4

package/dist/index.js

@@ -1,5 +1,5 @@
 /**
- * @license @agilebot/eslint-plugin v0.5.2
+ * @license @agilebot/eslint-plugin v0.5.4
  *
  * 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
     };
@@ -849,6 +859,7 @@ var reactBetterExhaustiveDeps = {
     const stateVariables = new WeakSet();
     const stableKnownValueCache = new WeakMap();
     const functionWithoutCapturedValueCache = new WeakMap();
+    const useEffectEventVariables = new WeakSet();
     function memoizeWithWeakMap(fn, map) {
       return function (arg) {
         if (map.has(arg)) {
@@ -861,10 +872,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://react.dev/link/hooks-data-fetching'
+          });
+        }
       }
       const scope = scopeManager.acquire(node);
       const pureScopes = new Set();
@@ -901,7 +922,7 @@ var reactBetterExhaustiveDeps = {
         if (init == null) {
           return false;
         }
-        while (init.type === 'TSAsExpression') {
+        while (init.type === 'TSAsExpression' || init.type === 'AsExpression') {
           init = init.expression;
         }
         let declaration = def.node.parent;
@@ -931,7 +952,14 @@ var reactBetterExhaustiveDeps = {
         } = callee;
         if (name === 'useRef' && id.type === 'Identifier') {
           return true;
-        } else if (name === 'useState' || name === 'useReducer') {
+        } else if (isUseEffectEventIdentifier() && id.type === 'Identifier') {
+          for (const ref of resolved.references) {
+            if (ref !== id) {
+              useEffectEventVariables.add(ref.identifier);
+            }
+          }
+          return true;
+        } else if (name === 'useState' || name === 'useReducer' || name === 'useActionState') {
           if (id.type === 'ArrayPattern' && id.elements.length === 2 && isArray(resolved.identifiers)) {
             if (id.elements[1] === resolved.identifiers[0]) {
               if (name === 'useState') {
@@ -1218,13 +1246,16 @@ var reactBetterExhaustiveDeps = {
       }
       const declaredDependencies = [];
       const externalDependencies = new Set();
-      if (declaredDependenciesNode.type !== 'ArrayExpression') {
+      const isArrayExpression = declaredDependenciesNode.type === 'ArrayExpression';
+      const isTSAsArrayExpression = declaredDependenciesNode.type === 'TSAsExpression' && declaredDependenciesNode.expression.type === 'ArrayExpression';
+      if (!isArrayExpression && !isTSAsArrayExpression) {
         reportProblem({
           node: declaredDependenciesNode,
           message: "React Hook ".concat(getSource(reactiveHook), " was passed a ") + 'dependency list that is not an array literal. This means we ' + "can't statically verify whether you've passed the correct " + 'dependencies.'
         });
       } else {
-        declaredDependenciesNode.elements.forEach(declaredDependencyNode => {
+        const arrayExpression = isTSAsArrayExpression ? declaredDependenciesNode.expression : declaredDependenciesNode;
+        arrayExpression.elements.forEach(declaredDependencyNode => {
           if (declaredDependencyNode == null) {
             return;
           }
@@ -1235,6 +1266,18 @@ var reactBetterExhaustiveDeps = {
             });
             return;
           }
+          if (useEffectEventVariables.has(declaredDependencyNode)) {
+            reportProblem({
+              node: declaredDependencyNode,
+              message: 'Functions returned from `useEffectEvent` must not be included in the dependency array. ' + "Remove `".concat(getSource(declaredDependencyNode), "` from the list."),
+              suggest: [{
+                desc: "Remove the dependency `".concat(getSource(declaredDependencyNode), "`"),
+                fix(fixer) {
+                  return fixer.removeRange(declaredDependencyNode.range);
+                }
+              }]
+            });
+          }
           let declaredDependency;
           try {
             declaredDependency = analyzePropertyChain(declaredDependencyNode, null);
@@ -1512,7 +1555,8 @@ var reactBetterExhaustiveDeps = {
               extraWarning = " If '".concat(setStateRecommendation.setter, "' needs the ") + "current value of '".concat(setStateRecommendation.missingDep, "', ") + "you can also switch to useReducer instead of useState and " + "read '".concat(setStateRecommendation.missingDep, "' in the reducer.");
               break;
             case 'updater':
-              extraWarning = " You can also do a functional update '".concat(setStateRecommendation.setter, "(").concat(setStateRecommendation.missingDep.slice(0, 1), " => ...)' if you only need '").concat(setStateRecommendation.missingDep, "' in the '").concat(setStateRecommendation.setter, "' call.");
+              extraWarning = " You can also do a functional update '".concat(setStateRecommendation.setter, "(").concat(setStateRecommendation.missingDep.slice(0, 1), " => ...)' if you only need '").concat(setStateRecommendation.missingDep
+              , "'") + " in the '".concat(setStateRecommendation.setter, "' call.");
               break;
             default:
               throw new Error('Unknown case.');
@@ -1539,7 +1583,8 @@ var reactBetterExhaustiveDeps = {
       const callback = node.arguments[callbackIndex];
       const reactiveHook = node.callee;
       const reactiveHookName = getNodeWithoutReactNamespace(reactiveHook).name;
-      const declaredDependenciesNode = node.arguments[callbackIndex + 1];
+      const maybeNode = node.arguments[callbackIndex + 1];
+      const declaredDependenciesNode = maybeNode && !(maybeNode.type === 'Identifier' && maybeNode.name === 'undefined') ? maybeNode : undefined;
       const isEffect = /Effect($|[^a-z])/g.test(reactiveHookName);
       if (!callback) {
         reportProblem({
@@ -1562,6 +1607,9 @@ var reactBetterExhaustiveDeps = {
         case 'ArrowFunctionExpression':
           visitFunctionWithDependencies(callback, declaredDependenciesNode, reactiveHook, reactiveHookName, isEffect);
           return;
+        case 'TSAsExpression':
+          visitFunctionWithDependencies(callback.expression, declaredDependenciesNode, reactiveHook, reactiveHookName, isEffect);
+          return;
         case 'Identifier':
           if (!declaredDependenciesNode) {
             return;
@@ -1766,7 +1814,7 @@ function getConstructionExpressionType(node) {
       }
       return null;
     case 'TypeCastExpression':
-      return getConstructionExpressionType(node.expression);
+    case 'AsExpression':
     case 'TSAsExpression':
       return getConstructionExpressionType(node.expression);
   }
@@ -1904,6 +1952,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 {
@@ -1972,6 +2036,9 @@ function isSameIdentifier(a, b) {
 function isAncestorNodeOf(a, b) {
   return a.range[0] <= b.range[0] && a.range[1] >= b.range[1];
 }
+function isUseEffectEventIdentifier(node) {
+  return false;
+}
 
 const Components = require('eslint-plugin-react/lib/util/Components');
 const RULE_NAME$7 = 'react-hook-use-ref';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agilebot/eslint-plugin",
-  "version": "0.5.2",
+  "version": "0.5.4",
   "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.4"
   },
   "peerDependencies": {
     "eslint": "^7.0.0 || ^8.0.0 || ^9.0.0"