feat(eslint-plugin-query): Update @typescript-eslint/utils to v6 (Tan…

…Stack#6864) * Try to update ts-eslint v6 * Fix recommended * Finish migration * Remove any * Use `project: true` * Use alternative function syntax
ardeora · Feb 10, 2024 · 4220885 · 4220885
1 parent 92d2deb
commit 4220885
Show file tree

Hide file tree

Showing 44 changed files with 252 additions and 143 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -19,7 +19,7 @@ const config = {
   },
   parserOptions: {
     tsconfigRootDir: __dirname,
-    project: './tsconfig.json',
+    project: true,
     sourceType: 'module',
     ecmaVersion: 2020,
   },

diff --git a/examples/angular/basic/.eslintrc.cjs b/examples/angular/basic/.eslintrc.cjs
@@ -0,0 +1,11 @@
+// @ts-check
+
+/** @type {import('eslint').Linter.Config} */
+const config = {
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: true,
+  },
+}
+
+module.exports = config
diff --git a/examples/angular/default-query-function/.eslintrc.cjs b/examples/angular/default-query-function/.eslintrc.cjs
@@ -4,7 +4,7 @@
 const config = {
   parserOptions: {
     tsconfigRootDir: __dirname,
-    project: './tsconfig.json',
+    project: true,
   },
 }
 

diff --git a/examples/angular/simple/.eslintrc.cjs b/examples/angular/simple/.eslintrc.cjs
@@ -4,7 +4,7 @@
 const config = {
   parserOptions: {
     tsconfigRootDir: __dirname,
-    project: './tsconfig.json',
+    project: true,
   },
 }
 

