@bastidood/eslint-config-tanstack-query 0.0.0-stage → 0.6.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Basti Ortiz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,39 @@
-# Temporary Holding Version
+# `@bastidood/eslint-config-tanstack-query`
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+TanStack Query entries for `@bastidood/eslint-config`, including the rules of `@tanstack/eslint-plugin-query`.
+
+## Installation
+
+```sh
+pnpm add --save-dev @bastidood/eslint-config @bastidood/eslint-config-svelte @bastidood/eslint-config-tanstack-query eslint svelte typescript
+```
+
+## Configuration
+
+```ts
+// eslint.config.ts
+import { compose } from '@bastidood/eslint-config';
+import { SVELTE } from '@bastidood/eslint-config-svelte';
+import { TANSTACK_SVELTE_QUERY } from '@bastidood/eslint-config-tanstack-query/svelte';
+import { CORE } from '@bastidood/eslint-config/core';
+import { TANSTACK_QUERY } from '@bastidood/eslint-config/tanstack/query';
+import { defineConfig } from 'eslint/config';
+
+export default defineConfig(
+	{ files: ['**/*.ts'] },
+	compose(CORE, SVELTE, TANSTACK_QUERY, TANSTACK_SVELTE_QUERY),
+);
+```
+
+List `TANSTACK_SVELTE_QUERY` after `SVELTE`, whose parser its template selectors need.
+
+## Entry Points
+
+| Entry point                                      | Contents                                                                                                                                                                                                                                          |
+| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `@bastidood/eslint-config-tanstack-query/svelte` | Enables `exhaustive-deps`, `infinite-query-property-order`, and `no-void-query-fn` from `@tanstack/eslint-plugin-query`; bans `useQueryClient`, destructuring query results, inline `queryFn` in `createQuery`, and `use:enhance` with `onsubmit` |
+
+## Limitations
+
+- Rules are not configurable.
+- `exhaustive-deps` does not check the top-level script of `.svelte` components.

package/dist/svelte.d.mts

@@ -0,0 +1,3 @@
+import { Entry } from "@bastidood/eslint-config";
+/** TanStack Svelte Query rules. Compose after `SVELTE`, whose parser the template selectors need. */
+export declare const TANSTACK_SVELTE_QUERY: Entry;

package/dist/svelte.mjs

@@ -0,0 +1,35 @@
+import tanstackQueryPlugin from "@tanstack/eslint-plugin-query";
+/** TanStack Svelte Query rules. Compose after `SVELTE`, whose parser the template selectors need. */
+const TANSTACK_SVELTE_QUERY = {
+	configs: [{
+		name: "@bastidood/eslint-config-tanstack-query/svelte",
+		plugins: { "@tanstack/query": tanstackQueryPlugin },
+		rules: {
+			"@tanstack/query/exhaustive-deps": "error",
+			"@tanstack/query/infinite-query-property-order": "error",
+			"@tanstack/query/no-void-query-fn": "error"
+		}
+	}],
+	restrictions: {
+		importPaths: [{
+			name: "@tanstack/svelte-query",
+			importNames: ["useQueryClient"],
+			message: "Obtain the `QueryClient` from the query or mutation callback context instead of capturing `useQueryClient` in a closure. Suppress this only to call `prefetchQuery` on hover or `ensureQueryData` in an event handler, and name that use in the suppression reason."
+		}],
+		syntax: [
+			{
+				selector: "VariableDeclarator[id.type=\"ObjectPattern\"][init.callee.name=/^create(?:Query|InfiniteQuery|Mutation|Queries)$/]",
+				message: "Read fields from the result object, such as `query.data`. The result is a reactive proxy, so destructuring copies its current values and stops updates."
+			},
+			{
+				selector: "CallExpression[callee.name=/^create(?:Infinite)?Query$/] > :function > ObjectExpression > Property[key.name=\"queryFn\"], CallExpression[callee.name=/^create(?:Infinite)?Query$/] > :function > BlockStatement ReturnStatement > ObjectExpression > Property[key.name=\"queryFn\"]",
+				message: "Define `queryKey` and `queryFn` together in a `queryOptions()` factory and pass its result, such as `createQuery(() => jobQueries.detail(id))`."
+			},
+			{
+				selector: "SvelteDirective[kind=\"Action\"][key.name.name=\"enhance\"] ~ SvelteAttribute[key.name=\"onsubmit\"], SvelteAttribute[key.name=\"onsubmit\"] ~ SvelteDirective[kind=\"Action\"][key.name.name=\"enhance\"]",
+				message: "Choose one submission lifecycle for this form: `use:enhance` with a SvelteKit form action, or an `onsubmit` handler that calls a TanStack mutation. With both, one submit runs both."
+			}
+		]
+	}
+};
+export { TANSTACK_SVELTE_QUERY };

package/package.json

@@ -1,6 +1,42 @@
 {
   "name": "@bastidood/eslint-config-tanstack-query",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.6.1",
+  "description": "TanStack Query rules for @bastidood/eslint-config, including @tanstack/eslint-plugin-query.",
+  "license": "MIT",
+  "homepage": "https://github.com/BastiDood/slopstopper",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/BastiDood/slopstopper.git",
+    "directory": "configs/eslint-tanstack-query"
+  },
+  "type": "module",
+  "exports": {
+    "./svelte": "./dist/svelte.mjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@tanstack/eslint-plugin-query": "^5.106.1"
+  },
+  "devDependencies": {
+    "@bastidood/eslint-config": "0.6.1",
+    "@bastidood/tsconfig": "0.1.1",
+    "@typescript/native": "npm:typescript@^7.0.2",
+    "eslint": "^10.14.0",
+    "tsdown": "0.23.5",
+    "typescript": "npm:@typescript/typescript6@^6.0.2"
+  },
+  "peerDependencies": {
+    "@bastidood/eslint-config": "^0.6.1",
+    "@bastidood/eslint-config-svelte": "^0.6.1",
+    "eslint": "^10.0.0",
+    "typescript": ">=4.8.4 <6.1.0"
+  },
+  "scripts": {
+    "check": "tsc"
+  }
 }