Community ESLint rules for React Query.
Install the plugin:
npm install --save-dev eslint-plugin-react-query
Add react-query
to plugins
field in your .eslintrc
configuration file:
{
"plugins": ["react-query"],
"rules": {
"react-query/rule-name": "error"
}
}
You can also use recommended rules with this plugin:
{
"extends": ["plugin:react-query/recommended"]
}
Key: ✅ = recommended, 🔧 = fixable
Name | Description | ✅ | 🔧 |
---|---|---|---|
mutation-key |
Enforce mutationKey to be present in useMutation call | ✅ | |
query-key |
Enforce queryKey to be present in useQuery object syntax | ✅ |
Big thanks to Testing Library team for the code inspiration.