eslint-plugin-react-query
v1.3.0
Published
ESLint rules for React Query
Downloads
5,431
Readme
Quick Start
Installation
Install the plugin:
npm install --save-dev eslint-plugin-react-query
Usage
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"]
}
Supported Rules
Key: ✅ = recommended, 🔧 = fixable
| Name | Description | ✅ | 🔧 |
| ------------------------------------------------------------------------ | -------------------------------------------------------- | --- | --- |
| mutation-key
| Enforce mutationKey to be present in useMutation call | ✅ | |
| prefer-query-object-syntax
| Prefer object syntax for useQuery | ✅ | 🔧 |
| query-key
| Enforce queryKey to be present in useQuery object syntax | ✅ | |
Contributing
Check out CONTRIBUTING.md for information on how to contribute to the project.
Attributions
Big thanks to Testing Library team for the code inspiration.