TanStack Query comes with its own ESLint plugin. This plugin is used to enforce best practices and to help you avoid common mistakes.
The plugin is a separate package that you need to install:
npm i -D @tanstack/eslint-plugin-query
or
pnpm add -D @tanstack/eslint-plugin-query
or
yarn add -D @tanstack/eslint-plugin-query
or
bun add -D @tanstack/eslint-plugin-query
eslint.config.js
)To enable all of the recommended rules for our plugin, add the following config:
import pluginQuery from '@tanstack/eslint-plugin-query'
export default [ ...pluginQuery.configs['flat/recommended'], // Any other config...]
Alternatively, you can load the plugin and configure only the rules you want to use:
import pluginQuery from '@tanstack/eslint-plugin-query'
export default [ { plugins: { '@tanstack/query': pluginQuery, }, rules: { '@tanstack/query/exhaustive-deps': 'error', }, }, // Any other config...]
.eslintrc
)To enable all of the recommended rules for our plugin, add plugin:@tanstack/query/recommended
in extends:
{ "extends": ["plugin:@tanstack/query/recommended"]}
Alternatively, add @tanstack/query
to the plugins section, and configure the rules you want to use:
{ "plugins": ["@tanstack/query"], "rules": { "@tanstack/query/exhaustive-deps": "error" }}
“This course is the best way to learn how to use React Query in real-world applications.”—Tanner LinsleyCheck it out