Framework
Version

ESLint Plugin Query

TanStack Query wird mit seinem eigenen ESLint-Plugin geliefert. Dieses Plugin wird verwendet, um Best Practices durchzusetzen und Ihnen zu helfen, häufige Fehler zu vermeiden.

Installation

Das Plugin ist ein separates Paket, das Sie installieren müssen

bash
npm i -D @tanstack/eslint-plugin-query
npm i -D @tanstack/eslint-plugin-query

oder

bash
pnpm add -D @tanstack/eslint-plugin-query
pnpm add -D @tanstack/eslint-plugin-query

oder

bash
yarn add -D @tanstack/eslint-plugin-query
yarn add -D @tanstack/eslint-plugin-query

oder

bash
bun add -D @tanstack/eslint-plugin-query
bun add -D @tanstack/eslint-plugin-query

Flat Config (eslint.config.js)

Um alle empfohlenen Regeln für unser Plugin zu aktivieren, fügen Sie die folgende Konfiguration hinzu

js
import pluginQuery from '@tanstack/eslint-plugin-query'

export default [
  ...pluginQuery.configs['flat/recommended'],
  // Any other config...
]
import pluginQuery from '@tanstack/eslint-plugin-query'

export default [
  ...pluginQuery.configs['flat/recommended'],
  // Any other config...
]

Benutzerdefinierte Einrichtung

Alternativ können Sie das Plugin laden und nur die Regeln konfigurieren, die Sie verwenden möchten

js
import pluginQuery from '@tanstack/eslint-plugin-query'

export default [
  {
    plugins: {
      '@tanstack/query': pluginQuery,
    },
    rules: {
      '@tanstack/query/exhaustive-deps': 'error',
    },
  },
  // Any other config...
]
import pluginQuery from '@tanstack/eslint-plugin-query'

export default [
  {
    plugins: {
      '@tanstack/query': pluginQuery,
    },
    rules: {
      '@tanstack/query/exhaustive-deps': 'error',
    },
  },
  // Any other config...
]

Legacy Config (.eslintrc)

Um alle empfohlenen Regeln für unser Plugin zu aktivieren, fügen Sie plugin:@tanstack/query/recommended in extends hinzu

json
{
  "extends": ["plugin:@tanstack/query/recommended"]
}
{
  "extends": ["plugin:@tanstack/query/recommended"]
}

Benutzerdefinierte Einrichtung

Alternativ fügen Sie @tanstack/query zum plugins-Abschnitt hinzu und konfigurieren die Regeln, die Sie verwenden möchten

json
{
  "plugins": ["@tanstack/query"],
  "rules": {
    "@tanstack/query/exhaustive-deps": "error"
  }
}
{
  "plugins": ["@tanstack/query"],
  "rules": {
    "@tanstack/query/exhaustive-deps": "error"
  }
}

Regeln