refactor: Sort imports with eslint (#5634)

Author: lachlancollins

.eslintrc.cjs

@@ -5,6 +5,7 @@ const config = {
   extends: [
     'plugin:@typescript-eslint/eslint-recommended',
     'plugin:@typescript-eslint/recommended',
+    'plugin:import/recommended',
     'plugin:import/typescript',
     'prettier',
   ],
@@ -41,15 +42,38 @@ const config = {
     '@typescript-eslint/no-explicit-any': 'off',
     '@typescript-eslint/no-non-null-assertion': 'off',
     '@typescript-eslint/no-unnecessary-condition': 'error',
+    '@typescript-eslint/no-unused-vars': 'off',
     '@typescript-eslint/no-inferrable-types': [
       'error',
       { ignoreParameters: true },
     ],
+    'import/default': 'off',
+    'import/export': 'off',
+    'import/namespace': 'off',
+    'import/newline-after-import': 'error',
     'import/no-cycle': 'error',
+    'import/no-duplicates': 'off',
+    'import/no-named-as-default-member': 'off',
     'import/no-unresolved': ['error', { ignore: ['^@tanstack/'] }],
     'import/no-unused-modules': ['off', { unusedExports: true }],
+    'import/order': [
+      'error',
+      {
+        groups: [
+          'builtin',
+          'external',
+          'internal',
+          'parent',
+          'sibling',
+          'index',
+          'object',
+          'type',
+        ],
+      },
+    ],
     'no-redeclare': 'off',
     'no-shadow': 'error',
+    'sort-imports': ['error', { ignoreDeclarationSort: true }],
   },
   overrides: [
     {

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

@@ -1,5 +1,5 @@
-import type { TSESLint } from '@typescript-eslint/utils'
 import { rules } from '../rules'
+import type { TSESLint } from '@typescript-eslint/utils'
 
 function generateRecommendedConfig(
   allRules: Record<string, TSESLint.RuleModule<any, any>>,

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

@@ -1,9 +1,9 @@
-import type { TSESLint } from '@typescript-eslint/utils'
 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 { ExhaustiveDepsUtils } from './exhaustive-deps.utils'
+import type { TSESLint } from '@typescript-eslint/utils'
 
 const QUERY_KEY = 'queryKey'
 const QUERY_FN = 'queryFn'

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

@@ -1,6 +1,6 @@
-import type { TSESLint } from '@typescript-eslint/utils'
 import { AST_NODE_TYPES } from '@typescript-eslint/utils'
 import { ASTUtils } from '../../utils/ast-utils'
+import type { TSESLint } from '@typescript-eslint/utils'
 
 export const ExhaustiveDepsUtils = {
   isRelevantReference(params: {

packages/eslint-plugin-query/src/rules/prefer-query-object-syntax/prefer-query-object-syntax.test.ts

@@ -1,6 +1,6 @@
-import { rule, name } from './prefer-query-object-syntax'
-import { normalizeIndent } from '../../utils/test-utils'
 import { ESLintUtils } from '@typescript-eslint/utils'
+import { normalizeIndent } from '../../utils/test-utils'
+import { name, rule } from './prefer-query-object-syntax'
 
 const ruleTester = new ESLintUtils.RuleTester({
   parser: '@typescript-eslint/parser',

packages/eslint-plugin-query/src/rules/prefer-query-object-syntax/prefer-query-object-syntax.ts

@@ -1,8 +1,8 @@
-import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
 import { AST_NODE_TYPES } from '@typescript-eslint/utils'
 import { createRule } from '../../utils/create-rule'
 import { ASTUtils } from '../../utils/ast-utils'
 import { objectKeys } from '../../utils/object-utils'
+import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
 
 const QUERY_CALLS = {
   useQuery: { key: 'queryKey', fn: 'queryFn', type: 'query' },

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

@@ -1,8 +1,8 @@
+import { AST_NODE_TYPES } from '@typescript-eslint/utils'
+import { uniqueBy } from './unique-by'
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
 import type TSESLintScopeManager from '@typescript-eslint/scope-manager'
-import { AST_NODE_TYPES } from '@typescript-eslint/utils'
 import type { RuleContext } from '@typescript-eslint/utils/dist/ts-eslint'
-import { uniqueBy } from './unique-by'
 
 export const ASTUtils = {
   isNodeOfOneOf<T extends AST_NODE_TYPES>(

packages/eslint-plugin-query/src/utils/create-rule.ts

@@ -1,6 +1,6 @@
 import { ESLintUtils } from '@typescript-eslint/utils'
-import type { EnhancedCreate } from './detect-react-query-imports'
 import { detectTanstackQueryImports } from './detect-react-query-imports'
+import type { EnhancedCreate } from './detect-react-query-imports'
 
 const getDocsUrl = (ruleName: string): string =>
   `https://tanstack.com/query/v4/docs/eslint/${ruleName}`

packages/query-async-storage-persister/src/index.ts

@@ -1,9 +1,9 @@
+import { asyncThrottle } from './asyncThrottle'
 import type {
   PersistedClient,
   Persister,
   Promisable,
 } from '@tanstack/query-persist-client-core'
-import { asyncThrottle } from './asyncThrottle'
 
 interface AsyncStorage {
   getItem: (key: string) => Promise<string | null>

packages/query-core/src/infiniteQueryObserver.ts

@@ -1,3 +1,9 @@
+import { QueryObserver } from './queryObserver'
+import {
+  hasNextPage,
+  hasPreviousPage,
+  infiniteQueryBehavior,
+} from './infiniteQueryBehavior'
 import type {
   DefaultedInfiniteQueryObserverOptions,
   FetchNextPageOptions,
@@ -9,12 +15,6 @@ import type {
 } from './types'
 import type { QueryClient } from './queryClient'
 import type { NotifyOptions, ObserverFetchOptions } from './queryObserver'
-import { QueryObserver } from './queryObserver'
-import {
-  hasNextPage,
-  hasPreviousPage,
-  infiniteQueryBehavior,
-} from './infiniteQueryBehavior'
 import type { Query } from './query'
 
 type InfiniteQueryObserverListener<TData, TError> = (