feat!(eslint-plugin-query): Migrate to ESLint v9 with Flat Config Support

examples/react/basic-typescript/package.json

@@ -22,7 +22,7 @@
     "@types/react": "^18.2.55",
     "@types/react-dom": "^18.2.19",
     "@vitejs/plugin-react": "^4.2.1",
-    "eslint": "^8.56.0",
+    "eslint": "^9.0.0",
     "eslint-config-prettier": "^9.1.0",
     "typescript": "5.2.2",
     "vite": "^5.1.1"

examples/react/shadow-dom/package.json

@@ -21,7 +21,7 @@
     "@typescript-eslint/eslint-plugin": "^7.0.2",
     "@typescript-eslint/parser": "^7.0.2",
     "@vitejs/plugin-react": "^4.2.1",
-    "eslint": "^8.56.0",
+    "eslint": "^9.0.0",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.5",
     "typescript": "5.2.2",

package.json

@@ -56,7 +56,7 @@
     "@vitest/coverage-istanbul": "^1.3.1",
     "cpy-cli": "^5.0.0",
     "esbuild-plugin-file-path-extensions": "^2.0.0",
-    "eslint": "^8.56.0",
+    "eslint": "^9.0.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-import": "^2.29.1",

packages/eslint-plugin-query/package.json

@@ -46,13 +46,13 @@
     "src"
   ],
   "dependencies": {
-    "@typescript-eslint/utils": "^6.20.0"
+    "@typescript-eslint/utils": "^7.6.0"
   },
   "devDependencies": {
-    "@typescript-eslint/rule-tester": "^6.20.0",
-    "eslint": "^8.56.0"
+    "@typescript-eslint/rule-tester": "^7.6.0",
+    "eslint": "^9.0.0"
   },
   "peerDependencies": {
-    "eslint": "^8.0.0"
+    "eslint": "^8.0.0 || ^9.0.0"
   }
 }

packages/eslint-plugin-query/src/__tests__/configs.test.ts

@@ -1,19 +1,17 @@
 import { describe, expect, it } from 'vitest'
-import { configs } from '../configs'
+import plugin from '../'
 
 describe('configs', () => {
   it('should match snapshot', () => {
-    expect(configs).toMatchInlineSnapshot(`
+    expect(plugin.configs.recommended).toMatchInlineSnapshot(`
       {
-        "recommended": {
-          "plugins": [
-            "@tanstack/eslint-plugin-query",
-          ],
-          "rules": {
-            "@tanstack/query/exhaustive-deps": "error",
-            "@tanstack/query/no-rest-destructuring": "warn",
-            "@tanstack/query/stable-query-client": "error",
-          },
+        "plugins": [
+          "@tanstack/eslint-plugin-query",
+        ],
+        "rules": {
+          "@tanstack/query/exhaustive-deps": "error",
+          "@tanstack/query/no-rest-destructuring": "warn",
+          "@tanstack/query/stable-query-client": "error",
         },
       }
     `)

packages/eslint-plugin-query/src/configs.ts

@@ -1,7 +1,6 @@
-import { rules } from './rules'
 import type { ESLintUtils } from '@typescript-eslint/utils'
 
-function generateRecommendedConfig(
+export function generateRecommendedConfig(
   allRules: Record<
     string,
     ESLintUtils.RuleModule<
@@ -24,10 +23,3 @@ function generateRecommendedConfig(
     {} as Record<string, 'strict' | 'error' | 'warn'>,
   )
 }
-
-export const configs = {
-  recommended: {
-    plugins: ['@tanstack/eslint-plugin-query'],
-    rules: generateRecommendedConfig(rules),
-  },
-}

packages/eslint-plugin-query/src/index.ts

@@ -1,2 +1,24 @@
-export { configs } from './configs'
-export { rules } from './rules'
+import { generateRecommendedConfig } from './configs'
+import { rules } from './rules'
+import { name as packageName, version as packageVersion } from '../package.json'
+
+type Configs = Record<'recommended' | 'flat/recommended', any>
+
+const plugin = {
+  meta: { name: packageName, version: packageVersion },
+  configs: {} as Configs,
+  rules: rules as Record<string, any>,
+}
+
+plugin.configs = {
+  recommended: {
+    plugins: ['@tanstack/eslint-plugin-query'],
+    rules: generateRecommendedConfig(rules),
+  },
+  'flat/recommended': {
+    plugins: { plugin },
+    rules: generateRecommendedConfig(rules),
+  },
+}
+
+export default plugin

packages/eslint-plugin-query/src/rules/exhaustive-deps/exhaustive-deps.rule.ts

@@ -83,7 +83,7 @@ export const rule = createRule({
           }
         }
 
-        const sourceCode = context.getSourceCode()
+        const sourceCode = context.sourceCode
         const queryKeyValue = queryKeyNode
         const externalRefs = ASTUtils.getExternalRefs({
           scopeManager,
@@ -93,9 +93,10 @@ export const rule = createRule({
 
         const relevantRefs = externalRefs.filter((reference) =>
           ExhaustiveDepsUtils.isRelevantReference({
-            context,
+            sourceCode,
             reference,
             scopeManager,
+            node: queryFn.value,
           }),
         )
 

packages/eslint-plugin-query/src/rules/exhaustive-deps/exhaustive-deps.utils.ts

@@ -1,15 +1,16 @@
 import { AST_NODE_TYPES } from '@typescript-eslint/utils'
 import { ASTUtils } from '../../utils/ast-utils'
-import type { TSESLint } from '@typescript-eslint/utils'
+import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
 
 export const ExhaustiveDepsUtils = {
   isRelevantReference(params: {
-    context: Readonly<TSESLint.RuleContext<string, ReadonlyArray<unknown>>>
+    sourceCode: Readonly<TSESLint.SourceCode>
     reference: TSESLint.Scope.Reference
     scopeManager: TSESLint.Scope.ScopeManager
+    node: TSESTree.Node
   }) {
-    const { reference, scopeManager, context } = params
-    const component = ASTUtils.getFunctionAncestor(context)
+    const { reference, scopeManager, sourceCode, node } = params
+    const component = ASTUtils.getFunctionAncestor(sourceCode, node)
 
     if (
       component !== undefined &&

packages/eslint-plugin-query/src/rules/stable-query-client/stable-query-client.rule.ts

@@ -44,7 +44,10 @@ export const rule = createRule({
           return
         }
 
-        const fnAncestor = ASTUtils.getFunctionAncestor(context)
+        const fnAncestor = ASTUtils.getFunctionAncestor(
+          context.sourceCode,
+          node,
+        )
         const isReactServerComponent = fnAncestor?.async === true
 
         if (

packages/eslint-plugin-query/src/utils/ast-utils.ts

@@ -219,9 +219,10 @@ export const ASTUtils = {
     )
   },
   getFunctionAncestor(
-    context: Readonly<TSESLint.RuleContext<string, ReadonlyArray<unknown>>>,
+    sourceCode: Readonly<TSESLint.SourceCode>,
+    node: TSESTree.Node,
   ) {
-    for (const ancestor of context.getAncestors()) {
+    for (const ancestor of sourceCode.getAncestors(node)) {
       if (ancestor.type === AST_NODE_TYPES.FunctionDeclaration) {
         return ancestor
       }