@agilebot/eslint-plugin 0.5.1 → 0.5.3

package/README.md

@@ -1,6 +1,8 @@
 # @agilebot/eslint-plugin
 
-Agilebot extended ESLint rules. For @agilebot/eslint-config.
+[![npm](https://img.shields.io/npm/v/@agilebot/eslint-plugin?color=444&label=)](https://npmjs.com/package/@agilebot/eslint-plugin)
+
+Agilebot extended ESLint rules. Designed for @agilebot/eslint-config.
 
 ### Usage
 

package/dist/index.js

@@ -1,5 +1,5 @@
 /**
- * @license @agilebot/eslint-plugin v0.5.1
+ * @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 {
@@ -2627,8 +2663,8 @@ var tssUnusedClasses = createRule({
 const RULE_NAME = 'var-naming';
 const reactGlobalFuncs = new Set(['createContext', 'forwardRef', 'lazy', 'memo', 'combineProviders']);
 const reactFCTypes = new Set(['FC', 'FunctionComponent', 'VFC', 'VoidFunctionComponent']);
-const otherTypes = new Set(['StoryObj', 'StoryFn']);
-const defaultExcludes = ['^(__dirname|__filename)$', '(.*)Event$'];
+const defaultExcludeTypes = ['StoryObj', 'StoryFn'];
+const defaultExcludeNames = ['^(__dirname|__filename)$', '(.*)Event$'];
 var varNaming = createRule({
   name: RULE_NAME,
   meta: {
@@ -2652,7 +2688,19 @@ var varNaming = createRule({
             "enum": ['camelCase', 'PascalCase', 'UPPER_CASE']
           }
         },
-        exclude: {
+        excludeNames: {
+          type: 'array',
+          items: {
+            type: 'string'
+          }
+        },
+        excludeFuncs: {
+          type: 'array',
+          items: {
+            type: 'string'
+          }
+        },
+        excludeTypes: {
           type: 'array',
           items: {
             type: 'string'
@@ -2673,8 +2721,11 @@ var varNaming = createRule({
     }
     const funcFormat = context.options[0].funcFormat || ['camelCase'];
     const varFormat = context.options[0].varFormat || ['camelCase', 'UPPER_CASE'];
-    let exclude = context.options[0].exclude || [];
-    exclude = [...defaultExcludes, ...exclude];
+    let excludeNames = context.options[0].excludeNames || [];
+    excludeNames = [...defaultExcludeNames, ...excludeNames];
+    const excludeFuncs = context.options[0].excludeFuncs || [];
+    let excludeTypes = context.options[0].excludeTypes || [];
+    excludeTypes = [...defaultExcludeTypes, ...excludeTypes];
     function validate(type, {
       node,
       name
@@ -2801,14 +2852,18 @@ var varNaming = createRule({
           }
         } else if (node.id) {
           const varName = node.id.name;
-          for (const excludeRegex of exclude) {
+          for (const excludeRegex of excludeNames) {
             if (new RegExp(excludeRegex).test(varName)) {
               return;
             }
           }
           const typeName = getTypeReference(node);
-          if (typeName && otherTypes.has(typeName)) {
-            return;
+          if (typeName) {
+            for (const excludeRegex of excludeTypes) {
+              if (new RegExp(excludeRegex).test(typeName)) {
+                return;
+              }
+            }
           }
           if (node.id.parent && node.id.parent.init) {
             let calleeName;
@@ -2820,6 +2875,13 @@ var varNaming = createRule({
               shouldCheckReact = true;
               calleeName = node.id.parent.init.expression.callee.name;
             }
+            if (calleeName) {
+              for (const excludeRegex of excludeFuncs) {
+                if (new RegExp(excludeRegex).test(calleeName)) {
+                  return;
+                }
+              }
+            }
             if (shouldCheckReact) {
               if (!calleeName) {
                 return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agilebot/eslint-plugin",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "description": "Agilebot's ESLint plugin",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -19,11 +19,11 @@
   },
   "dependencies": {
     "@eslint/compat": "^1.1.1",
-    "@typescript-eslint/utils": "~8.5.0",
+    "@typescript-eslint/utils": "~8.7.0",
     "eslint-plugin-deprecation": "^3.0.0",
     "eslint-plugin-react": "^7.35.0",
     "eslint-plugin-react-hooks": "^4.6.2",
-    "@agilebot/eslint-utils": "0.5.1"
+    "@agilebot/eslint-utils": "0.5.3"
   },
   "peerDependencies": {
     "eslint": "^7.0.0 || ^8.0.0 || ^9.0.0"
@@ -36,7 +36,7 @@
     "@types/estree": "^1.0.5",
     "color-name": "^2.0.0",
     "eslint-vitest-rule-tester": "^0.6.1",
-    "typescript-eslint": "~8.5.0"
+    "typescript-eslint": "~8.7.0"
   },
   "scripts": {
     "build": "rollup -c rollup.config.mjs",