Merge branch 'main' into svelte-5-adapter

lachlancollins · lachlancollins · commit c6d0b9220f1e · 2025-09-30T15:35:28.000+10:00
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -3,6 +3,8 @@ name: Release
 on:
   push:
     branches: [main, alpha, beta, rc, v4]
+  repository_dispatch:
+    types: [release]
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.number || github.ref }}
@@ -14,6 +16,7 @@ env:
 permissions:
   contents: write
   id-token: write
+  pull-requests: write
 
 jobs:
   release:
@@ -34,27 +37,37 @@ jobs:
       - name: Stop Nx Agents
         if: ${{ always() }}
         run: npx nx-cloud stop-all-agents
-      - name: Version Packages
-        run: pnpm run changeset:version
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: Commit version files
+      - name: Check for Changesets marked as major
+        id: major
         run: |
-          if [[ -n "$(git status --porcelain)" ]]; then
-            git config --global user.name 'Tanner Linsley'
-            git config --global user.email 'tannerlinsley@users.noreply.github.com'
-            git add -A
-            git commit -m "ci: Version Packages"
-            git push
-          fi
+          echo "found=false" >> $GITHUB_OUTPUT
+          regex="(major)"
+          shopt -s nullglob
+          for file in .changeset/*.md; do
+            if [[ $(cat $file) =~ $regex ]]; then
+              echo "found=true" >> $GITHUB_OUTPUT
+            fi
+          done
+      - name: Run Changesets (version or publish)
+        id: changesets
+        uses: changesets/action@v1.5.3
+        with:
+          version: pnpm run changeset:version
+          publish: pnpm run changeset:publish
+          commit: 'ci: Version Packages'
+          title: 'ci: Version Packages'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: Publish Packages
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Auto-merge Changesets PR
+        if: steps.changesets.outputs.hasChangesets == 'true' && steps.major.outputs.found == 'false'
         run: |
-          npm config set '//registry.npmjs.org/:_authToken' "${NPM_TOKEN}"
-          pnpm run changeset:publish
+          gh pr merge --squash "$PR_NUMBER"
+          gh api --method POST /repos/$REPO/dispatches -f 'event_type=release'
         env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          REPO: ${{ github.repository }}
+          PR_NUMBER: ${{ steps.changesets.outputs.pullRequestNumber }}
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v4.6.0
         with:
diff --git a/docs/eslint/eslint-plugin-query.md b/docs/eslint/eslint-plugin-query.md
@@ -99,3 +99,4 @@ Alternatively, add `@tanstack/query` to the plugins section, and configure the r
 - [@tanstack/query/no-unstable-deps](../no-unstable-deps.md)
 - [@tanstack/query/infinite-query-property-order](../infinite-query-property-order.md)
 - [@tanstack/query/no-void-query-fn](../no-void-query-fn.md)
+- [@tanstack/query/mutation-property-order](../mutation-property-order.md)
diff --git a/docs/eslint/mutation-property-order.md b/docs/eslint/mutation-property-order.md
@@ -0,0 +1,73 @@
+---
+id: mutation-property-order
+title: Ensure correct order of inference-sensitive properties in useMutation()
+---
+
+For the following functions, the property order of the passed in object matters due to type inference:
+
+- `useMutation()`
+
+The correct property order is as follows:
+
+- `onMutate`
+- `onError`
+- `onSettled`
+
+All other properties are insensitive to the order as they do not depend on type inference.
+
+## Rule Details
+
+Examples of **incorrect** code for this rule:
+
+```tsx
+/* eslint "@tanstack/query/mutation-property-order": "warn" */
+import { useMutation } from '@tanstack/react-query'
+
+const mutation = useMutation({
+  mutationFn: () => Promise.resolve('success'),
+  onSettled: () => {
+    results.push('onSettled-promise')
+    return Promise.resolve('also-ignored') // Promise<string> (should be ignored)
+  },
+  onMutate: async () => {
+    results.push('onMutate-async')
+    await sleep(1)
+    return { backup: 'async-data' }
+  },
+  onError: async () => {
+    results.push('onError-async-start')
+    await sleep(1)
+    results.push('onError-async-end')
+  },
+})
+```
+
+Examples of **correct** code for this rule:
+
+```tsx
+/* eslint "@tanstack/query/mutation-property-order": "warn" */
+import { useMutation } from '@tanstack/react-query'
+
+const mutation = useMutation({
+  mutationFn: () => Promise.resolve('success'),
+  onMutate: async () => {
+    results.push('onMutate-async')
+    await sleep(1)
+    return { backup: 'async-data' }
+  },
+  onError: async () => {
+    results.push('onError-async-start')
+    await sleep(1)
+    results.push('onError-async-end')
+  },
+  onSettled: () => {
+    results.push('onSettled-promise')
+    return Promise.resolve('also-ignored') // Promise<string> (should be ignored)
+  },
+})
+```
+
+## Attributes
+
+- [x] ✅ Recommended
+- [x] 🔧 Fixable
diff --git a/examples/react/algolia/package.json b/examples/react/algolia/package.json
@@ -15,7 +15,7 @@
     "react-dom": "^19.0.0"
   },
   "devDependencies": {
-    "@tanstack/eslint-plugin-query": "^5.90.2",
+    "@tanstack/eslint-plugin-query": "^5.91.0",
     "@types/react": "^18.2.79",
     "@types/react-dom": "^18.2.25",
     "@vitejs/plugin-react": "^4.3.4",
diff --git a/examples/react/basic/package.json b/examples/react/basic/package.json
@@ -17,7 +17,7 @@
     "react-dom": "^19.0.0"
   },
   "devDependencies": {
-    "@tanstack/eslint-plugin-query": "^5.90.2",
+    "@tanstack/eslint-plugin-query": "^5.91.0",
     "@types/react": "^18.2.79",
     "@types/react-dom": "^18.2.25",
     "@vitejs/plugin-react": "^4.3.4",
diff --git a/examples/react/eslint-legacy/package.json b/examples/react/eslint-legacy/package.json
@@ -17,7 +17,7 @@
     "react-dom": "^19.0.0"
   },
   "devDependencies": {
-    "@tanstack/eslint-plugin-query": "^5.90.2",
+    "@tanstack/eslint-plugin-query": "^5.91.0",
     "@types/react": "^18.2.79",
     "@types/react-dom": "^18.2.25",
     "@vitejs/plugin-react": "^4.3.4",
diff --git a/examples/solid/simple/package.json b/examples/solid/simple/package.json
@@ -13,7 +13,7 @@
     "solid-js": "^1.9.7"
   },
   "devDependencies": {
-    "@tanstack/eslint-plugin-query": "^5.90.2",
+    "@tanstack/eslint-plugin-query": "^5.91.0",
     "typescript": "5.8.3",
     "vite": "^6.3.6",
     "vite-plugin-solid": "^2.11.6"
diff --git a/package.json b/package.json
@@ -43,7 +43,7 @@
     "@arethetypeswrong/cli": "^0.15.3",
     "@changesets/cli": "^2.29.5",
     "@cspell/eslint-plugin": "^9.2.1",
-    "@eslint-react/eslint-plugin": "^1.53.1",
+    "@eslint-react/eslint-plugin": "^2.0.1",
     "@svitejs/changesets-changelog-github-compact": "^1.2.0",
     "@tanstack/config": "^0.20.2",
     "@testing-library/jest-dom": "^6.8.0",
diff --git a/packages/eslint-plugin-query/CHANGELOG.md b/packages/eslint-plugin-query/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @tanstack/eslint-plugin-query
 
+## 5.91.0
+
+### Minor Changes
+
+- feat: improve type of exported plugin ([#9700](https://github.com/TanStack/query/pull/9700))
+
 ## 5.90.2
 
 ### Patch Changes
diff --git a/packages/eslint-plugin-query/package.json b/packages/eslint-plugin-query/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/eslint-plugin-query",
-  "version": "5.90.2",
+  "version": "5.91.0",
   "description": "ESLint plugin for TanStack Query",
   "author": "Eliya Cohen",
   "license": "MIT",
@@ -59,11 +59,11 @@
     "!src/__tests__"
   ],
   "dependencies": {
-    "@typescript-eslint/utils": "^8.44.0"
+    "@typescript-eslint/utils": "^8.44.1"
   },
   "devDependencies": {
-    "@typescript-eslint/parser": "^8.44.0",
-    "@typescript-eslint/rule-tester": "^8.44.0",
+    "@typescript-eslint/parser": "^8.44.1",
+    "@typescript-eslint/rule-tester": "^8.44.1",
     "combinate": "^1.1.11",
     "eslint": "^9.36.0",
     "npm-run-all2": "^5.0.0"
diff --git a/packages/eslint-plugin-query/src/index.ts b/packages/eslint-plugin-query/src/index.ts
@@ -12,34 +12,13 @@ export interface Plugin extends Omit<ESLint.Plugin, 'rules'> {
   }
 }
 
-export const plugin: Plugin = {
+export const plugin = {
   meta: {
     name: '@tanstack/eslint-plugin-query',
   },
-  configs: {} as Plugin['configs'],
-  rules,
-}
-
-// Assign configs here so we can reference `plugin`
-Object.assign(plugin.configs, {
-  recommended: {
-    plugins: ['@tanstack/query'],
-    rules: {
-      '@tanstack/query/exhaustive-deps': 'error',
-      '@tanstack/query/no-rest-destructuring': 'warn',
-      '@tanstack/query/stable-query-client': 'error',
-      '@tanstack/query/no-unstable-deps': 'error',
-      '@tanstack/query/infinite-query-property-order': 'error',
-      '@tanstack/query/no-void-query-fn': 'error',
-      '@tanstack/query/mutation-property-order': 'error',
-    },
-  },
-  'flat/recommended': [
-    {
-      name: 'tanstack/query/flat/recommended',
-      plugins: {
-        '@tanstack/query': plugin,
-      },
+  configs: {
+    recommended: {
+      plugins: ['@tanstack/query'],
       rules: {
         '@tanstack/query/exhaustive-deps': 'error',
         '@tanstack/query/no-rest-destructuring': 'warn',
@@ -50,7 +29,27 @@ Object.assign(plugin.configs, {
         '@tanstack/query/mutation-property-order': 'error',
       },
     },
-  ],
-})
+    'flat/recommended': [
+      {
+        name: 'tanstack/query/flat/recommended',
+        plugins: {
+          '@tanstack/query': {}, // Assigned after plugin object created
+        },
+        rules: {
+          '@tanstack/query/exhaustive-deps': 'error',
+          '@tanstack/query/no-rest-destructuring': 'warn',
+          '@tanstack/query/stable-query-client': 'error',
+          '@tanstack/query/no-unstable-deps': 'error',
+          '@tanstack/query/infinite-query-property-order': 'error',
+          '@tanstack/query/no-void-query-fn': 'error',
+          '@tanstack/query/mutation-property-order': 'error',
+        },
+      },
+    ],
+  },
+  rules,
+} satisfies Plugin
+
+plugin.configs['flat/recommended'][0]!.plugins['@tanstack/query'] = plugin
 
 export default plugin
diff --git a/packages/svelte-query/tests/createInfiniteQuery/ChangeClient.svelte b/packages/svelte-query/tests/createInfiniteQuery/ChangeClient.svelte
@@ -0,0 +1,35 @@
+<script lang="ts">
+  import { QueryClient } from '@tanstack/query-core'
+  import { createInfiniteQuery } from '../../src/index.js'
+  import { sleep } from '@tanstack/query-test-utils'
+
+  let { queryClient }: { queryClient: QueryClient } = $props()
+
+  const queryKey = ['test']
+
+  let firstPage = $state(0)
+
+  const query = createInfiniteQuery(
+    () => ({
+      queryKey: queryKey,
+      queryFn: ({ pageParam }) => sleep(10).then(() => pageParam),
+      getNextPageParam: (lastPage) => lastPage + 1,
+      initialPageParam: firstPage,
+    }),
+    () => queryClient,
+  )
+</script>
+
+<button
+  onclick={() => {
+    queryClient.setQueryData(queryKey, {
+      pages: [7, 8],
+      pageParams: [7, 8],
+    })
+    firstPage = 7
+  }}
+>
+  setPages
+</button>
+
+<div>Data: {JSON.stringify(query.data)}</div>
diff --git a/packages/svelte-query/tests/createInfiniteQuery/createInfiniteQuery.svelte.test.ts b/packages/svelte-query/tests/createInfiniteQuery/createInfiniteQuery.svelte.test.ts
@@ -1,8 +1,10 @@
-import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'
-import { render } from '@testing-library/svelte'
-import { ref } from '../utils.svelte.js'
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
+import { fireEvent, render } from '@testing-library/svelte'
+import { QueryClient } from '@tanstack/query-core'
+import { ref } from "../utils.svelte.js"
 import BaseExample from './BaseExample.svelte'
 import SelectExample from './SelectExample.svelte'
+import ChangeClient from './ChangeClient.svelte'
 import type { QueryObserverResult } from '@tanstack/query-core'
 
 describe('createInfiniteQuery', () => {
@@ -14,7 +16,7 @@ describe('createInfiniteQuery', () => {
     vi.useRealTimers()
   })
 
-  test('Return the correct states for a successful query', async () => {
+  it('should return the correct states for a successful query', async () => {
     let states = ref<Array<QueryObserverResult>>([])
 
     const rendered = render(BaseExample, {
@@ -103,7 +105,7 @@ describe('createInfiniteQuery', () => {
     })
   })
 
-  test('Select a part of the data', async () => {
+  it('should be able to select a part of the data', async () => {
     let states = ref<Array<QueryObserverResult>>([])
 
     const rendered = render(SelectExample, {
@@ -127,4 +129,25 @@ describe('createInfiniteQuery', () => {
       isSuccess: true,
     })
   })
+
+  it('should be able to set new pages with the query client', async () => {
+    const queryClient = new QueryClient()
+
+    const rendered = render(ChangeClient, {
+      props: {
+        queryClient,
+      },
+    })
+
+    await vi.advanceTimersByTimeAsync(11)
+    expect(
+      rendered.getByText('Data: {"pages":[0],"pageParams":[0]}'),
+    ).toBeInTheDocument()
+
+    fireEvent.click(rendered.getByRole('button', { name: /setPages/i }))
+    await vi.advanceTimersByTimeAsync(11)
+    expect(
+      rendered.getByText('Data: {"pages":[7,8],"pageParams":[7,8]}'),
+    ).toBeInTheDocument()
+  })
 })
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
