eslint-plugin-react-query

1.3.0 • Public • Published

ESLint Plugin React Query

Community ESLint rules for React Query.

License MIT NPM Version NPM Downloads

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.

Readme

Keywords

none

Package Sidebar

Install

npm i eslint-plugin-react-query

Weekly Downloads

481

Version

1.3.0

License

MIT

Unpacked Size

21.7 kB

Total Files

15

Last publish

Collaborators

  • kubajastrz