chore: Update ESLint config (#7637)

lachlancollins · web-flow · commit febbde676d08 · 2024-06-28T11:17:57.000+10:00
* chore: Update ESLint config

* Fix errors

* Fix knip
diff --git a/eslint.config.js b/eslint.config.js
@@ -1,18 +1,19 @@
 // @ts-check
 
-// @ts-ignore
-import { rootConfig } from '@tanstack/config/eslint'
-// @ts-ignore
-import cspellConfigs from '@cspell/eslint-plugin/configs'
+// @ts-ignore Needed due to moduleResolution Node vs Bundler
+import { tanstackConfig } from '@tanstack/config/eslint'
+import pluginCspell from '@cspell/eslint-plugin'
 
 export default [
-  ...rootConfig,
-  cspellConfigs.recommended,
+  ...tanstackConfig,
   {
     name: 'tanstack/temp',
+    plugins: {
+      cspell: pluginCspell,
+    },
     rules: {
-      '@cspell/spellchecker': [
-        'error',
+      'cspell/spellchecker': [
+        'warn',
         {
           cspell: {
             words: [
@@ -34,8 +35,11 @@ export default [
           },
         },
       ],
-      '@typescript-eslint/no-empty-function': 'off',
+      'ts/ban-types': 'off',
+      'ts/no-empty-function': 'off',
+      'ts/require-await': 'off',
       'no-case-declarations': 'off',
+      'no-empty': 'off',
       'no-prototype-builtins': 'off',
     },
   },
diff --git a/package.json b/package.json
@@ -46,7 +46,7 @@
     "@cspell/eslint-plugin": "^8.9.1",
     "@eslint-react/eslint-plugin": "^1.5.16",
     "@solidjs/testing-library": "^0.8.8",
-    "@tanstack/config": "^0.8.1",
+    "@tanstack/config": "^0.8.6",
     "@testing-library/jest-dom": "^6.4.5",
     "@testing-library/react": "^15.0.7",
     "@types/node": "^20.12.12",
@@ -72,7 +72,6 @@
     "solid-js": "^1.8.17",
     "tsup": "^8.0.2",
     "typescript": "5.3.3",
-    "typescript-eslint": "^7.14.1",
     "typescript47": "npm:typescript@4.7",
     "typescript48": "npm:typescript@4.8",
     "typescript49": "npm:typescript@4.9",
diff --git a/packages/angular-query-devtools-experimental/src/angular-query-devtools.component.ts b/packages/angular-query-devtools-experimental/src/angular-query-devtools.component.ts
@@ -1,9 +1,5 @@
 import { isPlatformBrowser } from '@angular/common'
 import * as queryDevtools from '@tanstack/query-devtools'
-import {
-  injectQueryClient,
-  onlineManager,
-} from '@tanstack/angular-query-experimental'
 import {
   ChangeDetectionStrategy,
   Component,
@@ -14,7 +10,11 @@ import {
   booleanAttribute,
   inject,
 } from '@angular/core'
-import { QueryClient } from '@tanstack/angular-query-experimental'
+import {
+  QueryClient,
+  injectQueryClient,
+  onlineManager,
+} from '@tanstack/angular-query-experimental'
 import type {
   AfterViewInit,
   OnChanges,
diff --git a/packages/angular-query-experimental/src/infinite-query-options.ts b/packages/angular-query-experimental/src/infinite-query-options.ts
@@ -1,7 +1,10 @@
-import type { DataTag } from '@tanstack/query-core'
-import type { InfiniteData } from '@tanstack/query-core'
+import type {
+  DataTag,
+  DefaultError,
+  InfiniteData,
+  QueryKey,
+} from '@tanstack/query-core'
 import type { CreateInfiniteQueryOptions, NonUndefinedGuard } from './types'
-import type { DefaultError, QueryKey } from '@tanstack/query-core'
 
 /**
  * @public
diff --git a/packages/angular-query-experimental/src/util/assert-injector/assert-injector.test.ts b/packages/angular-query-experimental/src/util/assert-injector/assert-injector.test.ts
@@ -1,4 +1,4 @@
-/* eslint-disable @cspell/spellchecker */
+/* eslint-disable cspell/spellchecker */
 /**
  * The code in this file is adapted from NG Extension Platform at https://ngxtension.netlify.app.
  *
diff --git a/packages/angular-query-experimental/src/util/assert-injector/assert-injector.ts b/packages/angular-query-experimental/src/util/assert-injector/assert-injector.ts
@@ -1,4 +1,4 @@
-/* eslint-disable @cspell/spellchecker */
+/* eslint-disable cspell/spellchecker */
 /**
  * The code in this file is adapted from NG Extension Platform at https://ngxtension.netlify.app.
  *
diff --git a/packages/angular-query-experimental/src/util/create-injection-token/create-injection-token.test.ts b/packages/angular-query-experimental/src/util/create-injection-token/create-injection-token.test.ts
@@ -1,4 +1,4 @@
-/* eslint-disable @cspell/spellchecker */
+/* eslint-disable cspell/spellchecker */
 /**
  * The code in this file is adapted from NG Extension Platform at https://ngxtension.netlify.app.
  *
diff --git a/packages/angular-query-experimental/src/util/create-injection-token/create-injection-token.ts b/packages/angular-query-experimental/src/util/create-injection-token/create-injection-token.ts
@@ -1,4 +1,4 @@
-/* eslint-disable @cspell/spellchecker */
+/* eslint-disable cspell/spellchecker */
 /**
  * The code in this file is adapted from NG Extension Platform at https://ngxtension.netlify.app.
  *
@@ -169,7 +169,7 @@ export function createNoopInjectionToken<
   type TReturn = TMulti extends true ? Array<TValue> : TValue
 
   const token =
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    // eslint-disable-next-line ts/no-unnecessary-condition
     (options as CreateInjectionTokenOptions<() => void, []>)?.token ||
     new InjectionToken<TReturn>(description)
   return [
diff --git a/packages/query-codemods/eslint.config.js b/packages/query-codemods/eslint.config.js
@@ -6,9 +6,9 @@ export default [
   ...rootConfig,
   {
     rules: {
-      '@cspell/spellchecker': 'off',
-      '@typescript-eslint/no-unused-vars': 'off',
-      '@typescript-eslint/no-unnecessary-condition': 'off',
+      'cspell/spellchecker': 'off',
+      'ts/no-unnecessary-condition': 'off',
+      'import/no-duplicates': 'off',
       'import/no-unresolved': 'off',
       'import/order': 'off',
       'no-shadow': 'off',
diff --git a/packages/query-codemods/src/v4/__tests__/key-transformation.test.cjs b/packages/query-codemods/src/v4/__tests__/key-transformation.test.cjs
@@ -1,4 +1,3 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const defineTest = require('jscodeshift/dist/testUtils').defineTest
 
 defineTest(__dirname, 'key-transformation.cjs', null, 'default-import', {
diff --git a/packages/query-codemods/src/v4/__tests__/replace-import-specifier.test.cjs b/packages/query-codemods/src/v4/__tests__/replace-import-specifier.test.cjs
@@ -1,4 +1,3 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const defineTest = require('jscodeshift/dist/testUtils').defineTest
 
 defineTest(
diff --git a/packages/query-codemods/src/v4/key-transformation.cjs b/packages/query-codemods/src/v4/key-transformation.cjs
@@ -1,12 +1,7 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const createUtilsObject = require('../utils/index.cjs')
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const createKeyReplacer = require('./utils/replacers/key-replacer.cjs')
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const createUseQueryLikeTransformer = require('../utils/transformers/use-query-like-transformer.cjs')
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const createQueryClientTransformer = require('../utils/transformers/query-client-transformer.cjs')
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const createQueryCacheTransformer = require('../utils/transformers/query-cache-transformer.cjs')
 
 const transformQueryClientUsages = ({
diff --git a/packages/query-codemods/src/v5/is-loading/__tests__/is-loading.test.cjs b/packages/query-codemods/src/v5/is-loading/__tests__/is-loading.test.cjs
@@ -1,4 +1,3 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const defineTest = require('jscodeshift/dist/testUtils').defineTest
 
 defineTest(__dirname, 'is-loading.cjs', null, 'default-import', {
diff --git a/packages/query-codemods/src/v5/is-loading/is-loading.cjs b/packages/query-codemods/src/v5/is-loading/is-loading.cjs
@@ -1,8 +1,5 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const createUtilsObject = require('../../utils/index.cjs')
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const createUseQueryLikeTransformer = require('../../utils/transformers/use-query-like-transformer.cjs')
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const createQueryClientTransformer = require('../../utils/transformers/query-client-transformer.cjs')
 
 const originalName = 'isLoading'
diff --git a/packages/query-codemods/src/v5/keep-previous-data/__tests__/keep-previous-data.test.cjs b/packages/query-codemods/src/v5/keep-previous-data/__tests__/keep-previous-data.test.cjs
@@ -1,4 +1,3 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const defineTest = require('jscodeshift/dist/testUtils').defineTest
 
 defineTest(__dirname, 'keep-previous-data.cjs', null, 'default', {
diff --git a/packages/query-codemods/src/v5/keep-previous-data/keep-previous-data.cjs b/packages/query-codemods/src/v5/keep-previous-data/keep-previous-data.cjs
@@ -1,10 +1,6 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const createUtilsObject = require('../../utils/index.cjs')
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const createUseQueryLikeTransformer = require('../../utils/transformers/use-query-like-transformer.cjs')
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const createQueryClientTransformer = require('../../utils/transformers/query-client-transformer.cjs')
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const AlreadyHasPlaceholderDataProperty = require('./utils/already-has-placeholder-data-property.cjs')
 
 /**
diff --git a/packages/query-codemods/src/v5/remove-overloads/__tests__/remove-overloads.test.cjs b/packages/query-codemods/src/v5/remove-overloads/__tests__/remove-overloads.test.cjs
@@ -1,4 +1,3 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const defineTest = require('jscodeshift/dist/testUtils').defineTest
 
 defineTest(__dirname, 'remove-overloads.cjs', null, 'default-import', {
diff --git a/packages/query-codemods/src/v5/remove-overloads/remove-overloads.cjs b/packages/query-codemods/src/v5/remove-overloads/remove-overloads.cjs
@@ -1,8 +1,5 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const createUtilsObject = require('../../utils/index.cjs')
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const transformFilterAwareUsages = require('./transformers/filter-aware-usage-transformer.cjs')
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const transformQueryFnAwareUsages = require('./transformers/query-fn-aware-usage-transformer.cjs')
 
 module.exports = (file, api) => {
diff --git a/packages/query-codemods/src/v5/remove-overloads/transformers/filter-aware-usage-transformer.cjs b/packages/query-codemods/src/v5/remove-overloads/transformers/filter-aware-usage-transformer.cjs
@@ -1,12 +1,7 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const createV5UtilsObject = require('../utils/index.cjs')
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const UnknownUsageError = require('../utils/unknown-usage-error.cjs')
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const createQueryClientTransformer = require('../../../utils/transformers/query-client-transformer.cjs')
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const createQueryCacheTransformer = require('../../../utils/transformers/query-cache-transformer.cjs')
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const createUseQueryLikeTransformer = require('../../../utils/transformers/use-query-like-transformer.cjs')
 
 /**
diff --git a/packages/query-codemods/src/v5/remove-overloads/transformers/query-fn-aware-usage-transformer.cjs b/packages/query-codemods/src/v5/remove-overloads/transformers/query-fn-aware-usage-transformer.cjs
@@ -1,8 +1,5 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const createV5UtilsObject = require('../utils/index.cjs')
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const UnknownUsageError = require('../utils/unknown-usage-error.cjs')
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const createQueryClientTransformer = require('../../../utils/transformers/query-client-transformer.cjs')
 
 /**
diff --git a/packages/query-codemods/src/v5/remove-overloads/utils/index.cjs b/packages/query-codemods/src/v5/remove-overloads/utils/index.cjs
@@ -1,4 +1,3 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const UnknownUsageError = require('./unknown-usage-error.cjs')
 
 module.exports = ({ jscodeshift, utils }) => {
diff --git a/packages/query-codemods/src/v5/rename-hydrate/__tests__/rename-hydrate.test.cjs b/packages/query-codemods/src/v5/rename-hydrate/__tests__/rename-hydrate.test.cjs
@@ -1,4 +1,3 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const defineTest = require('jscodeshift/dist/testUtils').defineTest
 
 defineTest(__dirname, 'rename-hydrate.cjs', null, 'default-import', {
diff --git a/packages/query-codemods/src/v5/rename-properties/__tests__/rename-properties.test.cjs b/packages/query-codemods/src/v5/rename-properties/__tests__/rename-properties.test.cjs
@@ -1,4 +1,3 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const defineTest = require('jscodeshift/dist/testUtils').defineTest
 
 defineTest(__dirname, 'rename-properties.cjs', null, 'rename-cache-time', {
diff --git a/packages/query-core/src/focusManager.ts b/packages/query-core/src/focusManager.ts
@@ -17,7 +17,7 @@ export class FocusManager extends Subscribable<Listener> {
     super()
     this.#setup = (onFocus) => {
       // addEventListener does not exist in React Native, but window does
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+      // eslint-disable-next-line ts/no-unnecessary-condition
       if (!isServer && window.addEventListener) {
         const listener = () => onFocus()
         // Listen to visibilitychange
@@ -78,7 +78,7 @@ export class FocusManager extends Subscribable<Listener> {
     }
 
     // document global can be unavailable in react native
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    // eslint-disable-next-line ts/no-unnecessary-condition
     return globalThis.document?.visibilityState !== 'hidden'
   }
 }
diff --git a/packages/query-core/src/hydration.ts b/packages/query-core/src/hydration.ts
@@ -130,9 +130,9 @@ export function hydrate(
   const mutationCache = client.getMutationCache()
   const queryCache = client.getQueryCache()
 
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  // eslint-disable-next-line ts/no-unnecessary-condition
   const mutations = (dehydratedState as DehydratedState).mutations || []
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  // eslint-disable-next-line ts/no-unnecessary-condition
   const queries = (dehydratedState as DehydratedState).queries || []
 
   mutations.forEach(({ state, ...mutationOptions }) => {
diff --git a/packages/query-core/src/onlineManager.ts b/packages/query-core/src/onlineManager.ts
@@ -14,7 +14,7 @@ export class OnlineManager extends Subscribable<Listener> {
     super()
     this.#setup = (onOnline) => {
       // addEventListener does not exist in React Native, but window does
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+      // eslint-disable-next-line ts/no-unnecessary-condition
       if (!isServer && window.addEventListener) {
         const onlineListener = () => onOnline(true)
         const offlineListener = () => onOnline(false)
diff --git a/packages/query-core/src/queryClient.ts b/packages/query-core/src/queryClient.ts
@@ -13,10 +13,10 @@ import { focusManager } from './focusManager'
 import { onlineManager } from './onlineManager'
 import { notifyManager } from './notifyManager'
 import { infiniteQueryBehavior } from './infiniteQueryBehavior'
-import type { DataTag, NoInfer, OmitKeyof } from './types'
 import type { QueryState } from './query'
 import type {
   CancelOptions,
+  DataTag,
   DefaultError,
   DefaultOptions,
   DefaultedQueryObserverOptions,
@@ -29,6 +29,8 @@ import type {
   MutationKey,
   MutationObserverOptions,
   MutationOptions,
+  NoInfer,
+  OmitKeyof,
   QueryClientConfig,
   QueryKey,
   QueryObserverOptions,
diff --git a/packages/query-devtools/src/__tests__/utils.test.ts b/packages/query-devtools/src/__tests__/utils.test.ts
@@ -91,7 +91,7 @@ describe('Utils tests', () => {
           ['fr', 'bonjour'],
         ])
 
-        /* eslint-disable @cspell/spellchecker */
+        /* eslint-disable cspell/spellchecker */
         const newData = updateNestedDataByPath(oldData, ['fr'], 'salut')
 
         expect(newData).not.toBe(oldData) // should not be the same reference
@@ -114,7 +114,7 @@ describe('Utils tests', () => {
 
     describe('nested data', () => {
       it('should update data correctly', async () => {
-        /* eslint-disable @cspell/spellchecker */
+        /* eslint-disable cspell/spellchecker */
         const oldData = new Map([
           [
             'pumpkin-pie',
@@ -473,7 +473,7 @@ describe('Utils tests', () => {
 
     describe('nested data', () => {
       it('should delete nested items correctly', async () => {
-        /* eslint-disable @cspell/spellchecker */
+        /* eslint-disable cspell/spellchecker */
         const oldData = new Map([
           [
             'pumpkin-pie',
diff --git a/packages/query-persist-client-core/src/createPersister.ts b/packages/query-persist-client-core/src/createPersister.ts
@@ -1,7 +1,7 @@
 import { matchQuery } from '@tanstack/query-core'
-import type { QueryFilters } from '@tanstack/query-core'
 import type {
   Query,
+  QueryFilters,
   QueryFunctionContext,
   QueryKey,
   QueryState,
diff --git a/packages/react-query/eslint.config.js b/packages/react-query/eslint.config.js
@@ -28,7 +28,7 @@ export default [
   {
     files: ['**/__tests__/**'],
     rules: {
-      '@typescript-eslint/no-unnecessary-condition': 'off',
+      'ts/no-unnecessary-condition': 'off',
       'react-compiler/react-compiler': 'off',
     },
   },
diff --git a/packages/react-query/src/HydrationBoundary.tsx b/packages/react-query/src/HydrationBoundary.tsx
@@ -58,7 +58,7 @@ export const HydrationBoundary = ({
       }
 
       const queryCache = client.getQueryCache()
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+      // eslint-disable-next-line ts/no-unnecessary-condition
       const queries = (state as DehydratedState).queries || []
 
       const newQueries: DehydratedState['queries'] = []
diff --git a/packages/react-query/src/__tests__/HydrationBoundary.test.tsx b/packages/react-query/src/__tests__/HydrationBoundary.test.tsx
@@ -1,9 +1,8 @@
-import { beforeAll, describe, expect, test } from 'vitest'
+import { beforeAll, describe, expect, test, vi } from 'vitest'
 import * as React from 'react'
 import { render } from '@testing-library/react'
 
 import * as coreModule from '@tanstack/query-core'
-import { vi } from 'vitest'
 import {
   HydrationBoundary,
   QueryCache,
diff --git a/packages/react-query/src/__tests__/QueryClientProvider.test.tsx b/packages/react-query/src/__tests__/QueryClientProvider.test.tsx
@@ -1,7 +1,5 @@
-import { describe, expect, test } from 'vitest'
+import { describe, expect, test, vi } from 'vitest'
 import { render, waitFor } from '@testing-library/react'
-
-import { vi } from 'vitest'
 import { QueryCache, QueryClientProvider, useQuery, useQueryClient } from '..'
 import { createQueryClient, queryKey, sleep } from './utils'
 
diff --git a/packages/react-query/src/__tests__/QueryResetErrorBoundary.test.tsx b/packages/react-query/src/__tests__/QueryResetErrorBoundary.test.tsx
@@ -1,9 +1,8 @@
-import { describe, expect, it } from 'vitest'
+import { describe, expect, it, vi } from 'vitest'
 import { fireEvent, waitFor } from '@testing-library/react'
 import { ErrorBoundary } from 'react-error-boundary'
 import * as React from 'react'
 
-import { vi } from 'vitest'
 import {
   QueryCache,
   QueryErrorResetBoundary,
diff --git a/packages/react-query/src/infiniteQueryOptions.ts b/packages/react-query/src/infiniteQueryOptions.ts
diff --git a/packages/react-query/src/suspense.ts b/packages/react-query/src/suspense.ts
diff --git a/packages/react-query/src/useSuspenseInfiniteQuery.ts b/packages/react-query/src/useSuspenseInfiniteQuery.ts
diff --git a/packages/solid-query/src/__tests__/createInfiniteQuery.test.tsx b/packages/solid-query/src/__tests__/createInfiniteQuery.test.tsx
diff --git a/packages/solid-query/src/__tests__/createQuery.test.tsx b/packages/solid-query/src/__tests__/createQuery.test.tsx
diff --git a/packages/solid-query/src/__tests__/suspense.test.tsx b/packages/solid-query/src/__tests__/suspense.test.tsx
diff --git a/packages/svelte-query-devtools/eslint.config.js b/packages/svelte-query-devtools/eslint.config.js
diff --git a/packages/svelte-query-persist-client/eslint.config.js b/packages/svelte-query-persist-client/eslint.config.js
diff --git a/packages/svelte-query/eslint.config.js b/packages/svelte-query/eslint.config.js
diff --git a/packages/vue-query-devtools/eslint.config.js b/packages/vue-query-devtools/eslint.config.js
diff --git a/packages/vue-query/eslint.config.js b/packages/vue-query/eslint.config.js
diff --git a/packages/vue-query/src/infiniteQueryOptions.ts b/packages/vue-query/src/infiniteQueryOptions.ts
diff --git a/packages/vue-query/src/queryClient.ts b/packages/vue-query/src/queryClient.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/* eslint-disable @cspell/spellchecker */`
	`1`	`+/* eslint-disable cspell/spellchecker */`
`2`	`2`	`/**`
`3`	`3`	`* The code in this file is adapted from NG Extension Platform at https://ngxtension.netlify.app.`
`4`	`4`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-// eslint-disable-next-line @typescript-eslint/no-var-requires`
`2`	`1`	`const defineTest = require('jscodeshift/dist/testUtils').defineTest`
`3`	`2`
`4`	`3`	`defineTest(__dirname, 'key-transformation.cjs', null, 'default-import', {`