chore: Migrate to ESLint flat config (#1846)

* chore: Migrate to ESLint flat config * Add knip.json
TanStack · Jun 28, 2024 · 4310311 · 4310311
1 parent 7d8d3e0
commit 4310311
Show file tree

Hide file tree

Showing 61 changed files with 871 additions and 546 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
diff --git a/eslint.config.js b/eslint.config.js
@@ -0,0 +1,17 @@
+// @ts-check
+
+// @ts-ignore Needed due to moduleResolution Node vs Bundler
+import { tanstackConfig } from '@tanstack/config/eslint'
+
+export default [
+  ...tanstackConfig,
+  {
+    name: 'tanstack/local',
+    rules: {
+      'ts/ban-types': 'off',
+      'ts/require-await': 'off',
+      'no-empty': 'off',
+      'no-prototype-builtins': 'off',
+    },
+  },
+]
diff --git a/examples/react/basic/src/main.tsx b/examples/react/basic/src/main.tsx
@@ -25,7 +25,7 @@ const fetchPosts = async () => {
   await new Promise((r) => setTimeout(r, 300))
   return (
     axios
-      /* eslint-disable-next-line @typescript-eslint/array-type */
+      /* eslint-disable-next-line ts/array-type */
       .get<PostType[]>('https://jsonplaceholder.typicode.com/posts')
       .then((r) => r.data.slice(0, 10))
   )

diff --git a/knip.json b/knip.json
@@ -0,0 +1,4 @@
+{
+  "$schema": "https://unpkg.com/knip@5/schema.json",
+  "ignoreWorkspaces": ["examples/**"]
+}
diff --git a/nx.json b/nx.json
@@ -6,8 +6,8 @@
   "parallel": 5,
   "namedInputs": {
     "sharedGlobals": [
-      "{workspaceRoot}/.eslintrc.cjs",
       "{workspaceRoot}/.nvmrc",
+      "{workspaceRoot}/eslint.config.js",
       "{workspaceRoot}/package.json",
       "{workspaceRoot}/tsconfig.json"
     ],
@@ -20,8 +20,7 @@
       "default",
       "{projectRoot}/build",
       "{projectRoot}/dist",
-      "!{projectRoot}/.eslintrc.cjs",
-      "!{projectRoot}/tsconfig.eslint.json"
+      "!{projectRoot}/eslint.config.js"
     ]
   },
   "targetDefaults": {

diff --git a/package.json b/package.json
@@ -37,19 +37,13 @@
   },
   "namespace": "@tanstack",
   "devDependencies": {
+    "@eslint-react/eslint-plugin": "^1.5.16",
     "@rollup/plugin-replace": "^5.0.7",
-    "@tanstack/config": "^0.7.11",
-    "@types/eslint": "^8.56.10",
+    "@tanstack/config": "^0.8.6",
     "@types/node": "^20.14.7",
     "@types/react": "^18.3.3",
     "@types/react-dom": "^18.3.0",
-    "@typescript-eslint/eslint-plugin": "^7.13.1",
-    "@typescript-eslint/parser": "^7.13.1",
-    "eslint": "^8.56.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-import-resolver-typescript": "^3.6.1",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-react": "^7.34.3",
+    "eslint": "^8.57.0",
     "eslint-plugin-react-hooks": "^4.6.2",
     "glob": "^10.4.2",
     "nx": "^19.3.0",
@@ -68,8 +62,6 @@
   },
   "pnpm": {
     "overrides": {
-      "@typescript-eslint/eslint-plugin": "$@typescript-eslint/eslint-plugin",
-      "@typescript-eslint/parser": "$@typescript-eslint/parser",
       "eslint": "$eslint",
       "use-sync-external-store": "1.2.0",
       "@tanstack/history": "workspace:*",

diff --git a/packages/history/.eslintrc.cjs b/packages/history/.eslintrc.cjs
diff --git a/packages/history/eslint.config.js b/packages/history/eslint.config.js
@@ -0,0 +1,5 @@
+// @ts-check
+
+import rootConfig from '../../eslint.config.js'
+
+export default [...rootConfig]
diff --git a/packages/history/package.json b/packages/history/package.json
@@ -34,7 +34,7 @@
   "sideEffects": false,
   "scripts": {
     "clean": "rimraf ./dist && rimraf ./coverage",
-    "test:eslint": "eslint --ext .ts,.tsx ./src",
+    "test:eslint": "eslint ./src",
     "test:types": "tsc --noEmit",
     "test:build": "publint --strict",
     "build": "vite build"

diff --git a/packages/history/src/index.ts b/packages/history/src/index.ts
@@ -47,7 +47,7 @@ const beforeUnloadEvent = 'beforeunload'
 
 const beforeUnloadListener = (event: Event) => {
   event.preventDefault()
-  // @ts-ignore
+  // @ts-expect-error
   return (event.returnValue = '')
 }
 

diff --git a/packages/history/vite.config.ts b/packages/history/vite.config.ts
@@ -1,11 +1,11 @@
 import { defineConfig, mergeConfig } from 'vitest/config'
-import { tanstackBuildConfig } from '@tanstack/config/build'
+import { tanstackViteConfig } from '@tanstack/config/vite'
 
 const config = defineConfig({})
 
 export default mergeConfig(
   config,
-  tanstackBuildConfig({
+  tanstackViteConfig({
     entry: './src/index.ts',
     srcDir: './src',
   }),

diff --git a/packages/react-cross-context/.eslintrc.cjs b/packages/react-cross-context/.eslintrc.cjs
diff --git a/packages/react-cross-context/eslint.config.js b/packages/react-cross-context/eslint.config.js
@@ -0,0 +1,5 @@
+// @ts-check
+
+import rootConfig from '../../eslint.config.js'
+
+export default [...rootConfig]
diff --git a/packages/react-cross-context/package.json b/packages/react-cross-context/package.json
@@ -34,7 +34,7 @@
   "sideEffects": false,
   "scripts": {
     "clean": "rimraf ./dist && rimraf ./coverage",
-    "test:eslint": "eslint --ext .ts,.tsx ./src",
+    "test:eslint": "eslint ./src",
     "test:types": "tsc --noEmit",
     "test:build": "publint --strict",
     "build": "vite build"

diff --git a/packages/react-cross-context/vite.config.ts b/packages/react-cross-context/vite.config.ts
@@ -1,5 +1,5 @@
 import { defineConfig, mergeConfig } from 'vitest/config'
-import { tanstackBuildConfig } from '@tanstack/config/build'
+import { tanstackViteConfig } from '@tanstack/config/vite'
 import react from '@vitejs/plugin-react'
 
 const config = defineConfig({
@@ -8,7 +8,7 @@ const config = defineConfig({
 
 export default mergeConfig(
   config,
-  tanstackBuildConfig({
+  tanstackViteConfig({
     entry: './src/index.ts',
     srcDir: './src',
   }),

diff --git a/packages/react-router/.eslintrc.cjs b/packages/react-router/.eslintrc.cjs
diff --git a/packages/react-router/eslint.config.js b/packages/react-router/eslint.config.js
@@ -0,0 +1,32 @@
+// @ts-check
+
+import pluginReact from '@eslint-react/eslint-plugin'
+// @ts-expect-error
+import pluginReactHooks from 'eslint-plugin-react-hooks'
+import rootConfig from '../../eslint.config.js'
+
+export default [
+  ...rootConfig,
+  {
+    files: ['**/*.{ts,tsx}'],
+    ...pluginReact.configs.recommended,
+  },
+  {
+    plugins: {
+      'react-hooks': pluginReactHooks,
+    },
+    rules: {
+      '@eslint-react/no-unstable-context-value': 'off',
+      '@eslint-react/no-unstable-default-props': 'off',
+      '@eslint-react/dom/no-missing-button-type': 'off',
+      'react-hooks/exhaustive-deps': 'error',
+      'react-hooks/rules-of-hooks': 'error',
+    },
+  },
+  {
+    files: ['**/__tests__/**'],
+    rules: {
+      'ts/no-unnecessary-condition': 'off',
+    },
+  },
+]
diff --git a/packages/react-router/package.json b/packages/react-router/package.json
@@ -34,7 +34,7 @@
   "sideEffects": false,
   "scripts": {
     "clean": "rimraf ./dist && rimraf ./coverage",
-    "test:eslint": "eslint --ext .ts,.tsx ./src",
+    "test:eslint": "eslint ./src",
     "test:types": "tsc --noEmit",
     "test:unit": "vitest --typecheck",
     "test:unit:dev": "pnpm run test:unit --watch",

diff --git a/packages/react-router/src/Matches.tsx b/packages/react-router/src/Matches.tsx
@@ -369,7 +369,7 @@ function MatchInner({ matchId }: { matchId: string }): any {
     throw match.loadPromise
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  // eslint-disable-next-line ts/no-unnecessary-condition
   if (match.status === 'success') {
     const Comp = route.options.component ?? router.options.defaultComponent
 

diff --git a/packages/react-router/src/RouterProvider.tsx b/packages/react-router/src/RouterProvider.tsx
@@ -1,4 +1,4 @@
-// eslint-disable-next-line @typescript-eslint/consistent-type-imports
+// eslint-disable-next-line ts/consistent-type-imports
 import * as React from 'react'
 import { Matches } from './Matches'
 import { getRouterContext } from './routerContext'

diff --git a/packages/react-router/src/defer.ts b/packages/react-router/src/defer.ts
@@ -34,7 +34,7 @@ export function defer<T>(
 ) {
   const promise = _promise as DeferredPromise<T>
 
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  // eslint-disable-next-line ts/no-unnecessary-condition
   if (!promise.__deferredState) {
     promise.__deferredState = {
       uid: Math.random().toString(36).slice(2),

diff --git a/packages/react-router/src/not-found.tsx b/packages/react-router/src/not-found.tsx
@@ -1,4 +1,4 @@
-// eslint-disable-next-line @typescript-eslint/consistent-type-imports
+// eslint-disable-next-line ts/consistent-type-imports
 import * as React from 'react'
 import { CatchBoundary } from './CatchBoundary'
 import { useRouterState } from './useRouterState'