@tanstack/eslint-plugin-query 5.18.1 → 5.20.1

package/dist/esm/rules/{no-rest-desctructuring → no-rest-destructuring}/no-rest-destructuring.rule.js

@@ -1,9 +1,11 @@
-import { AST_NODE_TYPES } from "@typescript-eslint/utils";
-import { createRule } from "../../utils/create-rule.js";
+import { ESLintUtils, AST_NODE_TYPES } from "@typescript-eslint/utils";
+import { getDocsUrl } from "../../utils/get-docs-url.js";
 import { ASTUtils } from "../../utils/ast-utils.js";
+import { detectTanstackQueryImports } from "../../utils/detect-react-query-imports.js";
 import { NoRestDestructuringUtils } from "./no-rest-destructuring.utils.js";
 const name = "no-rest-destructuring";
 const queryHooks = ["useQuery", "useQueries", "useInfiniteQuery"];
+const createRule = ESLintUtils.RuleCreator(getDocsUrl);
 const rule = createRule({
   name,
   meta: {
@@ -18,11 +20,10 @@ const rule = createRule({
     schema: []
   },
   defaultOptions: [],
-  create(context, _, helpers) {
+  create: detectTanstackQueryImports((context, _, helpers) => {
     return {
-      CallExpression(node) {
-        var _a;
-        if (!ASTUtils.isIdentifierWithOneOfNames(node.callee, queryHooks) || !helpers.isTanstackQueryImport(node.callee) || ((_a = node.parent) == null ? void 0 : _a.type) !== AST_NODE_TYPES.VariableDeclarator) {
+      CallExpression: (node) => {
+        if (!ASTUtils.isIdentifierWithOneOfNames(node.callee, queryHooks) || !helpers.isTanstackQueryImport(node.callee) || node.parent.type !== AST_NODE_TYPES.VariableDeclarator) {
           return;
         }
         const returnValue = node.parent.id;
@@ -51,7 +52,7 @@ const rule = createRule({
         });
       }
     };
-  }
+  })
 });
 export {
   name,

package/dist/esm/rules/no-rest-destructuring/no-rest-destructuring.rule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-rest-destructuring.rule.js","sources":["../../../../src/rules/no-rest-destructuring/no-rest-destructuring.rule.ts"],"sourcesContent":["import { AST_NODE_TYPES, ESLintUtils } from '@typescript-eslint/utils'\nimport { getDocsUrl } from '../../utils/get-docs-url'\nimport { ASTUtils } from '../../utils/ast-utils'\nimport { detectTanstackQueryImports } from '../../utils/detect-react-query-imports'\nimport { NoRestDestructuringUtils } from './no-rest-destructuring.utils'\n\nexport const name = 'no-rest-destructuring'\n\nconst queryHooks = ['useQuery', 'useQueries', 'useInfiniteQuery']\n\nconst createRule = ESLintUtils.RuleCreator(getDocsUrl)\n\nexport const rule = createRule({\n  name,\n  meta: {\n    type: 'problem',\n    docs: {\n      description: 'Disallows rest destructuring in queries',\n      recommended: 'warn' as any,\n    },\n    messages: {\n      objectRestDestructure: `Object rest destructuring on a query will observe all changes to the query, leading to excessive re-renders.`,\n    },\n    schema: [],\n  },\n  defaultOptions: [],\n\n  create: detectTanstackQueryImports((context, _, helpers) => {\n    return {\n      CallExpression: (node) => {\n        if (\n          !ASTUtils.isIdentifierWithOneOfNames(node.callee, queryHooks) ||\n          !helpers.isTanstackQueryImport(node.callee) ||\n          node.parent.type !== AST_NODE_TYPES.VariableDeclarator\n        ) {\n          return\n        }\n\n        const returnValue = node.parent.id\n        if (node.callee.name !== 'useQueries') {\n          if (NoRestDestructuringUtils.isObjectRestDestructuring(returnValue)) {\n            context.report({\n              node: node.parent,\n              messageId: 'objectRestDestructure',\n            })\n          }\n          return\n        }\n\n        if (returnValue.type !== AST_NODE_TYPES.ArrayPattern) {\n          return\n        }\n        returnValue.elements.forEach((queryResult) => {\n          if (queryResult === null) {\n            return\n          }\n          if (NoRestDestructuringUtils.isObjectRestDestructuring(queryResult)) {\n            context.report({\n              node: queryResult,\n              messageId: 'objectRestDestructure',\n            })\n          }\n        })\n      },\n    }\n  }),\n})\n"],"names":[],"mappings":";;;;;AAMO,MAAM,OAAO;AAEpB,MAAM,aAAa,CAAC,YAAY,cAAc,kBAAkB;AAEhE,MAAM,aAAa,YAAY,YAAY,UAAU;AAE9C,MAAM,OAAO,WAAW;AAAA,EAC7B;AAAA,EACA,MAAM;AAAA,IACJ,MAAM;AAAA,IACN,MAAM;AAAA,MACJ,aAAa;AAAA,MACb,aAAa;AAAA,IACf;AAAA,IACA,UAAU;AAAA,MACR,uBAAuB;AAAA,IACzB;AAAA,IACA,QAAQ,CAAC;AAAA,EACX;AAAA,EACA,gBAAgB,CAAC;AAAA,EAEjB,QAAQ,2BAA2B,CAAC,SAAS,GAAG,YAAY;AACnD,WAAA;AAAA,MACL,gBAAgB,CAAC,SAAS;AACxB,YACE,CAAC,SAAS,2BAA2B,KAAK,QAAQ,UAAU,KAC5D,CAAC,QAAQ,sBAAsB,KAAK,MAAM,KAC1C,KAAK,OAAO,SAAS,eAAe,oBACpC;AACA;AAAA,QACF;AAEM,cAAA,cAAc,KAAK,OAAO;AAC5B,YAAA,KAAK,OAAO,SAAS,cAAc;AACjC,cAAA,yBAAyB,0BAA0B,WAAW,GAAG;AACnE,oBAAQ,OAAO;AAAA,cACb,MAAM,KAAK;AAAA,cACX,WAAW;AAAA,YAAA,CACZ;AAAA,UACH;AACA;AAAA,QACF;AAEI,YAAA,YAAY,SAAS,eAAe,cAAc;AACpD;AAAA,QACF;AACY,oBAAA,SAAS,QAAQ,CAAC,gBAAgB;AAC5C,cAAI,gBAAgB,MAAM;AACxB;AAAA,UACF;AACI,cAAA,yBAAyB,0BAA0B,WAAW,GAAG;AACnE,oBAAQ,OAAO;AAAA,cACb,MAAM;AAAA,cACN,WAAW;AAAA,YAAA,CACZ;AAAA,UACH;AAAA,QAAA,CACD;AAAA,MACH;AAAA,IAAA;AAAA,EACF,CACD;AACH,CAAC;"}

package/dist/esm/rules/no-rest-destructuring/no-rest-destructuring.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-rest-destructuring.utils.js","sources":["../../../../src/rules/no-rest-destructuring/no-rest-destructuring.utils.ts"],"sourcesContent":["import { AST_NODE_TYPES } from '@typescript-eslint/utils'\nimport type { TSESTree } from '@typescript-eslint/utils'\n\nexport const NoRestDestructuringUtils = {\n  isObjectRestDestructuring(node: TSESTree.Node): boolean {\n    if (node.type !== AST_NODE_TYPES.ObjectPattern) {\n      return false\n    }\n    return node.properties.some((p) => p.type === AST_NODE_TYPES.RestElement)\n  },\n}\n"],"names":[],"mappings":";AAGO,MAAM,2BAA2B;AAAA,EACtC,0BAA0B,MAA8B;AAClD,QAAA,KAAK,SAAS,eAAe,eAAe;AACvC,aAAA;AAAA,IACT;AACO,WAAA,KAAK,WAAW,KAAK,CAAC,MAAM,EAAE,SAAS,eAAe,WAAW;AAAA,EAC1E;AACF;"}

package/dist/esm/rules/stable-query-client/stable-query-client.rule.d.ts

@@ -1,3 +1,3 @@
-import type { TSESLint } from '@typescript-eslint/utils';
+import { ESLintUtils } from '@typescript-eslint/utils';
 export declare const name = "stable-query-client";
-export declare const rule: TSESLint.RuleModule<string, readonly unknown[], TSESLint.RuleListener>;
+export declare const rule: ESLintUtils.RuleModule<string, readonly unknown[], ESLintUtils.RuleListener>;

package/dist/esm/rules/stable-query-client/stable-query-client.rule.js

@@ -1,7 +1,9 @@
-import { AST_NODE_TYPES } from "@typescript-eslint/utils";
+import { ESLintUtils, AST_NODE_TYPES } from "@typescript-eslint/utils";
 import { ASTUtils } from "../../utils/ast-utils.js";
-import { createRule } from "../../utils/create-rule.js";
+import { getDocsUrl } from "../../utils/get-docs-url.js";
+import { detectTanstackQueryImports } from "../../utils/detect-react-query-imports.js";
 const name = "stable-query-client";
+const createRule = ESLintUtils.RuleCreator(getDocsUrl);
 const rule = createRule({
   name,
   meta: {
@@ -22,11 +24,10 @@ const rule = createRule({
     schema: []
   },
   defaultOptions: [],
-  create(context, _, helpers) {
+  create: detectTanstackQueryImports((context, _, helpers) => {
     return {
-      NewExpression(node) {
-        var _a;
-        if (node.callee.type !== AST_NODE_TYPES.Identifier || node.callee.name !== "QueryClient" || ((_a = node.parent) == null ? void 0 : _a.type) !== AST_NODE_TYPES.VariableDeclarator || !helpers.isSpecificTanstackQueryImport(
+      NewExpression: (node) => {
+        if (node.callee.type !== AST_NODE_TYPES.Identifier || node.callee.name !== "QueryClient" || node.parent.type !== AST_NODE_TYPES.VariableDeclarator || !helpers.isSpecificTanstackQueryImport(
           node.callee,
           "@tanstack/react-query"
         )) {
@@ -57,7 +58,7 @@ const rule = createRule({
         });
       }
     };
-  }
+  })
 });
 export {
   name,

package/dist/esm/rules/stable-query-client/stable-query-client.rule.js.map

@@ -1 +1 @@
-{"version":3,"file":"stable-query-client.rule.js","sources":["../../../../src/rules/stable-query-client/stable-query-client.rule.ts"],"sourcesContent":["import { AST_NODE_TYPES } from '@typescript-eslint/utils'\nimport { ASTUtils } from '../../utils/ast-utils'\nimport { createRule } from '../../utils/create-rule'\nimport type { TSESLint } from '@typescript-eslint/utils'\n\nexport const name = 'stable-query-client'\n\nexport const rule = createRule({\n  name,\n  meta: {\n    type: 'problem',\n    docs: {\n      description: 'Makes sure that QueryClient is stable',\n      recommended: 'error',\n    },\n    messages: {\n      unstable: [\n        'QueryClient is not stable. It should be either extracted from the component or wrapped in React.useState.',\n        'See https://tkdodo.eu/blog/react-query-fa-qs#2-the-queryclient-is-not-stable',\n      ].join('\\n'),\n      fixTo: 'Fix to {{result}}',\n    },\n    hasSuggestions: true,\n    fixable: 'code',\n    schema: [],\n  },\n  defaultOptions: [],\n\n  create(context, _, helpers) {\n    return {\n      NewExpression(node) {\n        if (\n          node.callee.type !== AST_NODE_TYPES.Identifier ||\n          node.callee.name !== 'QueryClient' ||\n          node.parent?.type !== AST_NODE_TYPES.VariableDeclarator ||\n          !helpers.isSpecificTanstackQueryImport(\n            node.callee,\n            '@tanstack/react-query',\n          )\n        ) {\n          return\n        }\n\n        const fnAncestor = ASTUtils.getFunctionAncestor(context)\n        const isReactServerComponent = fnAncestor?.async === true\n\n        if (\n          !ASTUtils.isValidReactComponentOrHookName(fnAncestor?.id) ||\n          isReactServerComponent\n        ) {\n          return\n        }\n\n        context.report({\n          node: node.parent,\n          messageId: 'unstable',\n          fix: (() => {\n            const { parent } = node\n\n            if (parent.id.type !== AST_NODE_TYPES.Identifier) {\n              return\n            }\n\n            const nodeText = context.getSourceCode().getText(node)\n            const variableName = parent.id.name\n\n            return (fixer: TSESLint.RuleFixer) => {\n              return fixer.replaceTextRange(\n                [parent.range[0], parent.range[1]],\n                `[${variableName}] = React.useState(() => ${nodeText})`,\n              )\n            }\n          })(),\n        })\n      },\n    }\n  },\n})\n"],"names":[],"mappings":";;;AAKO,MAAM,OAAO;AAEb,MAAM,OAAO,WAAW;AAAA,EAC7B;AAAA,EACA,MAAM;AAAA,IACJ,MAAM;AAAA,IACN,MAAM;AAAA,MACJ,aAAa;AAAA,MACb,aAAa;AAAA,IACf;AAAA,IACA,UAAU;AAAA,MACR,UAAU;AAAA,QACR;AAAA,QACA;AAAA,MAAA,EACA,KAAK,IAAI;AAAA,MACX,OAAO;AAAA,IACT;AAAA,IACA,gBAAgB;AAAA,IAChB,SAAS;AAAA,IACT,QAAQ,CAAC;AAAA,EACX;AAAA,EACA,gBAAgB,CAAC;AAAA,EAEjB,OAAO,SAAS,GAAG,SAAS;AACnB,WAAA;AAAA,MACL,cAAc,MAAM;;AAClB,YACE,KAAK,OAAO,SAAS,eAAe,cACpC,KAAK,OAAO,SAAS,mBACrB,UAAK,WAAL,mBAAa,UAAS,eAAe,sBACrC,CAAC,QAAQ;AAAA,UACP,KAAK;AAAA,UACL;AAAA,QAAA,GAEF;AACA;AAAA,QACF;AAEM,cAAA,aAAa,SAAS,oBAAoB,OAAO;AACjD,cAAA,0BAAyB,yCAAY,WAAU;AAErD,YACE,CAAC,SAAS,gCAAgC,yCAAY,EAAE,KACxD,wBACA;AACA;AAAA,QACF;AAEA,gBAAQ,OAAO;AAAA,UACb,MAAM,KAAK;AAAA,UACX,WAAW;AAAA,UACX,MAAM,MAAM;AACJ,kBAAA,EAAE,OAAW,IAAA;AAEnB,gBAAI,OAAO,GAAG,SAAS,eAAe,YAAY;AAChD;AAAA,YACF;AAEA,kBAAM,WAAW,QAAQ,cAAc,EAAE,QAAQ,IAAI;AAC/C,kBAAA,eAAe,OAAO,GAAG;AAE/B,mBAAO,CAAC,UAA8B;AACpC,qBAAO,MAAM;AAAA,gBACX,CAAC,OAAO,MAAM,CAAC,GAAG,OAAO,MAAM,CAAC,CAAC;AAAA,gBACjC,IAAI,YAAY,4BAA4B,QAAQ;AAAA,cAAA;AAAA,YACtD;AAAA,UACF,GACC;AAAA,QAAA,CACJ;AAAA,MACH;AAAA,IAAA;AAAA,EAEJ;AACF,CAAC;"}
+{"version":3,"file":"stable-query-client.rule.js","sources":["../../../../src/rules/stable-query-client/stable-query-client.rule.ts"],"sourcesContent":["import { AST_NODE_TYPES, ESLintUtils } from '@typescript-eslint/utils'\nimport { ASTUtils } from '../../utils/ast-utils'\nimport { getDocsUrl } from '../../utils/get-docs-url'\nimport { detectTanstackQueryImports } from '../../utils/detect-react-query-imports'\nimport type { TSESLint } from '@typescript-eslint/utils'\n\nexport const name = 'stable-query-client'\n\nconst createRule = ESLintUtils.RuleCreator(getDocsUrl)\n\nexport const rule = createRule({\n  name,\n  meta: {\n    type: 'problem',\n    docs: {\n      description: 'Makes sure that QueryClient is stable',\n      recommended: 'error' as any,\n    },\n    messages: {\n      unstable: [\n        'QueryClient is not stable. It should be either extracted from the component or wrapped in React.useState.',\n        'See https://tkdodo.eu/blog/react-query-fa-qs#2-the-queryclient-is-not-stable',\n      ].join('\\n'),\n      fixTo: 'Fix to {{result}}',\n    },\n    hasSuggestions: true,\n    fixable: 'code',\n    schema: [],\n  },\n  defaultOptions: [],\n\n  create: detectTanstackQueryImports((context, _, helpers) => {\n    return {\n      NewExpression: (node) => {\n        if (\n          node.callee.type !== AST_NODE_TYPES.Identifier ||\n          node.callee.name !== 'QueryClient' ||\n          node.parent.type !== AST_NODE_TYPES.VariableDeclarator ||\n          !helpers.isSpecificTanstackQueryImport(\n            node.callee,\n            '@tanstack/react-query',\n          )\n        ) {\n          return\n        }\n\n        const fnAncestor = ASTUtils.getFunctionAncestor(context)\n        const isReactServerComponent = fnAncestor?.async === true\n\n        if (\n          !ASTUtils.isValidReactComponentOrHookName(fnAncestor?.id) ||\n          isReactServerComponent\n        ) {\n          return\n        }\n\n        context.report({\n          node: node.parent,\n          messageId: 'unstable',\n          fix: (() => {\n            const { parent } = node\n\n            if (parent.id.type !== AST_NODE_TYPES.Identifier) {\n              return\n            }\n\n            const nodeText = context.getSourceCode().getText(node)\n            const variableName = parent.id.name\n\n            return (fixer: TSESLint.RuleFixer) => {\n              return fixer.replaceTextRange(\n                [parent.range[0], parent.range[1]],\n                `[${variableName}] = React.useState(() => ${nodeText})`,\n              )\n            }\n          })(),\n        })\n      },\n    }\n  }),\n})\n"],"names":[],"mappings":";;;;AAMO,MAAM,OAAO;AAEpB,MAAM,aAAa,YAAY,YAAY,UAAU;AAE9C,MAAM,OAAO,WAAW;AAAA,EAC7B;AAAA,EACA,MAAM;AAAA,IACJ,MAAM;AAAA,IACN,MAAM;AAAA,MACJ,aAAa;AAAA,MACb,aAAa;AAAA,IACf;AAAA,IACA,UAAU;AAAA,MACR,UAAU;AAAA,QACR;AAAA,QACA;AAAA,MAAA,EACA,KAAK,IAAI;AAAA,MACX,OAAO;AAAA,IACT;AAAA,IACA,gBAAgB;AAAA,IAChB,SAAS;AAAA,IACT,QAAQ,CAAC;AAAA,EACX;AAAA,EACA,gBAAgB,CAAC;AAAA,EAEjB,QAAQ,2BAA2B,CAAC,SAAS,GAAG,YAAY;AACnD,WAAA;AAAA,MACL,eAAe,CAAC,SAAS;AACvB,YACE,KAAK,OAAO,SAAS,eAAe,cACpC,KAAK,OAAO,SAAS,iBACrB,KAAK,OAAO,SAAS,eAAe,sBACpC,CAAC,QAAQ;AAAA,UACP,KAAK;AAAA,UACL;AAAA,QAAA,GAEF;AACA;AAAA,QACF;AAEM,cAAA,aAAa,SAAS,oBAAoB,OAAO;AACjD,cAAA,0BAAyB,yCAAY,WAAU;AAErD,YACE,CAAC,SAAS,gCAAgC,yCAAY,EAAE,KACxD,wBACA;AACA;AAAA,QACF;AAEA,gBAAQ,OAAO;AAAA,UACb,MAAM,KAAK;AAAA,UACX,WAAW;AAAA,UACX,MAAM,MAAM;AACJ,kBAAA,EAAE,OAAW,IAAA;AAEnB,gBAAI,OAAO,GAAG,SAAS,eAAe,YAAY;AAChD;AAAA,YACF;AAEA,kBAAM,WAAW,QAAQ,cAAc,EAAE,QAAQ,IAAI;AAC/C,kBAAA,eAAe,OAAO,GAAG;AAE/B,mBAAO,CAAC,UAA8B;AACpC,qBAAO,MAAM;AAAA,gBACX,CAAC,OAAO,MAAM,CAAC,GAAG,OAAO,MAAM,CAAC,CAAC;AAAA,gBACjC,IAAI,YAAY,4BAA4B,QAAQ;AAAA,cAAA;AAAA,YACtD;AAAA,UACF,GACC;AAAA,QAAA,CACJ;AAAA,MACH;AAAA,IAAA;AAAA,EACF,CACD;AACH,CAAC;"}

package/dist/esm/rules.d.ts

@@ -1,5 +1,2 @@
-export declare const rules: {
-    "exhaustive-deps": import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<string, readonly unknown[], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
-    "stable-query-client": import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<string, readonly unknown[], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
-    "no-rest-destructuring": import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<string, readonly unknown[], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
-};
+import type { ESLintUtils } from '@typescript-eslint/utils';
+export declare const rules: Record<string, ESLintUtils.RuleModule<string, ReadonlyArray<unknown>, ESLintUtils.RuleListener>>;

package/dist/esm/rules.js

@@ -1,6 +1,6 @@
-import { name, rule } from "./rules/exhaustive-deps.rule.js";
+import { name, rule } from "./rules/exhaustive-deps/exhaustive-deps.rule.js";
 import { name as name$1, rule as rule$1 } from "./rules/stable-query-client/stable-query-client.rule.js";
-import { name as name$2, rule as rule$2 } from "./rules/no-rest-desctructuring/no-rest-destructuring.rule.js";
+import { name as name$2, rule as rule$2 } from "./rules/no-rest-destructuring/no-rest-destructuring.rule.js";
 const rules = {
   [name]: rule,
   [name$1]: rule$1,

package/dist/esm/rules.js.map

@@ -1 +1 @@
-{"version":3,"file":"rules.js","sources":["../../src/rules.ts"],"sourcesContent":["import * as exhaustiveDeps from './rules/exhaustive-deps.rule'\nimport * as stableQueryClient from './rules/stable-query-client/stable-query-client.rule'\nimport * as noRestDestructuring from './rules/no-rest-desctructuring/no-rest-destructuring.rule'\n\nexport const rules = {\n  [exhaustiveDeps.name]: exhaustiveDeps.rule,\n  [stableQueryClient.name]: stableQueryClient.rule,\n  [noRestDestructuring.name]: noRestDestructuring.rule,\n}\n"],"names":["exhaustiveDeps.name","exhaustiveDeps.rule","stableQueryClient.name","stableQueryClient.rule","noRestDestructuring.name","noRestDestructuring.rule"],"mappings":";;;AAIO,MAAM,QAAQ;AAAA,EACnB,CAACA,IAAmB,GAAGC;AAAAA,EACvB,CAACC,MAAsB,GAAGC;AAAAA,EAC1B,CAACC,MAAwB,GAAGC;AAC9B;"}
+{"version":3,"file":"rules.js","sources":["../../src/rules.ts"],"sourcesContent":["import * as exhaustiveDeps from './rules/exhaustive-deps/exhaustive-deps.rule'\nimport * as stableQueryClient from './rules/stable-query-client/stable-query-client.rule'\nimport * as noRestDestructuring from './rules/no-rest-destructuring/no-rest-destructuring.rule'\nimport type { ESLintUtils } from '@typescript-eslint/utils'\n\nexport const rules: Record<\n  string,\n  ESLintUtils.RuleModule<\n    string,\n    ReadonlyArray<unknown>,\n    ESLintUtils.RuleListener\n  >\n> = {\n  [exhaustiveDeps.name]: exhaustiveDeps.rule,\n  [stableQueryClient.name]: stableQueryClient.rule,\n  [noRestDestructuring.name]: noRestDestructuring.rule,\n}\n"],"names":["exhaustiveDeps.name","exhaustiveDeps.rule","stableQueryClient.name","stableQueryClient.rule","noRestDestructuring.name","noRestDestructuring.rule"],"mappings":";;;AAKO,MAAM,QAOT;AAAA,EACF,CAACA,IAAmB,GAAGC;AAAAA,EACvB,CAACC,MAAsB,GAAGC;AAAAA,EAC1B,CAACC,MAAwB,GAAGC;AAC9B;"}

package/dist/esm/utils/ast-utils.d.ts

@@ -1,6 +1,5 @@
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
-import type { RuleContext } from '@typescript-eslint/utils/dist/ts-eslint';
 export declare const ASTUtils: {
     isNodeOfOneOf<T extends AST_NODE_TYPES>(node: TSESTree.Node, types: readonly T[]): node is TSESTree.Node & {
         type: T;
@@ -29,11 +28,11 @@ export declare const ASTUtils: {
     }): Array<TSESLint.Scope.Reference>;
     mapKeyNodeToText(node: TSESTree.Node, sourceCode: Readonly<TSESLint.SourceCode>): string;
     isValidReactComponentOrHookName(identifier: TSESTree.Identifier | null | undefined): boolean;
-    getFunctionAncestor(context: Readonly<RuleContext<string, ReadonlyArray<unknown>>>): TSESTree.ArrowFunctionExpression | TSESTree.FunctionDeclarationWithOptionalName | TSESTree.FunctionExpression | undefined;
+    getFunctionAncestor(context: Readonly<TSESLint.RuleContext<string, ReadonlyArray<unknown>>>): TSESTree.ArrowFunctionExpression | TSESTree.FunctionDeclarationWithOptionalName | TSESTree.FunctionExpression | undefined;
     getReferencedExpressionByIdentifier(params: {
         node: TSESTree.Node;
-        context: Readonly<RuleContext<string, ReadonlyArray<unknown>>>;
+        context: Readonly<TSESLint.RuleContext<string, ReadonlyArray<unknown>>>;
     }): TSESTree.Expression | null;
-    getClosestVariableDeclarator(node: TSESTree.Node): TSESTree.VariableDeclarator | undefined;
+    getClosestVariableDeclarator(node: TSESTree.Node): TSESTree.LetOrConstOrVarDeclarator | undefined;
     getNestedReturnStatements(node: TSESTree.Node): Array<TSESTree.ReturnStatement>;
 };

package/dist/esm/utils/ast-utils.js

@@ -167,7 +167,7 @@ const ASTUtils = {
   },
   getClosestVariableDeclarator(node) {
     let currentNode = node;
-    while (currentNode !== void 0 && currentNode.type !== AST_NODE_TYPES.Program) {
+    while (currentNode.type !== AST_NODE_TYPES.Program) {
       if (currentNode.type === AST_NODE_TYPES.VariableDeclarator) {
         return currentNode;
       }

package/dist/esm/utils/ast-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"ast-utils.js","sources":["../../../src/utils/ast-utils.ts"],"sourcesContent":["import { AST_NODE_TYPES } from '@typescript-eslint/utils'\nimport { uniqueBy } from './unique-by'\nimport type { TSESLint, TSESTree } from '@typescript-eslint/utils'\nimport type { RuleContext } from '@typescript-eslint/utils/dist/ts-eslint'\n\nexport const ASTUtils = {\n  isNodeOfOneOf<T extends AST_NODE_TYPES>(\n    node: TSESTree.Node,\n    types: ReadonlyArray<T>,\n  ): node is TSESTree.Node & { type: T } {\n    return types.includes(node.type as T)\n  },\n  isIdentifier(node: TSESTree.Node): node is TSESTree.Identifier {\n    return node.type === AST_NODE_TYPES.Identifier\n  },\n  isIdentifierWithName(\n    node: TSESTree.Node,\n    name: string,\n  ): node is TSESTree.Identifier {\n    return ASTUtils.isIdentifier(node) && node.name === name\n  },\n  isIdentifierWithOneOfNames<T extends Array<string>>(\n    node: TSESTree.Node,\n    name: T,\n  ): node is TSESTree.Identifier & { name: T[number] } {\n    return ASTUtils.isIdentifier(node) && name.includes(node.name)\n  },\n  isProperty(node: TSESTree.Node): node is TSESTree.Property {\n    return node.type === AST_NODE_TYPES.Property\n  },\n  isObjectExpression(node: TSESTree.Node): node is TSESTree.ObjectExpression {\n    return node.type === AST_NODE_TYPES.ObjectExpression\n  },\n  isPropertyWithIdentifierKey(\n    node: TSESTree.Node,\n    key: string,\n  ): node is TSESTree.Property {\n    return (\n      ASTUtils.isProperty(node) && ASTUtils.isIdentifierWithName(node.key, key)\n    )\n  },\n  findPropertyWithIdentifierKey(\n    properties: Array<TSESTree.ObjectLiteralElement>,\n    key: string,\n  ): TSESTree.Property | undefined {\n    return properties.find((x) =>\n      ASTUtils.isPropertyWithIdentifierKey(x, key),\n    ) as TSESTree.Property | undefined\n  },\n  getNestedIdentifiers(node: TSESTree.Node): Array<TSESTree.Identifier> {\n    const identifiers: Array<TSESTree.Identifier> = []\n\n    if (ASTUtils.isIdentifier(node)) {\n      identifiers.push(node)\n    }\n\n    if ('arguments' in node) {\n      node.arguments.forEach((x) => {\n        identifiers.push(...ASTUtils.getNestedIdentifiers(x))\n      })\n    }\n\n    if ('elements' in node) {\n      node.elements.forEach((x) => {\n        if (x !== null) {\n          identifiers.push(...ASTUtils.getNestedIdentifiers(x))\n        }\n      })\n    }\n\n    if ('properties' in node) {\n      node.properties.forEach((x) => {\n        identifiers.push(...ASTUtils.getNestedIdentifiers(x))\n      })\n    }\n\n    if ('expressions' in node) {\n      node.expressions.forEach((x) => {\n        identifiers.push(...ASTUtils.getNestedIdentifiers(x))\n      })\n    }\n\n    if (node.type === AST_NODE_TYPES.Property) {\n      identifiers.push(...ASTUtils.getNestedIdentifiers(node.value))\n    }\n\n    if (node.type === AST_NODE_TYPES.SpreadElement) {\n      identifiers.push(...ASTUtils.getNestedIdentifiers(node.argument))\n    }\n\n    if (node.type === AST_NODE_TYPES.MemberExpression) {\n      identifiers.push(...ASTUtils.getNestedIdentifiers(node.object))\n    }\n\n    if (node.type === AST_NODE_TYPES.UnaryExpression) {\n      identifiers.push(...ASTUtils.getNestedIdentifiers(node.argument))\n    }\n\n    if (node.type === AST_NODE_TYPES.ChainExpression) {\n      identifiers.push(...ASTUtils.getNestedIdentifiers(node.expression))\n    }\n\n    if (node.type === AST_NODE_TYPES.TSNonNullExpression) {\n      identifiers.push(...ASTUtils.getNestedIdentifiers(node.expression))\n    }\n\n    return identifiers\n  },\n  isAncestorIsCallee(identifier: TSESTree.Node) {\n    let previousNode = identifier\n    let currentNode = identifier.parent\n\n    while (currentNode !== undefined) {\n      if (\n        currentNode.type === AST_NODE_TYPES.CallExpression &&\n        currentNode.callee === previousNode\n      ) {\n        return true\n      }\n\n      if (currentNode.type !== AST_NODE_TYPES.MemberExpression) {\n        return false\n      }\n\n      previousNode = currentNode\n      currentNode = currentNode.parent\n    }\n\n    return false\n  },\n  traverseUpOnly(\n    identifier: TSESTree.Node,\n    allowedNodeTypes: Array<AST_NODE_TYPES>,\n  ): TSESTree.Node {\n    const parent = identifier.parent\n\n    if (parent !== undefined && allowedNodeTypes.includes(parent.type)) {\n      return ASTUtils.traverseUpOnly(parent, allowedNodeTypes)\n    }\n\n    return identifier\n  },\n  isDeclaredInNode(params: {\n    functionNode: TSESTree.Node\n    reference: TSESLint.Scope.Reference\n    scopeManager: TSESLint.Scope.ScopeManager\n  }) {\n    const { functionNode, reference, scopeManager } = params\n    const scope = scopeManager.acquire(functionNode)\n\n    if (scope === null) {\n      return false\n    }\n\n    return scope.set.has(reference.identifier.name)\n  },\n  getExternalRefs(params: {\n    scopeManager: TSESLint.Scope.ScopeManager\n    sourceCode: Readonly<TSESLint.SourceCode>\n    node: TSESTree.Node\n  }): Array<TSESLint.Scope.Reference> {\n    const { scopeManager, sourceCode, node } = params\n    const scope = scopeManager.acquire(node)\n\n    if (scope === null) {\n      return []\n    }\n\n    const references = scope.references\n      .filter((x) => x.isRead() && !scope.set.has(x.identifier.name))\n      .map((x) => {\n        const referenceNode = ASTUtils.traverseUpOnly(x.identifier, [\n          AST_NODE_TYPES.MemberExpression,\n          AST_NODE_TYPES.Identifier,\n        ])\n\n        return {\n          variable: x,\n          node: referenceNode,\n          text: sourceCode.getText(referenceNode),\n        }\n      })\n\n    const localRefIds = new Set(\n      [...scope.set.values()].map((x) => sourceCode.getText(x.identifiers[0])),\n    )\n\n    const externalRefs = references.filter(\n      (x) => x.variable.resolved === null || !localRefIds.has(x.text),\n    )\n\n    return uniqueBy(externalRefs, (x) => x.text).map((x) => x.variable)\n  },\n  mapKeyNodeToText(\n    node: TSESTree.Node,\n    sourceCode: Readonly<TSESLint.SourceCode>,\n  ) {\n    return sourceCode.getText(\n      ASTUtils.traverseUpOnly(node, [\n        AST_NODE_TYPES.MemberExpression,\n        AST_NODE_TYPES.Identifier,\n      ]),\n    )\n  },\n  isValidReactComponentOrHookName(\n    identifier: TSESTree.Identifier | null | undefined,\n  ) {\n    return (\n      identifier !== null &&\n      identifier !== undefined &&\n      /^(use|[A-Z])/.test(identifier.name)\n    )\n  },\n  getFunctionAncestor(\n    context: Readonly<RuleContext<string, ReadonlyArray<unknown>>>,\n  ) {\n    for (const ancestor of context.getAncestors()) {\n      if (ancestor.type === AST_NODE_TYPES.FunctionDeclaration) {\n        return ancestor\n      }\n\n      if (\n        ancestor.parent?.type === AST_NODE_TYPES.VariableDeclarator &&\n        ancestor.parent.id.type === AST_NODE_TYPES.Identifier &&\n        ASTUtils.isNodeOfOneOf(ancestor, [\n          AST_NODE_TYPES.FunctionDeclaration,\n          AST_NODE_TYPES.FunctionExpression,\n          AST_NODE_TYPES.ArrowFunctionExpression,\n        ])\n      ) {\n        return ancestor\n      }\n    }\n\n    return undefined\n  },\n  getReferencedExpressionByIdentifier(params: {\n    node: TSESTree.Node\n    context: Readonly<RuleContext<string, ReadonlyArray<unknown>>>\n  }) {\n    const { node, context } = params\n\n    const resolvedNode = context\n      .getScope()\n      .references.find((ref) => ref.identifier === node)?.resolved?.defs[0]\n      ?.node\n\n    if (resolvedNode?.type !== AST_NODE_TYPES.VariableDeclarator) {\n      return null\n    }\n\n    return resolvedNode.init\n  },\n  getClosestVariableDeclarator(node: TSESTree.Node) {\n    let currentNode: TSESTree.Node | undefined = node\n\n    while (\n      currentNode !== undefined &&\n      currentNode.type !== AST_NODE_TYPES.Program\n    ) {\n      if (currentNode.type === AST_NODE_TYPES.VariableDeclarator) {\n        return currentNode\n      }\n\n      currentNode = currentNode.parent\n    }\n\n    return undefined\n  },\n  getNestedReturnStatements(\n    node: TSESTree.Node,\n  ): Array<TSESTree.ReturnStatement> {\n    const returnStatements: Array<TSESTree.ReturnStatement> = []\n\n    if (node.type === AST_NODE_TYPES.ReturnStatement) {\n      returnStatements.push(node)\n    }\n\n    if ('body' in node && node.body !== undefined && node.body !== null) {\n      Array.isArray(node.body)\n        ? node.body.forEach((x) => {\n            returnStatements.push(...ASTUtils.getNestedReturnStatements(x))\n          })\n        : returnStatements.push(\n            ...ASTUtils.getNestedReturnStatements(node.body),\n          )\n    }\n\n    if ('consequent' in node) {\n      Array.isArray(node.consequent)\n        ? node.consequent.forEach((x) => {\n            returnStatements.push(...ASTUtils.getNestedReturnStatements(x))\n          })\n        : returnStatements.push(\n            ...ASTUtils.getNestedReturnStatements(node.consequent),\n          )\n    }\n\n    if ('alternate' in node && node.alternate !== null) {\n      Array.isArray(node.alternate)\n        ? node.alternate.forEach((x) => {\n            returnStatements.push(...ASTUtils.getNestedReturnStatements(x))\n          })\n        : returnStatements.push(\n            ...ASTUtils.getNestedReturnStatements(node.alternate),\n          )\n    }\n\n    if ('cases' in node) {\n      node.cases.forEach((x) => {\n        returnStatements.push(...ASTUtils.getNestedReturnStatements(x))\n      })\n    }\n\n    if ('block' in node) {\n      returnStatements.push(...ASTUtils.getNestedReturnStatements(node.block))\n    }\n\n    if ('handler' in node && node.handler !== null) {\n      returnStatements.push(...ASTUtils.getNestedReturnStatements(node.handler))\n    }\n\n    if ('finalizer' in node && node.finalizer !== null) {\n      returnStatements.push(\n        ...ASTUtils.getNestedReturnStatements(node.finalizer),\n      )\n    }\n\n    if (\n      'expression' in node &&\n      node.expression !== true &&\n      node.expression !== false\n    ) {\n      returnStatements.push(\n        ...ASTUtils.getNestedReturnStatements(node.expression),\n      )\n    }\n\n    if ('test' in node && node.test !== null) {\n      returnStatements.push(...ASTUtils.getNestedReturnStatements(node.test))\n    }\n\n    return returnStatements\n  },\n}\n"],"names":[],"mappings":";;AAKO,MAAM,WAAW;AAAA,EACtB,cACE,MACA,OACqC;AAC9B,WAAA,MAAM,SAAS,KAAK,IAAS;AAAA,EACtC;AAAA,EACA,aAAa,MAAkD;AACtD,WAAA,KAAK,SAAS,eAAe;AAAA,EACtC;AAAA,EACA,qBACE,MACA,MAC6B;AAC7B,WAAO,SAAS,aAAa,IAAI,KAAK,KAAK,SAAS;AAAA,EACtD;AAAA,EACA,2BACE,MACA,MACmD;AACnD,WAAO,SAAS,aAAa,IAAI,KAAK,KAAK,SAAS,KAAK,IAAI;AAAA,EAC/D;AAAA,EACA,WAAW,MAAgD;AAClD,WAAA,KAAK,SAAS,eAAe;AAAA,EACtC;AAAA,EACA,mBAAmB,MAAwD;AAClE,WAAA,KAAK,SAAS,eAAe;AAAA,EACtC;AAAA,EACA,4BACE,MACA,KAC2B;AAEzB,WAAA,SAAS,WAAW,IAAI,KAAK,SAAS,qBAAqB,KAAK,KAAK,GAAG;AAAA,EAE5E;AAAA,EACA,8BACE,YACA,KAC+B;AAC/B,WAAO,WAAW;AAAA,MAAK,CAAC,MACtB,SAAS,4BAA4B,GAAG,GAAG;AAAA,IAAA;AAAA,EAE/C;AAAA,EACA,qBAAqB,MAAiD;AACpE,UAAM,cAA0C,CAAA;AAE5C,QAAA,SAAS,aAAa,IAAI,GAAG;AAC/B,kBAAY,KAAK,IAAI;AAAA,IACvB;AAEA,QAAI,eAAe,MAAM;AAClB,WAAA,UAAU,QAAQ,CAAC,MAAM;AAC5B,oBAAY,KAAK,GAAG,SAAS,qBAAqB,CAAC,CAAC;AAAA,MAAA,CACrD;AAAA,IACH;AAEA,QAAI,cAAc,MAAM;AACjB,WAAA,SAAS,QAAQ,CAAC,MAAM;AAC3B,YAAI,MAAM,MAAM;AACd,sBAAY,KAAK,GAAG,SAAS,qBAAqB,CAAC,CAAC;AAAA,QACtD;AAAA,MAAA,CACD;AAAA,IACH;AAEA,QAAI,gBAAgB,MAAM;AACnB,WAAA,WAAW,QAAQ,CAAC,MAAM;AAC7B,oBAAY,KAAK,GAAG,SAAS,qBAAqB,CAAC,CAAC;AAAA,MAAA,CACrD;AAAA,IACH;AAEA,QAAI,iBAAiB,MAAM;AACpB,WAAA,YAAY,QAAQ,CAAC,MAAM;AAC9B,oBAAY,KAAK,GAAG,SAAS,qBAAqB,CAAC,CAAC;AAAA,MAAA,CACrD;AAAA,IACH;AAEI,QAAA,KAAK,SAAS,eAAe,UAAU;AACzC,kBAAY,KAAK,GAAG,SAAS,qBAAqB,KAAK,KAAK,CAAC;AAAA,IAC/D;AAEI,QAAA,KAAK,SAAS,eAAe,eAAe;AAC9C,kBAAY,KAAK,GAAG,SAAS,qBAAqB,KAAK,QAAQ,CAAC;AAAA,IAClE;AAEI,QAAA,KAAK,SAAS,eAAe,kBAAkB;AACjD,kBAAY,KAAK,GAAG,SAAS,qBAAqB,KAAK,MAAM,CAAC;AAAA,IAChE;AAEI,QAAA,KAAK,SAAS,eAAe,iBAAiB;AAChD,kBAAY,KAAK,GAAG,SAAS,qBAAqB,KAAK,QAAQ,CAAC;AAAA,IAClE;AAEI,QAAA,KAAK,SAAS,eAAe,iBAAiB;AAChD,kBAAY,KAAK,GAAG,SAAS,qBAAqB,KAAK,UAAU,CAAC;AAAA,IACpE;AAEI,QAAA,KAAK,SAAS,eAAe,qBAAqB;AACpD,kBAAY,KAAK,GAAG,SAAS,qBAAqB,KAAK,UAAU,CAAC;AAAA,IACpE;AAEO,WAAA;AAAA,EACT;AAAA,EACA,mBAAmB,YAA2B;AAC5C,QAAI,eAAe;AACnB,QAAI,cAAc,WAAW;AAE7B,WAAO,gBAAgB,QAAW;AAChC,UACE,YAAY,SAAS,eAAe,kBACpC,YAAY,WAAW,cACvB;AACO,eAAA;AAAA,MACT;AAEI,UAAA,YAAY,SAAS,eAAe,kBAAkB;AACjD,eAAA;AAAA,MACT;AAEe,qBAAA;AACf,oBAAc,YAAY;AAAA,IAC5B;AAEO,WAAA;AAAA,EACT;AAAA,EACA,eACE,YACA,kBACe;AACf,UAAM,SAAS,WAAW;AAE1B,QAAI,WAAW,UAAa,iBAAiB,SAAS,OAAO,IAAI,GAAG;AAC3D,aAAA,SAAS,eAAe,QAAQ,gBAAgB;AAAA,IACzD;AAEO,WAAA;AAAA,EACT;AAAA,EACA,iBAAiB,QAId;AACD,UAAM,EAAE,cAAc,WAAW,aAAA,IAAiB;AAC5C,UAAA,QAAQ,aAAa,QAAQ,YAAY;AAE/C,QAAI,UAAU,MAAM;AACX,aAAA;AAAA,IACT;AAEA,WAAO,MAAM,IAAI,IAAI,UAAU,WAAW,IAAI;AAAA,EAChD;AAAA,EACA,gBAAgB,QAIoB;AAClC,UAAM,EAAE,cAAc,YAAY,KAAA,IAAS;AACrC,UAAA,QAAQ,aAAa,QAAQ,IAAI;AAEvC,QAAI,UAAU,MAAM;AAClB,aAAO;IACT;AAEM,UAAA,aAAa,MAAM,WACtB,OAAO,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,IAAI,IAAI,EAAE,WAAW,IAAI,CAAC,EAC7D,IAAI,CAAC,MAAM;AACV,YAAM,gBAAgB,SAAS,eAAe,EAAE,YAAY;AAAA,QAC1D,eAAe;AAAA,QACf,eAAe;AAAA,MAAA,CAChB;AAEM,aAAA;AAAA,QACL,UAAU;AAAA,QACV,MAAM;AAAA,QACN,MAAM,WAAW,QAAQ,aAAa;AAAA,MAAA;AAAA,IACxC,CACD;AAEH,UAAM,cAAc,IAAI;AAAA,MACtB,CAAC,GAAG,MAAM,IAAI,OAAQ,CAAA,EAAE,IAAI,CAAC,MAAM,WAAW,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC;AAAA,IAAA;AAGzE,UAAM,eAAe,WAAW;AAAA,MAC9B,CAAC,MAAM,EAAE,SAAS,aAAa,QAAQ,CAAC,YAAY,IAAI,EAAE,IAAI;AAAA,IAAA;AAGzD,WAAA,SAAS,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ;AAAA,EACpE;AAAA,EACA,iBACE,MACA,YACA;AACA,WAAO,WAAW;AAAA,MAChB,SAAS,eAAe,MAAM;AAAA,QAC5B,eAAe;AAAA,QACf,eAAe;AAAA,MAAA,CAChB;AAAA,IAAA;AAAA,EAEL;AAAA,EACA,gCACE,YACA;AACA,WACE,eAAe,QACf,eAAe,UACf,eAAe,KAAK,WAAW,IAAI;AAAA,EAEvC;AAAA,EACA,oBACE,SACA;;AACW,eAAA,YAAY,QAAQ,gBAAgB;AACzC,UAAA,SAAS,SAAS,eAAe,qBAAqB;AACjD,eAAA;AAAA,MACT;AAEA,YACE,cAAS,WAAT,mBAAiB,UAAS,eAAe,sBACzC,SAAS,OAAO,GAAG,SAAS,eAAe,cAC3C,SAAS,cAAc,UAAU;AAAA,QAC/B,eAAe;AAAA,QACf,eAAe;AAAA,QACf,eAAe;AAAA,MAAA,CAChB,GACD;AACO,eAAA;AAAA,MACT;AAAA,IACF;AAEO,WAAA;AAAA,EACT;AAAA,EACA,oCAAoC,QAGjC;;AACK,UAAA,EAAE,MAAM,QAAY,IAAA;AAE1B,UAAM,gBAAe,yBAClB,SAAS,EACT,WAAW,KAAK,CAAC,QAAQ,IAAI,eAAe,IAAI,MAF9B,mBAEiC,aAFjC,mBAE2C,KAAK,OAFhD,mBAGjB;AAEA,SAAA,6CAAc,UAAS,eAAe,oBAAoB;AACrD,aAAA;AAAA,IACT;AAEA,WAAO,aAAa;AAAA,EACtB;AAAA,EACA,6BAA6B,MAAqB;AAChD,QAAI,cAAyC;AAE7C,WACE,gBAAgB,UAChB,YAAY,SAAS,eAAe,SACpC;AACI,UAAA,YAAY,SAAS,eAAe,oBAAoB;AACnD,eAAA;AAAA,MACT;AAEA,oBAAc,YAAY;AAAA,IAC5B;AAEO,WAAA;AAAA,EACT;AAAA,EACA,0BACE,MACiC;AACjC,UAAM,mBAAoD,CAAA;AAEtD,QAAA,KAAK,SAAS,eAAe,iBAAiB;AAChD,uBAAiB,KAAK,IAAI;AAAA,IAC5B;AAEA,QAAI,UAAU,QAAQ,KAAK,SAAS,UAAa,KAAK,SAAS,MAAM;AAC7D,YAAA,QAAQ,KAAK,IAAI,IACnB,KAAK,KAAK,QAAQ,CAAC,MAAM;AACvB,yBAAiB,KAAK,GAAG,SAAS,0BAA0B,CAAC,CAAC;AAAA,MAAA,CAC/D,IACD,iBAAiB;AAAA,QACf,GAAG,SAAS,0BAA0B,KAAK,IAAI;AAAA,MAAA;AAAA,IAEvD;AAEA,QAAI,gBAAgB,MAAM;AAClB,YAAA,QAAQ,KAAK,UAAU,IACzB,KAAK,WAAW,QAAQ,CAAC,MAAM;AAC7B,yBAAiB,KAAK,GAAG,SAAS,0BAA0B,CAAC,CAAC;AAAA,MAAA,CAC/D,IACD,iBAAiB;AAAA,QACf,GAAG,SAAS,0BAA0B,KAAK,UAAU;AAAA,MAAA;AAAA,IAE7D;AAEA,QAAI,eAAe,QAAQ,KAAK,cAAc,MAAM;AAC5C,YAAA,QAAQ,KAAK,SAAS,IACxB,KAAK,UAAU,QAAQ,CAAC,MAAM;AAC5B,yBAAiB,KAAK,GAAG,SAAS,0BAA0B,CAAC,CAAC;AAAA,MAAA,CAC/D,IACD,iBAAiB;AAAA,QACf,GAAG,SAAS,0BAA0B,KAAK,SAAS;AAAA,MAAA;AAAA,IAE5D;AAEA,QAAI,WAAW,MAAM;AACd,WAAA,MAAM,QAAQ,CAAC,MAAM;AACxB,yBAAiB,KAAK,GAAG,SAAS,0BAA0B,CAAC,CAAC;AAAA,MAAA,CAC/D;AAAA,IACH;AAEA,QAAI,WAAW,MAAM;AACnB,uBAAiB,KAAK,GAAG,SAAS,0BAA0B,KAAK,KAAK,CAAC;AAAA,IACzE;AAEA,QAAI,aAAa,QAAQ,KAAK,YAAY,MAAM;AAC9C,uBAAiB,KAAK,GAAG,SAAS,0BAA0B,KAAK,OAAO,CAAC;AAAA,IAC3E;AAEA,QAAI,eAAe,QAAQ,KAAK,cAAc,MAAM;AACjC,uBAAA;AAAA,QACf,GAAG,SAAS,0BAA0B,KAAK,SAAS;AAAA,MAAA;AAAA,IAExD;AAEA,QACE,gBAAgB,QAChB,KAAK,eAAe,QACpB,KAAK,eAAe,OACpB;AACiB,uBAAA;AAAA,QACf,GAAG,SAAS,0BAA0B,KAAK,UAAU;AAAA,MAAA;AAAA,IAEzD;AAEA,QAAI,UAAU,QAAQ,KAAK,SAAS,MAAM;AACxC,uBAAiB,KAAK,GAAG,SAAS,0BAA0B,KAAK,IAAI,CAAC;AAAA,IACxE;AAEO,WAAA;AAAA,EACT;AACF;"}
+{"version":3,"file":"ast-utils.js","sources":["../../../src/utils/ast-utils.ts"],"sourcesContent":["import { AST_NODE_TYPES } from '@typescript-eslint/utils'\nimport { uniqueBy } from './unique-by'\nimport type { TSESLint, TSESTree } from '@typescript-eslint/utils'\n\nexport const ASTUtils = {\n  isNodeOfOneOf<T extends AST_NODE_TYPES>(\n    node: TSESTree.Node,\n    types: ReadonlyArray<T>,\n  ): node is TSESTree.Node & { type: T } {\n    return types.includes(node.type as T)\n  },\n  isIdentifier(node: TSESTree.Node): node is TSESTree.Identifier {\n    return node.type === AST_NODE_TYPES.Identifier\n  },\n  isIdentifierWithName(\n    node: TSESTree.Node,\n    name: string,\n  ): node is TSESTree.Identifier {\n    return ASTUtils.isIdentifier(node) && node.name === name\n  },\n  isIdentifierWithOneOfNames<T extends Array<string>>(\n    node: TSESTree.Node,\n    name: T,\n  ): node is TSESTree.Identifier & { name: T[number] } {\n    return ASTUtils.isIdentifier(node) && name.includes(node.name)\n  },\n  isProperty(node: TSESTree.Node): node is TSESTree.Property {\n    return node.type === AST_NODE_TYPES.Property\n  },\n  isObjectExpression(node: TSESTree.Node): node is TSESTree.ObjectExpression {\n    return node.type === AST_NODE_TYPES.ObjectExpression\n  },\n  isPropertyWithIdentifierKey(\n    node: TSESTree.Node,\n    key: string,\n  ): node is TSESTree.Property {\n    return (\n      ASTUtils.isProperty(node) && ASTUtils.isIdentifierWithName(node.key, key)\n    )\n  },\n  findPropertyWithIdentifierKey(\n    properties: Array<TSESTree.ObjectLiteralElement>,\n    key: string,\n  ): TSESTree.Property | undefined {\n    return properties.find((x) =>\n      ASTUtils.isPropertyWithIdentifierKey(x, key),\n    ) as TSESTree.Property | undefined\n  },\n  getNestedIdentifiers(node: TSESTree.Node): Array<TSESTree.Identifier> {\n    const identifiers: Array<TSESTree.Identifier> = []\n\n    if (ASTUtils.isIdentifier(node)) {\n      identifiers.push(node)\n    }\n\n    if ('arguments' in node) {\n      node.arguments.forEach((x) => {\n        identifiers.push(...ASTUtils.getNestedIdentifiers(x))\n      })\n    }\n\n    if ('elements' in node) {\n      node.elements.forEach((x) => {\n        if (x !== null) {\n          identifiers.push(...ASTUtils.getNestedIdentifiers(x))\n        }\n      })\n    }\n\n    if ('properties' in node) {\n      node.properties.forEach((x) => {\n        identifiers.push(...ASTUtils.getNestedIdentifiers(x))\n      })\n    }\n\n    if ('expressions' in node) {\n      node.expressions.forEach((x) => {\n        identifiers.push(...ASTUtils.getNestedIdentifiers(x))\n      })\n    }\n\n    if (node.type === AST_NODE_TYPES.Property) {\n      identifiers.push(...ASTUtils.getNestedIdentifiers(node.value))\n    }\n\n    if (node.type === AST_NODE_TYPES.SpreadElement) {\n      identifiers.push(...ASTUtils.getNestedIdentifiers(node.argument))\n    }\n\n    if (node.type === AST_NODE_TYPES.MemberExpression) {\n      identifiers.push(...ASTUtils.getNestedIdentifiers(node.object))\n    }\n\n    if (node.type === AST_NODE_TYPES.UnaryExpression) {\n      identifiers.push(...ASTUtils.getNestedIdentifiers(node.argument))\n    }\n\n    if (node.type === AST_NODE_TYPES.ChainExpression) {\n      identifiers.push(...ASTUtils.getNestedIdentifiers(node.expression))\n    }\n\n    if (node.type === AST_NODE_TYPES.TSNonNullExpression) {\n      identifiers.push(...ASTUtils.getNestedIdentifiers(node.expression))\n    }\n\n    return identifiers\n  },\n  isAncestorIsCallee(identifier: TSESTree.Node) {\n    let previousNode = identifier\n    let currentNode = identifier.parent\n\n    while (currentNode !== undefined) {\n      if (\n        currentNode.type === AST_NODE_TYPES.CallExpression &&\n        currentNode.callee === previousNode\n      ) {\n        return true\n      }\n\n      if (currentNode.type !== AST_NODE_TYPES.MemberExpression) {\n        return false\n      }\n\n      previousNode = currentNode\n      currentNode = currentNode.parent\n    }\n\n    return false\n  },\n  traverseUpOnly(\n    identifier: TSESTree.Node,\n    allowedNodeTypes: Array<AST_NODE_TYPES>,\n  ): TSESTree.Node {\n    const parent = identifier.parent\n\n    if (parent !== undefined && allowedNodeTypes.includes(parent.type)) {\n      return ASTUtils.traverseUpOnly(parent, allowedNodeTypes)\n    }\n\n    return identifier\n  },\n  isDeclaredInNode(params: {\n    functionNode: TSESTree.Node\n    reference: TSESLint.Scope.Reference\n    scopeManager: TSESLint.Scope.ScopeManager\n  }) {\n    const { functionNode, reference, scopeManager } = params\n    const scope = scopeManager.acquire(functionNode)\n\n    if (scope === null) {\n      return false\n    }\n\n    return scope.set.has(reference.identifier.name)\n  },\n  getExternalRefs(params: {\n    scopeManager: TSESLint.Scope.ScopeManager\n    sourceCode: Readonly<TSESLint.SourceCode>\n    node: TSESTree.Node\n  }): Array<TSESLint.Scope.Reference> {\n    const { scopeManager, sourceCode, node } = params\n    const scope = scopeManager.acquire(node)\n\n    if (scope === null) {\n      return []\n    }\n\n    const references = scope.references\n      .filter((x) => x.isRead() && !scope.set.has(x.identifier.name))\n      .map((x) => {\n        const referenceNode = ASTUtils.traverseUpOnly(x.identifier, [\n          AST_NODE_TYPES.MemberExpression,\n          AST_NODE_TYPES.Identifier,\n        ])\n\n        return {\n          variable: x,\n          node: referenceNode,\n          text: sourceCode.getText(referenceNode),\n        }\n      })\n\n    const localRefIds = new Set(\n      [...scope.set.values()].map((x) => sourceCode.getText(x.identifiers[0])),\n    )\n\n    const externalRefs = references.filter(\n      (x) => x.variable.resolved === null || !localRefIds.has(x.text),\n    )\n\n    return uniqueBy(externalRefs, (x) => x.text).map((x) => x.variable)\n  },\n  mapKeyNodeToText(\n    node: TSESTree.Node,\n    sourceCode: Readonly<TSESLint.SourceCode>,\n  ) {\n    return sourceCode.getText(\n      ASTUtils.traverseUpOnly(node, [\n        AST_NODE_TYPES.MemberExpression,\n        AST_NODE_TYPES.Identifier,\n      ]),\n    )\n  },\n  isValidReactComponentOrHookName(\n    identifier: TSESTree.Identifier | null | undefined,\n  ) {\n    return (\n      identifier !== null &&\n      identifier !== undefined &&\n      /^(use|[A-Z])/.test(identifier.name)\n    )\n  },\n  getFunctionAncestor(\n    context: Readonly<TSESLint.RuleContext<string, ReadonlyArray<unknown>>>,\n  ) {\n    for (const ancestor of context.getAncestors()) {\n      if (ancestor.type === AST_NODE_TYPES.FunctionDeclaration) {\n        return ancestor\n      }\n\n      if (\n        ancestor.parent?.type === AST_NODE_TYPES.VariableDeclarator &&\n        ancestor.parent.id.type === AST_NODE_TYPES.Identifier &&\n        ASTUtils.isNodeOfOneOf(ancestor, [\n          AST_NODE_TYPES.FunctionDeclaration,\n          AST_NODE_TYPES.FunctionExpression,\n          AST_NODE_TYPES.ArrowFunctionExpression,\n        ])\n      ) {\n        return ancestor\n      }\n    }\n\n    return undefined\n  },\n  getReferencedExpressionByIdentifier(params: {\n    node: TSESTree.Node\n    context: Readonly<TSESLint.RuleContext<string, ReadonlyArray<unknown>>>\n  }) {\n    const { node, context } = params\n\n    const resolvedNode = context\n      .getScope()\n      .references.find((ref) => ref.identifier === node)?.resolved?.defs[0]\n      ?.node\n\n    if (resolvedNode?.type !== AST_NODE_TYPES.VariableDeclarator) {\n      return null\n    }\n\n    return resolvedNode.init\n  },\n  getClosestVariableDeclarator(node: TSESTree.Node) {\n    let currentNode: TSESTree.Node | undefined = node\n\n    while (currentNode.type !== AST_NODE_TYPES.Program) {\n      if (currentNode.type === AST_NODE_TYPES.VariableDeclarator) {\n        return currentNode\n      }\n\n      currentNode = currentNode.parent\n    }\n\n    return undefined\n  },\n  getNestedReturnStatements(\n    node: TSESTree.Node,\n  ): Array<TSESTree.ReturnStatement> {\n    const returnStatements: Array<TSESTree.ReturnStatement> = []\n\n    if (node.type === AST_NODE_TYPES.ReturnStatement) {\n      returnStatements.push(node)\n    }\n\n    if ('body' in node && node.body !== undefined && node.body !== null) {\n      Array.isArray(node.body)\n        ? node.body.forEach((x) => {\n            returnStatements.push(...ASTUtils.getNestedReturnStatements(x))\n          })\n        : returnStatements.push(\n            ...ASTUtils.getNestedReturnStatements(node.body),\n          )\n    }\n\n    if ('consequent' in node) {\n      Array.isArray(node.consequent)\n        ? node.consequent.forEach((x) => {\n            returnStatements.push(...ASTUtils.getNestedReturnStatements(x))\n          })\n        : returnStatements.push(\n            ...ASTUtils.getNestedReturnStatements(node.consequent),\n          )\n    }\n\n    if ('alternate' in node && node.alternate !== null) {\n      Array.isArray(node.alternate)\n        ? node.alternate.forEach((x) => {\n            returnStatements.push(...ASTUtils.getNestedReturnStatements(x))\n          })\n        : returnStatements.push(\n            ...ASTUtils.getNestedReturnStatements(node.alternate),\n          )\n    }\n\n    if ('cases' in node) {\n      node.cases.forEach((x) => {\n        returnStatements.push(...ASTUtils.getNestedReturnStatements(x))\n      })\n    }\n\n    if ('block' in node) {\n      returnStatements.push(...ASTUtils.getNestedReturnStatements(node.block))\n    }\n\n    if ('handler' in node && node.handler !== null) {\n      returnStatements.push(...ASTUtils.getNestedReturnStatements(node.handler))\n    }\n\n    if ('finalizer' in node && node.finalizer !== null) {\n      returnStatements.push(\n        ...ASTUtils.getNestedReturnStatements(node.finalizer),\n      )\n    }\n\n    if (\n      'expression' in node &&\n      node.expression !== true &&\n      node.expression !== false\n    ) {\n      returnStatements.push(\n        ...ASTUtils.getNestedReturnStatements(node.expression),\n      )\n    }\n\n    if ('test' in node && node.test !== null) {\n      returnStatements.push(...ASTUtils.getNestedReturnStatements(node.test))\n    }\n\n    return returnStatements\n  },\n}\n"],"names":[],"mappings":";;AAIO,MAAM,WAAW;AAAA,EACtB,cACE,MACA,OACqC;AAC9B,WAAA,MAAM,SAAS,KAAK,IAAS;AAAA,EACtC;AAAA,EACA,aAAa,MAAkD;AACtD,WAAA,KAAK,SAAS,eAAe;AAAA,EACtC;AAAA,EACA,qBACE,MACA,MAC6B;AAC7B,WAAO,SAAS,aAAa,IAAI,KAAK,KAAK,SAAS;AAAA,EACtD;AAAA,EACA,2BACE,MACA,MACmD;AACnD,WAAO,SAAS,aAAa,IAAI,KAAK,KAAK,SAAS,KAAK,IAAI;AAAA,EAC/D;AAAA,EACA,WAAW,MAAgD;AAClD,WAAA,KAAK,SAAS,eAAe;AAAA,EACtC;AAAA,EACA,mBAAmB,MAAwD;AAClE,WAAA,KAAK,SAAS,eAAe;AAAA,EACtC;AAAA,EACA,4BACE,MACA,KAC2B;AAEzB,WAAA,SAAS,WAAW,IAAI,KAAK,SAAS,qBAAqB,KAAK,KAAK,GAAG;AAAA,EAE5E;AAAA,EACA,8BACE,YACA,KAC+B;AAC/B,WAAO,WAAW;AAAA,MAAK,CAAC,MACtB,SAAS,4BAA4B,GAAG,GAAG;AAAA,IAAA;AAAA,EAE/C;AAAA,EACA,qBAAqB,MAAiD;AACpE,UAAM,cAA0C,CAAA;AAE5C,QAAA,SAAS,aAAa,IAAI,GAAG;AAC/B,kBAAY,KAAK,IAAI;AAAA,IACvB;AAEA,QAAI,eAAe,MAAM;AAClB,WAAA,UAAU,QAAQ,CAAC,MAAM;AAC5B,oBAAY,KAAK,GAAG,SAAS,qBAAqB,CAAC,CAAC;AAAA,MAAA,CACrD;AAAA,IACH;AAEA,QAAI,cAAc,MAAM;AACjB,WAAA,SAAS,QAAQ,CAAC,MAAM;AAC3B,YAAI,MAAM,MAAM;AACd,sBAAY,KAAK,GAAG,SAAS,qBAAqB,CAAC,CAAC;AAAA,QACtD;AAAA,MAAA,CACD;AAAA,IACH;AAEA,QAAI,gBAAgB,MAAM;AACnB,WAAA,WAAW,QAAQ,CAAC,MAAM;AAC7B,oBAAY,KAAK,GAAG,SAAS,qBAAqB,CAAC,CAAC;AAAA,MAAA,CACrD;AAAA,IACH;AAEA,QAAI,iBAAiB,MAAM;AACpB,WAAA,YAAY,QAAQ,CAAC,MAAM;AAC9B,oBAAY,KAAK,GAAG,SAAS,qBAAqB,CAAC,CAAC;AAAA,MAAA,CACrD;AAAA,IACH;AAEI,QAAA,KAAK,SAAS,eAAe,UAAU;AACzC,kBAAY,KAAK,GAAG,SAAS,qBAAqB,KAAK,KAAK,CAAC;AAAA,IAC/D;AAEI,QAAA,KAAK,SAAS,eAAe,eAAe;AAC9C,kBAAY,KAAK,GAAG,SAAS,qBAAqB,KAAK,QAAQ,CAAC;AAAA,IAClE;AAEI,QAAA,KAAK,SAAS,eAAe,kBAAkB;AACjD,kBAAY,KAAK,GAAG,SAAS,qBAAqB,KAAK,MAAM,CAAC;AAAA,IAChE;AAEI,QAAA,KAAK,SAAS,eAAe,iBAAiB;AAChD,kBAAY,KAAK,GAAG,SAAS,qBAAqB,KAAK,QAAQ,CAAC;AAAA,IAClE;AAEI,QAAA,KAAK,SAAS,eAAe,iBAAiB;AAChD,kBAAY,KAAK,GAAG,SAAS,qBAAqB,KAAK,UAAU,CAAC;AAAA,IACpE;AAEI,QAAA,KAAK,SAAS,eAAe,qBAAqB;AACpD,kBAAY,KAAK,GAAG,SAAS,qBAAqB,KAAK,UAAU,CAAC;AAAA,IACpE;AAEO,WAAA;AAAA,EACT;AAAA,EACA,mBAAmB,YAA2B;AAC5C,QAAI,eAAe;AACnB,QAAI,cAAc,WAAW;AAE7B,WAAO,gBAAgB,QAAW;AAChC,UACE,YAAY,SAAS,eAAe,kBACpC,YAAY,WAAW,cACvB;AACO,eAAA;AAAA,MACT;AAEI,UAAA,YAAY,SAAS,eAAe,kBAAkB;AACjD,eAAA;AAAA,MACT;AAEe,qBAAA;AACf,oBAAc,YAAY;AAAA,IAC5B;AAEO,WAAA;AAAA,EACT;AAAA,EACA,eACE,YACA,kBACe;AACf,UAAM,SAAS,WAAW;AAE1B,QAAI,WAAW,UAAa,iBAAiB,SAAS,OAAO,IAAI,GAAG;AAC3D,aAAA,SAAS,eAAe,QAAQ,gBAAgB;AAAA,IACzD;AAEO,WAAA;AAAA,EACT;AAAA,EACA,iBAAiB,QAId;AACD,UAAM,EAAE,cAAc,WAAW,aAAA,IAAiB;AAC5C,UAAA,QAAQ,aAAa,QAAQ,YAAY;AAE/C,QAAI,UAAU,MAAM;AACX,aAAA;AAAA,IACT;AAEA,WAAO,MAAM,IAAI,IAAI,UAAU,WAAW,IAAI;AAAA,EAChD;AAAA,EACA,gBAAgB,QAIoB;AAClC,UAAM,EAAE,cAAc,YAAY,KAAA,IAAS;AACrC,UAAA,QAAQ,aAAa,QAAQ,IAAI;AAEvC,QAAI,UAAU,MAAM;AAClB,aAAO;IACT;AAEM,UAAA,aAAa,MAAM,WACtB,OAAO,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,IAAI,IAAI,EAAE,WAAW,IAAI,CAAC,EAC7D,IAAI,CAAC,MAAM;AACV,YAAM,gBAAgB,SAAS,eAAe,EAAE,YAAY;AAAA,QAC1D,eAAe;AAAA,QACf,eAAe;AAAA,MAAA,CAChB;AAEM,aAAA;AAAA,QACL,UAAU;AAAA,QACV,MAAM;AAAA,QACN,MAAM,WAAW,QAAQ,aAAa;AAAA,MAAA;AAAA,IACxC,CACD;AAEH,UAAM,cAAc,IAAI;AAAA,MACtB,CAAC,GAAG,MAAM,IAAI,OAAQ,CAAA,EAAE,IAAI,CAAC,MAAM,WAAW,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC;AAAA,IAAA;AAGzE,UAAM,eAAe,WAAW;AAAA,MAC9B,CAAC,MAAM,EAAE,SAAS,aAAa,QAAQ,CAAC,YAAY,IAAI,EAAE,IAAI;AAAA,IAAA;AAGzD,WAAA,SAAS,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ;AAAA,EACpE;AAAA,EACA,iBACE,MACA,YACA;AACA,WAAO,WAAW;AAAA,MAChB,SAAS,eAAe,MAAM;AAAA,QAC5B,eAAe;AAAA,QACf,eAAe;AAAA,MAAA,CAChB;AAAA,IAAA;AAAA,EAEL;AAAA,EACA,gCACE,YACA;AACA,WACE,eAAe,QACf,eAAe,UACf,eAAe,KAAK,WAAW,IAAI;AAAA,EAEvC;AAAA,EACA,oBACE,SACA;;AACW,eAAA,YAAY,QAAQ,gBAAgB;AACzC,UAAA,SAAS,SAAS,eAAe,qBAAqB;AACjD,eAAA;AAAA,MACT;AAEA,YACE,cAAS,WAAT,mBAAiB,UAAS,eAAe,sBACzC,SAAS,OAAO,GAAG,SAAS,eAAe,cAC3C,SAAS,cAAc,UAAU;AAAA,QAC/B,eAAe;AAAA,QACf,eAAe;AAAA,QACf,eAAe;AAAA,MAAA,CAChB,GACD;AACO,eAAA;AAAA,MACT;AAAA,IACF;AAEO,WAAA;AAAA,EACT;AAAA,EACA,oCAAoC,QAGjC;;AACK,UAAA,EAAE,MAAM,QAAY,IAAA;AAE1B,UAAM,gBAAe,yBAClB,SAAS,EACT,WAAW,KAAK,CAAC,QAAQ,IAAI,eAAe,IAAI,MAF9B,mBAEiC,aAFjC,mBAE2C,KAAK,OAFhD,mBAGjB;AAEA,SAAA,6CAAc,UAAS,eAAe,oBAAoB;AACrD,aAAA;AAAA,IACT;AAEA,WAAO,aAAa;AAAA,EACtB;AAAA,EACA,6BAA6B,MAAqB;AAChD,QAAI,cAAyC;AAEtC,WAAA,YAAY,SAAS,eAAe,SAAS;AAC9C,UAAA,YAAY,SAAS,eAAe,oBAAoB;AACnD,eAAA;AAAA,MACT;AAEA,oBAAc,YAAY;AAAA,IAC5B;AAEO,WAAA;AAAA,EACT;AAAA,EACA,0BACE,MACiC;AACjC,UAAM,mBAAoD,CAAA;AAEtD,QAAA,KAAK,SAAS,eAAe,iBAAiB;AAChD,uBAAiB,KAAK,IAAI;AAAA,IAC5B;AAEA,QAAI,UAAU,QAAQ,KAAK,SAAS,UAAa,KAAK,SAAS,MAAM;AAC7D,YAAA,QAAQ,KAAK,IAAI,IACnB,KAAK,KAAK,QAAQ,CAAC,MAAM;AACvB,yBAAiB,KAAK,GAAG,SAAS,0BAA0B,CAAC,CAAC;AAAA,MAAA,CAC/D,IACD,iBAAiB;AAAA,QACf,GAAG,SAAS,0BAA0B,KAAK,IAAI;AAAA,MAAA;AAAA,IAEvD;AAEA,QAAI,gBAAgB,MAAM;AAClB,YAAA,QAAQ,KAAK,UAAU,IACzB,KAAK,WAAW,QAAQ,CAAC,MAAM;AAC7B,yBAAiB,KAAK,GAAG,SAAS,0BAA0B,CAAC,CAAC;AAAA,MAAA,CAC/D,IACD,iBAAiB;AAAA,QACf,GAAG,SAAS,0BAA0B,KAAK,UAAU;AAAA,MAAA;AAAA,IAE7D;AAEA,QAAI,eAAe,QAAQ,KAAK,cAAc,MAAM;AAC5C,YAAA,QAAQ,KAAK,SAAS,IACxB,KAAK,UAAU,QAAQ,CAAC,MAAM;AAC5B,yBAAiB,KAAK,GAAG,SAAS,0BAA0B,CAAC,CAAC;AAAA,MAAA,CAC/D,IACD,iBAAiB;AAAA,QACf,GAAG,SAAS,0BAA0B,KAAK,SAAS;AAAA,MAAA;AAAA,IAE5D;AAEA,QAAI,WAAW,MAAM;AACd,WAAA,MAAM,QAAQ,CAAC,MAAM;AACxB,yBAAiB,KAAK,GAAG,SAAS,0BAA0B,CAAC,CAAC;AAAA,MAAA,CAC/D;AAAA,IACH;AAEA,QAAI,WAAW,MAAM;AACnB,uBAAiB,KAAK,GAAG,SAAS,0BAA0B,KAAK,KAAK,CAAC;AAAA,IACzE;AAEA,QAAI,aAAa,QAAQ,KAAK,YAAY,MAAM;AAC9C,uBAAiB,KAAK,GAAG,SAAS,0BAA0B,KAAK,OAAO,CAAC;AAAA,IAC3E;AAEA,QAAI,eAAe,QAAQ,KAAK,cAAc,MAAM;AACjC,uBAAA;AAAA,QACf,GAAG,SAAS,0BAA0B,KAAK,SAAS;AAAA,MAAA;AAAA,IAExD;AAEA,QACE,gBAAgB,QAChB,KAAK,eAAe,QACpB,KAAK,eAAe,OACpB;AACiB,uBAAA;AAAA,QACf,GAAG,SAAS,0BAA0B,KAAK,UAAU;AAAA,MAAA;AAAA,IAEzD;AAEA,QAAI,UAAU,QAAQ,KAAK,SAAS,MAAM;AACxC,uBAAiB,KAAK,GAAG,SAAS,0BAA0B,KAAK,IAAI,CAAC;AAAA,IACxE;AAEO,WAAA;AAAA,EACT;AACF;"}

package/dist/esm/utils/detect-react-query-imports.d.ts

@@ -7,6 +7,6 @@ type Helpers = {
     isSpecificTanstackQueryImport: (node: TSESTree.Identifier, source: string) => boolean;
     isTanstackQueryImport: (node: TSESTree.Identifier) => boolean;
 };
-export type EnhancedCreate = (context: Context, options: Options, helpers: Helpers) => ReturnType<Create>;
+type EnhancedCreate = (context: Context, options: Options, helpers: Helpers) => ReturnType<Create>;
 export declare function detectTanstackQueryImports(create: EnhancedCreate): Create;
 export {};

package/dist/esm/utils/detect-react-query-imports.js

@@ -5,8 +5,7 @@ function detectTanstackQueryImports(create) {
     const helpers = {
       isSpecificTanstackQueryImport(node, source) {
         return !!tanstackQueryImportSpecifiers.find((specifier) => {
-          var _a;
-          if (specifier.type === TSESTree.AST_NODE_TYPES.ImportSpecifier && ((_a = specifier.parent) == null ? void 0 : _a.type) === TSESTree.AST_NODE_TYPES.ImportDeclaration && specifier.parent.source.value === source) {
+          if (specifier.type === TSESTree.AST_NODE_TYPES.ImportSpecifier && specifier.parent.type === TSESTree.AST_NODE_TYPES.ImportDeclaration && specifier.parent.source.value === source) {
             return node.name === specifier.local.name;
           }
           return false;

package/dist/esm/utils/detect-react-query-imports.js.map

@@ -1 +1 @@
-{"version":3,"file":"detect-react-query-imports.js","sources":["../../../src/utils/detect-react-query-imports.ts"],"sourcesContent":["import { TSESTree } from '@typescript-eslint/utils'\nimport type { ESLintUtils, TSESLint } from '@typescript-eslint/utils'\n\ntype Create = Parameters<\n  ReturnType<typeof ESLintUtils.RuleCreator>\n>[0]['create']\n\ntype Context = Parameters<Create>[0]\ntype Options = Parameters<Create>[1]\ntype Helpers = {\n  isSpecificTanstackQueryImport: (\n    node: TSESTree.Identifier,\n    source: string,\n  ) => boolean\n  isTanstackQueryImport: (node: TSESTree.Identifier) => boolean\n}\n\nexport type EnhancedCreate = (\n  context: Context,\n  options: Options,\n  helpers: Helpers,\n) => ReturnType<Create>\n\nexport function detectTanstackQueryImports(create: EnhancedCreate): Create {\n  return (context, optionsWithDefault) => {\n    const tanstackQueryImportSpecifiers: Array<TSESTree.ImportClause> = []\n\n    const helpers: Helpers = {\n      isSpecificTanstackQueryImport(node, source) {\n        return !!tanstackQueryImportSpecifiers.find((specifier) => {\n          if (\n            specifier.type === TSESTree.AST_NODE_TYPES.ImportSpecifier &&\n            specifier.parent?.type ===\n              TSESTree.AST_NODE_TYPES.ImportDeclaration &&\n            specifier.parent.source.value === source\n          ) {\n            return node.name === specifier.local.name\n          }\n\n          return false\n        })\n      },\n      isTanstackQueryImport(node) {\n        return !!tanstackQueryImportSpecifiers.find((specifier) => {\n          if (specifier.type === TSESTree.AST_NODE_TYPES.ImportSpecifier) {\n            return node.name === specifier.local.name\n          }\n\n          return false\n        })\n      },\n    }\n\n    const detectionInstructions: TSESLint.RuleListener = {\n      ImportDeclaration(node) {\n        if (\n          node.specifiers.length > 0 &&\n          node.importKind === 'value' &&\n          node.source.value.startsWith('@tanstack/') &&\n          node.source.value.endsWith('-query')\n        ) {\n          tanstackQueryImportSpecifiers.push(...node.specifiers)\n        }\n      },\n    }\n\n    // Call original rule definition\n    const ruleInstructions = create(context, optionsWithDefault, helpers)\n    const enhancedRuleInstructions: TSESLint.RuleListener = {}\n\n    const allKeys = new Set(\n      Object.keys(detectionInstructions).concat(Object.keys(ruleInstructions)),\n    )\n\n    // Iterate over ALL instructions keys so we can override original rule instructions\n    // to prevent their execution if conditions to report errors are not met.\n    allKeys.forEach((instruction) => {\n      enhancedRuleInstructions[instruction] = (node) => {\n        if (instruction in detectionInstructions) {\n          detectionInstructions[instruction]?.(node)\n        }\n\n        // TODO: canReportErrors()\n        if (ruleInstructions[instruction]) {\n          return ruleInstructions[instruction]?.(node)\n        }\n\n        return undefined\n      }\n    })\n\n    return enhancedRuleInstructions\n  }\n}\n"],"names":[],"mappings":";AAuBO,SAAS,2BAA2B,QAAgC;AAClE,SAAA,CAAC,SAAS,uBAAuB;AACtC,UAAM,gCAA8D,CAAA;AAEpE,UAAM,UAAmB;AAAA,MACvB,8BAA8B,MAAM,QAAQ;AAC1C,eAAO,CAAC,CAAC,8BAA8B,KAAK,CAAC,cAAc;;AACzD,cACE,UAAU,SAAS,SAAS,eAAe,qBAC3C,eAAU,WAAV,mBAAkB,UAChB,SAAS,eAAe,qBAC1B,UAAU,OAAO,OAAO,UAAU,QAClC;AACO,mBAAA,KAAK,SAAS,UAAU,MAAM;AAAA,UACvC;AAEO,iBAAA;AAAA,QAAA,CACR;AAAA,MACH;AAAA,MACA,sBAAsB,MAAM;AAC1B,eAAO,CAAC,CAAC,8BAA8B,KAAK,CAAC,cAAc;AACzD,cAAI,UAAU,SAAS,SAAS,eAAe,iBAAiB;AACvD,mBAAA,KAAK,SAAS,UAAU,MAAM;AAAA,UACvC;AAEO,iBAAA;AAAA,QAAA,CACR;AAAA,MACH;AAAA,IAAA;AAGF,UAAM,wBAA+C;AAAA,MACnD,kBAAkB,MAAM;AACtB,YACE,KAAK,WAAW,SAAS,KACzB,KAAK,eAAe,WACpB,KAAK,OAAO,MAAM,WAAW,YAAY,KACzC,KAAK,OAAO,MAAM,SAAS,QAAQ,GACnC;AAC8B,wCAAA,KAAK,GAAG,KAAK,UAAU;AAAA,QACvD;AAAA,MACF;AAAA,IAAA;AAIF,UAAM,mBAAmB,OAAO,SAAS,oBAAoB,OAAO;AACpE,UAAM,2BAAkD,CAAA;AAExD,UAAM,UAAU,IAAI;AAAA,MAClB,OAAO,KAAK,qBAAqB,EAAE,OAAO,OAAO,KAAK,gBAAgB,CAAC;AAAA,IAAA;AAKjE,YAAA,QAAQ,CAAC,gBAAgB;AACN,+BAAA,WAAW,IAAI,CAAC,SAAS;;AAChD,YAAI,eAAe,uBAAuB;AAClB,sCAAA,iBAAA,+CAAe;AAAA,QACvC;AAGI,YAAA,iBAAiB,WAAW,GAAG;AAC1B,kBAAA,sBAAiB,iBAAjB,0CAAgC;AAAA,QACzC;AAEO,eAAA;AAAA,MAAA;AAAA,IACT,CACD;AAEM,WAAA;AAAA,EAAA;AAEX;"}
+{"version":3,"file":"detect-react-query-imports.js","sources":["../../../src/utils/detect-react-query-imports.ts"],"sourcesContent":["import { TSESTree } from '@typescript-eslint/utils'\nimport type { ESLintUtils, TSESLint } from '@typescript-eslint/utils'\n\ntype Create = Parameters<\n  ReturnType<typeof ESLintUtils.RuleCreator>\n>[0]['create']\n\ntype Context = Parameters<Create>[0]\ntype Options = Parameters<Create>[1]\ntype Helpers = {\n  isSpecificTanstackQueryImport: (\n    node: TSESTree.Identifier,\n    source: string,\n  ) => boolean\n  isTanstackQueryImport: (node: TSESTree.Identifier) => boolean\n}\n\ntype EnhancedCreate = (\n  context: Context,\n  options: Options,\n  helpers: Helpers,\n) => ReturnType<Create>\n\nexport function detectTanstackQueryImports(create: EnhancedCreate): Create {\n  return (context, optionsWithDefault) => {\n    const tanstackQueryImportSpecifiers: Array<TSESTree.ImportClause> = []\n\n    const helpers: Helpers = {\n      isSpecificTanstackQueryImport(node, source) {\n        return !!tanstackQueryImportSpecifiers.find((specifier) => {\n          if (\n            specifier.type === TSESTree.AST_NODE_TYPES.ImportSpecifier &&\n            specifier.parent.type ===\n              TSESTree.AST_NODE_TYPES.ImportDeclaration &&\n            specifier.parent.source.value === source\n          ) {\n            return node.name === specifier.local.name\n          }\n\n          return false\n        })\n      },\n      isTanstackQueryImport(node) {\n        return !!tanstackQueryImportSpecifiers.find((specifier) => {\n          if (specifier.type === TSESTree.AST_NODE_TYPES.ImportSpecifier) {\n            return node.name === specifier.local.name\n          }\n\n          return false\n        })\n      },\n    }\n\n    const detectionInstructions: TSESLint.RuleListener = {\n      ImportDeclaration(node) {\n        if (\n          node.specifiers.length > 0 &&\n          node.importKind === 'value' &&\n          node.source.value.startsWith('@tanstack/') &&\n          node.source.value.endsWith('-query')\n        ) {\n          tanstackQueryImportSpecifiers.push(...node.specifiers)\n        }\n      },\n    }\n\n    // Call original rule definition\n    const ruleInstructions = create(context, optionsWithDefault, helpers)\n    const enhancedRuleInstructions: TSESLint.RuleListener = {}\n\n    const allKeys = new Set(\n      Object.keys(detectionInstructions).concat(Object.keys(ruleInstructions)),\n    )\n\n    // Iterate over ALL instructions keys so we can override original rule instructions\n    // to prevent their execution if conditions to report errors are not met.\n    allKeys.forEach((instruction) => {\n      enhancedRuleInstructions[instruction] = (node) => {\n        if (instruction in detectionInstructions) {\n          detectionInstructions[instruction]?.(node)\n        }\n\n        // TODO: canReportErrors()\n        if (ruleInstructions[instruction]) {\n          return ruleInstructions[instruction]?.(node)\n        }\n\n        return undefined\n      }\n    })\n\n    return enhancedRuleInstructions\n  }\n}\n"],"names":[],"mappings":";AAuBO,SAAS,2BAA2B,QAAgC;AAClE,SAAA,CAAC,SAAS,uBAAuB;AACtC,UAAM,gCAA8D,CAAA;AAEpE,UAAM,UAAmB;AAAA,MACvB,8BAA8B,MAAM,QAAQ;AAC1C,eAAO,CAAC,CAAC,8BAA8B,KAAK,CAAC,cAAc;AACzD,cACE,UAAU,SAAS,SAAS,eAAe,mBAC3C,UAAU,OAAO,SACf,SAAS,eAAe,qBAC1B,UAAU,OAAO,OAAO,UAAU,QAClC;AACO,mBAAA,KAAK,SAAS,UAAU,MAAM;AAAA,UACvC;AAEO,iBAAA;AAAA,QAAA,CACR;AAAA,MACH;AAAA,MACA,sBAAsB,MAAM;AAC1B,eAAO,CAAC,CAAC,8BAA8B,KAAK,CAAC,cAAc;AACzD,cAAI,UAAU,SAAS,SAAS,eAAe,iBAAiB;AACvD,mBAAA,KAAK,SAAS,UAAU,MAAM;AAAA,UACvC;AAEO,iBAAA;AAAA,QAAA,CACR;AAAA,MACH;AAAA,IAAA;AAGF,UAAM,wBAA+C;AAAA,MACnD,kBAAkB,MAAM;AACtB,YACE,KAAK,WAAW,SAAS,KACzB,KAAK,eAAe,WACpB,KAAK,OAAO,MAAM,WAAW,YAAY,KACzC,KAAK,OAAO,MAAM,SAAS,QAAQ,GACnC;AAC8B,wCAAA,KAAK,GAAG,KAAK,UAAU;AAAA,QACvD;AAAA,MACF;AAAA,IAAA;AAIF,UAAM,mBAAmB,OAAO,SAAS,oBAAoB,OAAO;AACpE,UAAM,2BAAkD,CAAA;AAExD,UAAM,UAAU,IAAI;AAAA,MAClB,OAAO,KAAK,qBAAqB,EAAE,OAAO,OAAO,KAAK,gBAAgB,CAAC;AAAA,IAAA;AAKjE,YAAA,QAAQ,CAAC,gBAAgB;AACN,+BAAA,WAAW,IAAI,CAAC,SAAS;;AAChD,YAAI,eAAe,uBAAuB;AAClB,sCAAA,iBAAA,+CAAe;AAAA,QACvC;AAGI,YAAA,iBAAiB,WAAW,GAAG;AAC1B,kBAAA,sBAAiB,iBAAjB,0CAAgC;AAAA,QACzC;AAEO,eAAA;AAAA,MAAA;AAAA,IACT,CACD;AAEM,WAAA;AAAA,EAAA;AAEX;"}

package/dist/esm/utils/get-docs-url.d.ts

@@ -0,0 +1 @@
+export declare const getDocsUrl: (ruleName: string) => string;

package/dist/esm/utils/get-docs-url.js

@@ -0,0 +1,5 @@
+const getDocsUrl = (ruleName) => `https://tanstack.com/query/latest/docs/eslint/${ruleName}`;
+export {
+  getDocsUrl
+};
+//# sourceMappingURL=get-docs-url.js.map

package/dist/esm/utils/get-docs-url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-docs-url.js","sources":["../../../src/utils/get-docs-url.ts"],"sourcesContent":["export const getDocsUrl = (ruleName: string): string =>\n  `https://tanstack.com/query/latest/docs/eslint/${ruleName}`\n"],"names":[],"mappings":"AAAO,MAAM,aAAa,CAAC,aACzB,iDAAiD,QAAQ;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/eslint-plugin-query",
-  "version": "5.18.1",
+  "version": "5.20.1",
   "description": "ESLint plugin for TanStack Query",
   "author": "Eliya Cohen",
   "license": "MIT",
@@ -36,9 +36,10 @@
     "src"
   ],
   "dependencies": {
-    "@typescript-eslint/utils": "^5.62.0"
+    "@typescript-eslint/utils": "^6.20.0"
   },
   "devDependencies": {
+    "@typescript-eslint/rule-tester": "^6.20.0",
     "eslint": "^8.56.0"
   },
   "peerDependencies": {

package/src/__tests__/exhaustive-deps.test.ts

@@ -1,8 +1,8 @@
-import { ESLintUtils } from '@typescript-eslint/utils'
-import { normalizeIndent } from '../utils/test-utils'
-import { rule } from '../rules/exhaustive-deps.rule'
+import { RuleTester } from '@typescript-eslint/rule-tester'
+import { rule } from '../rules/exhaustive-deps/exhaustive-deps.rule'
+import { normalizeIndent } from './test-utils'
 
-const ruleTester = new ESLintUtils.RuleTester({
+const ruleTester = new RuleTester({
   parser: '@typescript-eslint/parser',
   settings: {},
 })
@@ -23,7 +23,6 @@ ruleTester.run('exhaustive-deps', rule, {
     },
     {
       name: 'should pass when deps are passed in template literal',
-      // eslint-disable-next-line no-template-curly-in-string
       code: 'useQuery({ queryKey: [`entity/${id}`], queryFn: () => api.getEntity(id) });',
     },
     {
@@ -464,7 +463,6 @@ ruleTester.run('exhaustive-deps', rule, {
           suggestions: [
             {
               messageId: 'fixTo',
-              // eslint-disable-next-line no-template-curly-in-string
               data: { result: '["entity/${id}", id]' },
               output: normalizeIndent`
                 const id = 1;
@@ -489,7 +487,6 @@ ruleTester.run('exhaustive-deps', rule, {
           suggestions: [
             {
               messageId: 'fixTo',
-              // eslint-disable-next-line no-template-curly-in-string
               data: { result: '[`entity/${a}`, b]' },
               output: normalizeIndent`
                 const a = 1;

package/src/{rules/no-rest-desctructuring → __tests__}/no-rest-destructuring.test.ts

@@ -1,8 +1,8 @@
-import { ESLintUtils } from '@typescript-eslint/utils'
-import { normalizeIndent } from '../../utils/test-utils'
-import { rule } from './no-rest-destructuring.rule'
+import { RuleTester } from '@typescript-eslint/rule-tester'
+import { rule } from '../rules/no-rest-destructuring/no-rest-destructuring.rule'
+import { normalizeIndent } from './test-utils'
 
-const ruleTester = new ESLintUtils.RuleTester({
+const ruleTester = new RuleTester({
   parser: '@typescript-eslint/parser',
   settings: {},
 })

package/src/{rules/stable-query-client → __tests__}/stable-query-client.test.ts

@@ -1,8 +1,8 @@
-import { ESLintUtils } from '@typescript-eslint/utils'
-import { normalizeIndent } from '../../utils/test-utils'
-import { rule } from './stable-query-client.rule'
+import { RuleTester } from '@typescript-eslint/rule-tester'
+import { rule } from '../rules/stable-query-client/stable-query-client.rule'
+import { normalizeIndent } from './test-utils'
 
-const ruleTester = new ESLintUtils.RuleTester({
+const ruleTester = new RuleTester({
   parser: '@typescript-eslint/parser',
   settings: {},
 })

package/src/configs.ts

@@ -1,10 +1,18 @@
 import { rules } from './rules'
-import type { TSESLint } from '@typescript-eslint/utils'
+import type { ESLintUtils } from '@typescript-eslint/utils'
 
 function generateRecommendedConfig(
-  allRules: Record<string, TSESLint.RuleModule<any, any>>,
+  allRules: Record<
+    string,
+    ESLintUtils.RuleModule<
+      string,
+      ReadonlyArray<unknown>,
+      ESLintUtils.RuleListener
+    >
+  >,
 ) {
   return Object.entries(allRules).reduce(
+    // @ts-expect-error
     (memo, [name, rule]) => {
       const { recommended } = rule.meta.docs || {}
 

package/src/rules/{exhaustive-deps.rule.ts → exhaustive-deps/exhaustive-deps.rule.ts}

@@ -1,7 +1,8 @@
-import { AST_NODE_TYPES } from '@typescript-eslint/utils'
-import { ASTUtils } from '../utils/ast-utils'
-import { createRule } from '../utils/create-rule'
-import { uniqueBy } from '../utils/unique-by'
+import { AST_NODE_TYPES, ESLintUtils } from '@typescript-eslint/utils'
+import { ASTUtils } from '../../utils/ast-utils'
+import { getDocsUrl } from '../../utils/get-docs-url'
+import { uniqueBy } from '../../utils/unique-by'
+import { detectTanstackQueryImports } from '../../utils/detect-react-query-imports'
 import { ExhaustiveDepsUtils } from './exhaustive-deps.utils'
 import type { TSESLint } from '@typescript-eslint/utils'
 
@@ -10,13 +11,15 @@ const QUERY_FN = 'queryFn'
 
 export const name = 'exhaustive-deps'
 
+const createRule = ESLintUtils.RuleCreator(getDocsUrl)
+
 export const rule = createRule({
   name,
   meta: {
     type: 'problem',
     docs: {
       description: 'Exhaustive deps rule for useQuery',
-      recommended: 'error',
+      recommended: 'error' as any,
     },
     messages: {
       missingDeps: `The following dependencies are missing in your queryKey: {{deps}}`,
@@ -28,11 +31,10 @@ export const rule = createRule({
   },
   defaultOptions: [],
 
-  create(context) {
+  create: detectTanstackQueryImports((context) => {
     return {
-      Property(node) {
+      Property: (node) => {
         if (
-          node.parent === undefined ||
           !ASTUtils.isObjectExpression(node.parent) ||
           !ASTUtils.isIdentifierWithName(node.key, QUERY_KEY)
         ) {
@@ -150,5 +152,5 @@ export const rule = createRule({
         }
       },
     }
-  },
+  }),
 })

package/src/rules/{exhaustive-deps.utils.ts → exhaustive-deps/exhaustive-deps.utils.ts}

@@ -1,5 +1,5 @@
 import { AST_NODE_TYPES } from '@typescript-eslint/utils'
-import { ASTUtils } from '../utils/ast-utils'
+import { ASTUtils } from '../../utils/ast-utils'
 import type { TSESLint } from '@typescript-eslint/utils'
 
 export const ExhaustiveDepsUtils = {
@@ -24,7 +24,7 @@ export const ExhaustiveDepsUtils = {
 
     return (
       reference.identifier.name !== 'undefined' &&
-      reference.identifier.parent?.type !== AST_NODE_TYPES.NewExpression &&
+      reference.identifier.parent.type !== AST_NODE_TYPES.NewExpression &&
       !ExhaustiveDepsUtils.isQueryClientReference(reference)
     )
   },

package/src/rules/{no-rest-desctructuring → no-rest-destructuring}/no-rest-destructuring.rule.ts

@@ -1,19 +1,22 @@
-import { AST_NODE_TYPES } from '@typescript-eslint/utils'
-import { createRule } from '../../utils/create-rule'
+import { AST_NODE_TYPES, ESLintUtils } from '@typescript-eslint/utils'
+import { getDocsUrl } from '../../utils/get-docs-url'
 import { ASTUtils } from '../../utils/ast-utils'
+import { detectTanstackQueryImports } from '../../utils/detect-react-query-imports'
 import { NoRestDestructuringUtils } from './no-rest-destructuring.utils'
 
 export const name = 'no-rest-destructuring'
 
 const queryHooks = ['useQuery', 'useQueries', 'useInfiniteQuery']
 
+const createRule = ESLintUtils.RuleCreator(getDocsUrl)
+
 export const rule = createRule({
   name,
   meta: {
     type: 'problem',
     docs: {
       description: 'Disallows rest destructuring in queries',
-      recommended: 'warn',
+      recommended: 'warn' as any,
     },
     messages: {
       objectRestDestructure: `Object rest destructuring on a query will observe all changes to the query, leading to excessive re-renders.`,
@@ -22,13 +25,13 @@ export const rule = createRule({
   },
   defaultOptions: [],
 
-  create(context, _, helpers) {
+  create: detectTanstackQueryImports((context, _, helpers) => {
     return {
-      CallExpression(node) {
+      CallExpression: (node) => {
         if (
           !ASTUtils.isIdentifierWithOneOfNames(node.callee, queryHooks) ||
           !helpers.isTanstackQueryImport(node.callee) ||
-          node.parent?.type !== AST_NODE_TYPES.VariableDeclarator
+          node.parent.type !== AST_NODE_TYPES.VariableDeclarator
         ) {
           return
         }
@@ -60,5 +63,5 @@ export const rule = createRule({
         })
       },
     }
-  },
+  }),
 })

package/src/rules/stable-query-client/stable-query-client.rule.ts

@@ -1,17 +1,20 @@
-import { AST_NODE_TYPES } from '@typescript-eslint/utils'
+import { AST_NODE_TYPES, ESLintUtils } from '@typescript-eslint/utils'
 import { ASTUtils } from '../../utils/ast-utils'
-import { createRule } from '../../utils/create-rule'
+import { getDocsUrl } from '../../utils/get-docs-url'
+import { detectTanstackQueryImports } from '../../utils/detect-react-query-imports'
 import type { TSESLint } from '@typescript-eslint/utils'
 
 export const name = 'stable-query-client'
 
+const createRule = ESLintUtils.RuleCreator(getDocsUrl)
+
 export const rule = createRule({
   name,
   meta: {
     type: 'problem',
     docs: {
       description: 'Makes sure that QueryClient is stable',
-      recommended: 'error',
+      recommended: 'error' as any,
     },
     messages: {
       unstable: [
@@ -26,13 +29,13 @@ export const rule = createRule({
   },
   defaultOptions: [],
 
-  create(context, _, helpers) {
+  create: detectTanstackQueryImports((context, _, helpers) => {
     return {
-      NewExpression(node) {
+      NewExpression: (node) => {
         if (
           node.callee.type !== AST_NODE_TYPES.Identifier ||
           node.callee.name !== 'QueryClient' ||
-          node.parent?.type !== AST_NODE_TYPES.VariableDeclarator ||
+          node.parent.type !== AST_NODE_TYPES.VariableDeclarator ||
           !helpers.isSpecificTanstackQueryImport(
             node.callee,
             '@tanstack/react-query',
@@ -74,5 +77,5 @@ export const rule = createRule({
         })
       },
     }
-  },
+  }),
 })

package/src/rules.ts

@@ -1,8 +1,16 @@
-import * as exhaustiveDeps from './rules/exhaustive-deps.rule'
+import * as exhaustiveDeps from './rules/exhaustive-deps/exhaustive-deps.rule'
 import * as stableQueryClient from './rules/stable-query-client/stable-query-client.rule'
-import * as noRestDestructuring from './rules/no-rest-desctructuring/no-rest-destructuring.rule'
+import * as noRestDestructuring from './rules/no-rest-destructuring/no-rest-destructuring.rule'
+import type { ESLintUtils } from '@typescript-eslint/utils'
 
-export const rules = {
+export const rules: Record<
+  string,
+  ESLintUtils.RuleModule<
+    string,
+    ReadonlyArray<unknown>,
+    ESLintUtils.RuleListener
+  >
+> = {
   [exhaustiveDeps.name]: exhaustiveDeps.rule,
   [stableQueryClient.name]: stableQueryClient.rule,
   [noRestDestructuring.name]: noRestDestructuring.rule,