diff --git a/integrations/react-cra4/.eslintrc.cjs b/integrations/react-cra4/.eslintrc.cjs
@@ -8,7 +8,7 @@ module.exports = {
   ],
   parserOptions: {
     tsconfigRootDir: __dirname,
-    project: './tsconfig.json',
+    project: true,
   },
   settings: {
     react: {

diff --git a/integrations/react-cra5/.eslintrc.cjs b/integrations/react-cra5/.eslintrc.cjs
@@ -8,7 +8,7 @@ module.exports = {
   ],
   parserOptions: {
     tsconfigRootDir: __dirname,
-    project: './tsconfig.json',
+    project: true,
   },
   settings: {
     react: {

diff --git a/integrations/react-next/.eslintrc.cjs b/integrations/react-next/.eslintrc.cjs
@@ -8,7 +8,7 @@ module.exports = {
   ],
   parserOptions: {
     tsconfigRootDir: __dirname,
-    project: './tsconfig.json',
+    project: true,
   },
   settings: {
     react: {

diff --git a/integrations/react-vite/.eslintrc.cjs b/integrations/react-vite/.eslintrc.cjs
@@ -8,7 +8,7 @@ module.exports = {
   ],
   parserOptions: {
     tsconfigRootDir: __dirname,
-    project: './tsconfig.json',
+    project: true,
   },
   settings: {
     react: {

diff --git a/package.json b/package.json
@@ -46,8 +46,8 @@
     "@types/node": "^18.19.3",
     "@types/react": "^18.2.45",
     "@types/react-dom": "^18.2.18",
-    "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "@typescript-eslint/parser": "^5.62.0",
+    "@typescript-eslint/eslint-plugin": "^6.20.0",
+    "@typescript-eslint/parser": "^6.20.0",
     "@vitest/coverage-istanbul": "^1.1.0",
     "cpy-cli": "^5.0.0",
     "esbuild-plugin-file-path-extensions": "^2.0.0",

diff --git a/packages/angular-query-devtools-experimental/.eslintrc.cjs b/packages/angular-query-devtools-experimental/.eslintrc.cjs
@@ -4,7 +4,7 @@
 const config = {
   parserOptions: {
     tsconfigRootDir: __dirname,
-    project: './tsconfig.json',
+    project: true,
   },
 }
 

diff --git a/packages/angular-query-experimental/.eslintrc.cjs b/packages/angular-query-experimental/.eslintrc.cjs
@@ -4,7 +4,7 @@
 const config = {
   parserOptions: {
     tsconfigRootDir: __dirname,
-    project: './tsconfig.json',
+    project: true,
   },
 }
 

diff --git a/packages/codemods/.eslintrc.cjs b/packages/codemods/.eslintrc.cjs
@@ -4,7 +4,7 @@
 const config = {
   parserOptions: {
     tsconfigRootDir: __dirname,
-    project: './tsconfig.json',
+    project: true,
   },
   overrides: [
     {

diff --git a/packages/eslint-plugin-query/.eslintrc.cjs b/packages/eslint-plugin-query/.eslintrc.cjs
@@ -4,7 +4,7 @@
 const config = {
   parserOptions: {
     tsconfigRootDir: __dirname,
-    project: './tsconfig.json',
+    project: true,
   },
 }
 

diff --git a/packages/eslint-plugin-query/package.json b/packages/eslint-plugin-query/package.json
@@ -45,9 +45,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": {

diff --git a/packages/eslint-plugin-query/src/__tests__/exhaustive-deps.test.ts b/packages/eslint-plugin-query/src/__tests__/exhaustive-deps.test.ts
@@ -1,8 +1,8 @@
-import { ESLintUtils } from '@typescript-eslint/utils'
+import { RuleTester } from '@typescript-eslint/rule-tester'
 import { normalizeIndent } from '../utils/test-utils'
 import { rule } from '../rules/exhaustive-deps.rule'
 
-const ruleTester = new ESLintUtils.RuleTester({
+const ruleTester = new RuleTester({
   parser: '@typescript-eslint/parser',
   settings: {},
 })

diff --git a/packages/eslint-plugin-query/src/configs.ts b/packages/eslint-plugin-query/src/configs.ts
@@ -5,6 +5,7 @@ function generateRecommendedConfig(
   allRules: Record<string, TSESLint.RuleModule<any, any>>,
 ) {
   return Object.entries(allRules).reduce(
+    // @ts-expect-error
     (memo, [name, rule]) => {
       const { recommended } = rule.meta.docs || {}
 

diff --git a/packages/eslint-plugin-query/src/rules.ts b/packages/eslint-plugin-query/src/rules.ts
@@ -1,8 +1,12 @@
 import * as exhaustiveDeps from './rules/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 type { ESLintUtils } from '@typescript-eslint/utils'
 
-export const rules = {
+export const rules: Record<
+  string,
+  ESLintUtils.RuleModule<string, any, ESLintUtils.RuleListener>
+> = {
   [exhaustiveDeps.name]: exhaustiveDeps.rule,
   [stableQueryClient.name]: stableQueryClient.rule,
   [noRestDestructuring.name]: noRestDestructuring.rule,

diff --git a/packages/eslint-plugin-query/src/rules/exhaustive-deps.rule.ts b/packages/eslint-plugin-query/src/rules/exhaustive-deps.rule.ts
@@ -3,20 +3,24 @@ import { ASTUtils } from '../utils/ast-utils'
 import { createRule } from '../utils/create-rule'
 import { uniqueBy } from '../utils/unique-by'
 import { ExhaustiveDepsUtils } from './exhaustive-deps.utils'
-import type { TSESLint } from '@typescript-eslint/utils'
+import type { ESLintUtils, TSESLint } from '@typescript-eslint/utils'
 
 const QUERY_KEY = 'queryKey'
 const QUERY_FN = 'queryFn'
 
 export const name = 'exhaustive-deps'
 
-export const rule = createRule({
+export const rule: ESLintUtils.RuleModule<
+  string,
+  any,
+  ESLintUtils.RuleListener
+> = 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 +32,10 @@ export const rule = createRule({
   },
   defaultOptions: [],
 
-  create(context) {
+  create: (context) => {
     return {
-      Property(node) {
+      Property: (node) => {
         if (
-          node.parent === undefined ||
           !ASTUtils.isObjectExpression(node.parent) ||
           !ASTUtils.isIdentifierWithName(node.key, QUERY_KEY)
         ) {

diff --git a/packages/eslint-plugin-query/src/rules/exhaustive-deps.utils.ts b/packages/eslint-plugin-query/src/rules/exhaustive-deps.utils.ts
@@ -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)
     )
   },

diff --git a/packages/eslint-plugin-query/src/rules/no-rest-desctructuring/no-rest-destructuring.rule.ts b/packages/eslint-plugin-query/src/rules/no-rest-desctructuring/no-rest-destructuring.rule.ts
@@ -2,18 +2,23 @@ import { AST_NODE_TYPES } from '@typescript-eslint/utils'
 import { createRule } from '../../utils/create-rule'
 import { ASTUtils } from '../../utils/ast-utils'
 import { NoRestDestructuringUtils } from './no-rest-destructuring.utils'
+import type { ESLintUtils } from '@typescript-eslint/utils'
 
 export const name = 'no-rest-destructuring'
 
 const queryHooks = ['useQuery', 'useQueries', 'useInfiniteQuery']
 
-export const rule = createRule({
+export const rule: ESLintUtils.RuleModule<
+  string,
+  any,
+  ESLintUtils.RuleListener
+> = 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 +27,13 @@ export const rule = createRule({
   },
   defaultOptions: [],
 
-  create(context, _, helpers) {
+  create: (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
         }

diff --git a/packages/eslint-plugin-query/src/rules/no-rest-desctructuring/no-rest-destructuring.test.ts b/packages/eslint-plugin-query/src/rules/no-rest-desctructuring/no-rest-destructuring.test.ts
@@ -1,8 +1,8 @@
-import { ESLintUtils } from '@typescript-eslint/utils'
+import { RuleTester } from '@typescript-eslint/rule-tester'
 import { normalizeIndent } from '../../utils/test-utils'
 import { rule } from './no-rest-destructuring.rule'
 
-const ruleTester = new ESLintUtils.RuleTester({
+const ruleTester = new RuleTester({
   parser: '@typescript-eslint/parser',
   settings: {},
 })

diff --git a/packages/eslint-plugin-query/src/rules/stable-query-client/stable-query-client.rule.ts b/packages/eslint-plugin-query/src/rules/stable-query-client/stable-query-client.rule.ts
@@ -2,16 +2,21 @@ import { AST_NODE_TYPES } from '@typescript-eslint/utils'
 import { ASTUtils } from '../../utils/ast-utils'
 import { createRule } from '../../utils/create-rule'
 import type { TSESLint } from '@typescript-eslint/utils'
+import type { ESLintUtils } from '@typescript-eslint/utils'
 
 export const name = 'stable-query-client'
 
-export const rule = createRule({
+export const rule: ESLintUtils.RuleModule<
+  string,
+  any,
+  ESLintUtils.RuleListener
+> = createRule({
   name,
   meta: {
     type: 'problem',
     docs: {
       description: 'Makes sure that QueryClient is stable',
-      recommended: 'error',
+      recommended: 'error' as any,
     },
     messages: {
       unstable: [
@@ -26,13 +31,13 @@ export const rule = createRule({
   },
   defaultOptions: [],
 
-  create(context, _, helpers) {
+  create: (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',

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

diff --git a/packages/eslint-plugin-query/src/utils/ast-utils.ts b/packages/eslint-plugin-query/src/utils/ast-utils.ts
@@ -1,7 +1,6 @@
 import { AST_NODE_TYPES } from '@typescript-eslint/utils'
 import { uniqueBy } from './unique-by'
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
-import type { RuleContext } from '@typescript-eslint/utils/dist/ts-eslint'
 
 export const ASTUtils = {
   isNodeOfOneOf<T extends AST_NODE_TYPES>(
@@ -212,7 +211,7 @@ export const ASTUtils = {
     )
   },
   getFunctionAncestor(
-    context: Readonly<RuleContext<string, ReadonlyArray<unknown>>>,
+    context: Readonly<TSESLint.RuleContext<string, ReadonlyArray<unknown>>>,
   ) {
     for (const ancestor of context.getAncestors()) {
       if (ancestor.type === AST_NODE_TYPES.FunctionDeclaration) {
@@ -236,7 +235,7 @@ export const ASTUtils = {
   },
   getReferencedExpressionByIdentifier(params: {
     node: TSESTree.Node
-    context: Readonly<RuleContext<string, ReadonlyArray<unknown>>>
+    context: Readonly<TSESLint.RuleContext<string, ReadonlyArray<unknown>>>
   }) {
     const { node, context } = params
 
@@ -254,10 +253,7 @@ export const ASTUtils = {
   getClosestVariableDeclarator(node: TSESTree.Node) {
     let currentNode: TSESTree.Node | undefined = node
 
-    while (
-      currentNode !== undefined &&
-      currentNode.type !== AST_NODE_TYPES.Program
-    ) {
+    while (currentNode.type !== AST_NODE_TYPES.Program) {
       if (currentNode.type === AST_NODE_TYPES.VariableDeclarator) {
         return currentNode
       }

diff --git a/packages/eslint-plugin-query/src/utils/detect-react-query-imports.ts b/packages/eslint-plugin-query/src/utils/detect-react-query-imports.ts
@@ -30,7 +30,7 @@ export function detectTanstackQueryImports(create: EnhancedCreate): Create {
         return !!tanstackQueryImportSpecifiers.find((specifier) => {
           if (
             specifier.type === TSESTree.AST_NODE_TYPES.ImportSpecifier &&
-            specifier.parent?.type ===
+            specifier.parent.type ===
               TSESTree.AST_NODE_TYPES.ImportDeclaration &&
             specifier.parent.source.value === source
           ) {

diff --git a/packages/query-async-storage-persister/.eslintrc.cjs b/packages/query-async-storage-persister/.eslintrc.cjs
@@ -4,7 +4,7 @@
 const config = {
   parserOptions: {
     tsconfigRootDir: __dirname,
-    project: './tsconfig.json',
+    project: true,
   },
 }
 

diff --git a/packages/query-broadcast-client-experimental/.eslintrc.cjs b/packages/query-broadcast-client-experimental/.eslintrc.cjs
@@ -4,7 +4,7 @@
 const config = {
   parserOptions: {
     tsconfigRootDir: __dirname,
-    project: './tsconfig.json',
+    project: true,
   },
 }
 

diff --git a/packages/query-core/.eslintrc.cjs b/packages/query-core/.eslintrc.cjs
@@ -4,7 +4,7 @@
 const config = {
   parserOptions: {
     tsconfigRootDir: __dirname,
-    project: './tsconfig.json',
+    project: true,
   },
 }