feat: add require-query-options rule

Author: danielpza

.prettierignore

@@ -0,0 +1 @@
+/docs/rules

README.md

@@ -0,0 +1,16 @@
+# eslint-plugin-react-query-options
+
+Eslint plugin for tanstack query to enforce using the `queryOptions` api inspired by [this post](https://tkdodo.eu/blog/the-query-options-api) from TkDodo
+
+<!-- prettier-ignore-start -->
+<!-- begin auto-generated rules list -->
+
+💼 Configurations enabled in.\
+✅ Set in the `recommended` configuration.
+
+| Name                                                         | Description                                                         | 💼 |
+| :----------------------------------------------------------- | :------------------------------------------------------------------ | :- |
+| [require-query-options](docs/rules/require-query-options.md) | Enforce use*Query functions are called with a queryOptions pattern. | ✅  |
+
+<!-- end auto-generated rules list -->
+<!-- prettier-ignore-end -->

docs/rules/require-query-options.md

@@ -0,0 +1,43 @@
+# Enforce use*Query functions are called with a queryOptions pattern (`react-query-options/require-query-options`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
+
+Enforces useQuery (and family) hooks use some form of query constructor pattern. Will error if queryKey or queryFn properties are passed to the hook
+
+## Fail
+
+```js
+useQuery({
+  queryKey: [/**/],
+  /* additional properties */
+})
+
+useQuery({
+  queryFn: () => { /**/ }
+  /* additional properties */
+})
+```
+
+## Pass
+
+```js
+const query = {
+  queryKey: [/**/],
+  queryFn: () => { /**/ }
+}
+
+const queryBuilder = () => ({
+  queryKey: [/**/],
+  queryFn: () => { /**/ }
+})
+
+useQuery(query)
+useQuery(queryBuilder())
+useQuery({
+  ...queryBuilder(),
+  /* additional properties */
+  select: (data) => data
+})
+```

package.json

@@ -4,11 +4,15 @@
   "type": "module",
   "exports": "./dist/index.js",
   "scripts": {
-    "build": "tsc",
+    "build": "tsdown --clean --dts",
+    "test": "tsx --test",
+    "eslint-docs:update": "eslint-doc-generator",
+    "eslint-docs:lint": "eslint-doc-generator --check",
     "prepare": "node --run build"
   },
   "keywords": [
     "eslint",
+    "eslintplugin",
     "eslint-plugin",
     "query",
     "react-query",
@@ -20,9 +24,21 @@
   },
   "license": "MIT",
   "packageManager": "[email protected]+sha512.0e155aa2629db8672b49e8475da6226aa4bdea85fdcdfdc15350874946d4f3c91faaf64cbdc4a5d1ab8002f473d5c3fcedcd197989cf0390f9badd3c04678706",
+  "dependencies": {
+    "@typescript-eslint/utils": "^8.44.0"
+  },
   "devDependencies": {
     "@tsconfig/node-lts": "^22.0.2",
+    "@types/node": "^24.5.1",
+    "@typescript-eslint/rule-tester": "^8.44.0",
+    "eslint": "^9.35.0",
+    "eslint-doc-generator": "^2.2.2",
     "prettier": "^3.6.2",
+    "tsdown": "^0.15.2",
+    "tsx": "^4.20.5",
     "typescript": "^5.9.2"
+  },
+  "peerDependencies": {
+    "eslint": ">=9.0.0"
   }
 }