ESLint

Purpose#

This package unifies the shared ESLint config used across all TanStack projects. It is designed to be framework-agnostic, and does not include any framework-specific plugins.

Installation#

To install the package, run the following command:

pnpm add -D @tanstack/eslint-config

Setup#

package.json#

• Make sure you have ESLint v9+ installed

eslint.config.js#

import { tanstackConfig } from '@tanstack/eslint-config'

export default [
  ...tanstackConfig,
  {
    // Custom rules go here
  },
]

Plugins#

• @eslint/js - The core ESLint rules
• typescript-eslint - Enables TypeScript support
• eslint-plugin-import-x - Lints imports and exports
• eslint-plugin-n - Useful rules for Node.js

Rules#

You can inspect the enabled rules by running pnpm dlx @eslint/config-inspector, or by browsing the source here. Each rule has a comment explaining why it is included in the shared config.