框架
版本

ESLint 插件 Query

TanStack Query 自带 ESLint 插件。此插件用于强制执行最佳实践,并帮助您避免常见错误。

安装

该插件是一个独立的包,您需要安装它

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

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

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

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

Flat Config (eslint.config.js)

要启用我们插件的所有推荐规则,请添加以下配置

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...
]

自定义设置

或者,您可以加载插件并仅配置您想要使用的规则

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)

要启用我们插件的所有推荐规则,请在 extends 中添加 plugin:@tanstack/query/recommended

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

自定义设置

或者,将 @tanstack/query 添加到 plugins 部分,并配置您想要使用的规则

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

规则