Merge remote-tracking branch 'upstream/main' into enhancement/angular-consistent-injector-options

Author: arnoud-dv

.github/workflows/pr.yml

@@ -71,3 +71,4 @@ jobs:
             |--------|--------|
             | Main | [![](https://deno.bundlejs.com/badge?q=https://esm.sh/@tanstack/react-query/es2022/react-query.mjs&config={%22esbuild%22:{%22external%22:[%22react@^19.0.0/jsx-runtime?target=es2022%22,%22react@^19.0.0?target=es2022%22]}}&badge=detailed)](https://bundlejs.com/?q=https://esm.sh/@tanstack/react-query/es2022/react-query.mjs&config=%7B%22esbuild%22:%7B%22external%22:%5B%22react@%5E19.0.0/jsx-runtime?target=es2022%22,%22react@%5E19.0.0?target=es2022%22%5D%7D%7D) |
             | This PR | [![](https://deno.bundlejs.com/badge?q=https://esm.sh/pr/@tanstack/react-query@${{ env.COMMIT_SHA }}/es2022/react-query.mjs&config={%22esbuild%22:{%22external%22:[%22react@^19.0.0/jsx-runtime?target=es2022%22,%22react@^19.0.0?target=es2022%22]}}&badge=detailed)](https://bundlejs.com/?q=https://esm.sh/pr/@tanstack/react-query@${{ env.COMMIT_SHA }}/es2022/react-query.mjs&config=%7B%22esbuild%22:%7B%22external%22:%5B%22react@%5E19.0.0/jsx-runtime?target=es2022%22,%22react@%5E19.0.0?target=es2022%22%5D%7D%7D) |
+        continue-on-error: true

CONTRIBUTING.md

@@ -100,7 +100,7 @@ pnpm i
 pnpm dev
 ```
 
-4. Now you can visit http://localhost:3000/query/latest/docs/overview in the browser and see the changes you make in `tanstack/query/docs` there.
+4. Now you can visit http://localhost:3000/query/latest/docs/framework/react/overview in the browser and see the changes you make in `tanstack/query/docs` there.
 
 > [!WARNING]
 > You will need to update the `docs/config.json` file (in `TanStack/query`) if you add a new documentation page!
@@ -236,3 +236,36 @@ Use an appropriate commit type. Be especially careful with breaking changes.
 ## Releases
 
 For each new commit added to `main` with `git push` or by merging a pull request or merging from another branch, a GitHub action is triggered and runs the `semantic-release` command to make a release if there are codebase changes since the last release that affect the package functionalities.
+
+## 🧪 Test
+
+TanStack Query uses [Nx](https://nx.dev/) as its monorepo tool.
+To run tests in a local environment, you should use `nx` commands from the root directory.
+
+### ✅ Run all tests
+
+To run tests for **all packages**, run:
+
+```bash
+npm run test
+```
+
+### ✅ Run tests for a specific package
+
+To run tests for a specific package, use the following command:
+
+```bash
+npx nx run @tanstack/{package-name}:test:lib
+```
+
+For example:
+
+```bash
+npx nx run @tanstack/react-query:test:lib
+```
+
+### ⚠️ Caution
+
+Do not run `pnpm run test:lib` inside individual package folders.
+This can cause test failures due to dependencies between packages.
+Always run tests from the **root folder** using `nx` commands.

README.md

@@ -51,4 +51,4 @@ View the contributing guidelines [here](/CONTRIBUTING.md)
 
 ### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
 
-<!-- Use the force, Luke! -->
+<!-- Use the force, Luke -->

docs/config.json

@@ -326,6 +326,143 @@
             }
           ]
         },
+        {
+          "label": "solid",
+          "children": [
+            {
+              "label": "Important Defaults",
+              "to": "framework/solid/guides/important-defaults"
+            },
+            {
+              "label": "Queries",
+              "to": "framework/solid/guides/queries"
+            },
+            {
+              "label": "Query Keys",
+              "to": "framework/solid/guides/query-keys"
+            },
+            {
+              "label": "Query Functions",
+              "to": "framework/solid/guides/query-functions"
+            },
+            {
+              "label": "Query Options",
+              "to": "framework/solid/guides/query-options"
+            },
+            {
+              "label": "Network Mode",
+              "to": "framework/solid/guides/network-mode"
+            },
+            {
+              "label": "Parallel Queries",
+              "to": "framework/solid/guides/parallel-queries"
+            },
+            {
+              "label": "Dependent Queries",
+              "to": "framework/solid/guides/dependent-queries"
+            },
+            {
+              "label": "Background Fetching Indicators",
+              "to": "framework/solid/guides/background-fetching-indicators"
+            },
+            {
+              "label": "Window Focus Refetching",
+              "to": "framework/solid/guides/window-focus-refetching"
+            },
+            {
+              "label": "Disabling/Pausing Queries",
+              "to": "framework/solid/guides/disabling-queries"
+            },
+            {
+              "label": "Query Retries",
+              "to": "framework/solid/guides/query-retries"
+            },
+            {
+              "label": "Paginated Queries",
+              "to": "framework/solid/guides/paginated-queries"
+            },
+            {
+              "label": "Infinite Queries",
+              "to": "framework/solid/guides/infinite-queries"
+            },
+            {
+              "label": "Initial Query Data",
+              "to": "framework/solid/guides/initial-query-data"
+            },
+            {
+              "label": "Placeholder Query Data",
+              "to": "framework/solid/guides/placeholder-query-data"
+            },
+            {
+              "label": "Mutations",
+              "to": "framework/solid/guides/mutations"
+            },
+            {
+              "label": "Query Invalidation",
+              "to": "framework/solid/guides/query-invalidation"
+            },
+            {
+              "label": "Invalidation from Mutations",
+              "to": "framework/solid/guides/invalidations-from-mutations"
+            },
+            {
+              "label": "Updates from Mutation Responses",
+              "to": "framework/solid/guides/updates-from-mutation-responses"
+            },
+            {
+              "label": "Optimistic Updates",
+              "to": "framework/solid/guides/optimistic-updates"
+            },
+            {
+              "label": "Query Cancellation",
+              "to": "framework/solid/guides/query-cancellation"
+            },
+            {
+              "label": "Scroll Restoration",
+              "to": "framework/solid/guides/scroll-restoration"
+            },
+            {
+              "label": "Filters",
+              "to": "framework/solid/guides/filters"
+            },
+            {
+              "label": "Request Waterfalls",
+              "to": "framework/solid/guides/request-waterfalls"
+            },
+            {
+              "label": "Prefetching",
+              "to": "framework/solid/guides/prefetching"
+            },
+            {
+              "label": "SSR",
+              "to": "framework/solid/guides/ssr"
+            },
+            {
+              "label": "Advanced SSR",
+              "to": "framework/solid/guides/advanced-ssr"
+            },
+            {
+              "label": "Caching",
+              "to": "framework/solid/guides/caching"
+            },
+            {
+              "label": "Default Query Fn",
+              "to": "framework/solid/guides/default-query-function"
+            },
+            {
+              "label": "Suspense",
+              "to": "framework/solid/guides/suspense"
+            },
+            {
+              "label": "Testing",
+              "to": "framework/solid/guides/testing"
+            },
+            {
+              "label": "Does this replace state managers?",
+              "to": "framework/angular/guides/does-this-replace-client-state"
+            }
+          ]
+        },
         {
           "label": "vue",
           "children": [
@@ -605,6 +742,10 @@
           "label": "QueriesObserver",
           "to": "reference/QueriesObserver"
         },
+        {
+          "label": "streamedQuery",
+          "to": "reference/streamedQuery"
+        },
         {
           "label": "focusManager",
           "to": "reference/focusManager"
@@ -753,8 +894,44 @@
           "label": "solid",
           "children": [
             {
-              "label": "createQuery",
-              "to": "framework/solid/reference/createQuery"
+              "label": "useQuery",
+              "to": "framework/solid/reference/useQuery"
+            },
+            {
+              "label": "useQueries",
+              "to": "framework/solid/reference/useQueries"
+            },
+            {
+              "label": "useInfiniteQuery",
+              "to": "framework/solid/reference/useInfiniteQuery"
+            },
+            {
+              "label": "useMutation",
+              "to": "framework/solid/reference/useMutation"
+            },
+            {
+              "label": "useIsFetching",
+              "to": "framework/solid/reference/useIsFetching"
+            },
+            {
+              "label": "useIsMutating",
+              "to": "framework/solid/reference/useIsMutating"
+            },
+            {
+              "label": "useMutationState",
+              "to": "framework/solid/reference/useMutationState"
+            },
+            {
+              "label": "queryOptions",
+              "to": "framework/solid/reference/queryOptions"
+            },
+            {
+              "label": "infiniteQueryOptions",
+              "to": "framework/solid/reference/infiniteQueryOptions"
+            },
+            {
+              "label": "hydration",
+              "to": "framework/solid/reference/hydration"
             }
           ]
         },
@@ -840,6 +1017,19 @@
             }
           ]
         },
+        {
+          "label": "solid",
+          "children": [
+            {
+              "label": "TkDodo's Blog",
+              "to": "framework/solid/community/tkdodos-blog"
+            },
+            {
+              "label": "Community Projects",
+              "to": "framework/solid/community/community-projects"
+            }
+          ]
+        },
         {
           "label": "vue",
           "children": [
@@ -957,6 +1147,10 @@
             {
               "label": "Devtools Embedded Panel",
               "to": "framework/react/examples/devtools-panel"
+            },
+            {
+              "label": "Chat example (streaming)",
+              "to": "framework/react/examples/chat"
             }
           ]
         },
@@ -1123,6 +1317,19 @@
             }
           ]
         },
+        {
+          "label": "solid",
+          "children": [
+            {
+              "label": "broadcastQueryClient (Experimental)",
+              "to": "framework/solid/plugins/broadcastQueryClient"
+            },
+            {
+              "label": "createPersister (Experimental)",
+              "to": "framework/solid/plugins/createPersister"
+            }
+          ]
+        },
         {
           "label": "vue",
           "children": [

docs/eslint/eslint-plugin-query.md

@@ -93,8 +93,9 @@ Alternatively, add `@tanstack/query` to the plugins section, and configure the r
 
 ## Rules
 
-- [@tanstack/query/exhaustive-deps](./exhaustive-deps)
-- [@tanstack/query/no-rest-destructuring](./no-rest-destructuring)
-- [@tanstack/query/stable-query-client](./stable-query-client)
-- [@tanstack/query/no-unstable-deps](./no-unstable-deps)
-- [@tanstack/query/infinite-query-property-order](./infinite-query-property-order)
+- [@tanstack/query/exhaustive-deps](./exhaustive-deps.md)
+- [@tanstack/query/no-rest-destructuring](./no-rest-destructuring.md)
+- [@tanstack/query/stable-query-client](./stable-query-client.md)
+- [@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)

docs/eslint/no-void-query-fn.md

@@ -0,0 +1,39 @@
+---
+id: no-void-query-fn
+title: Disallow returning void from query functions
+---
+
+Query functions must return a value that will be cached by TanStack Query. Functions that don't return a value (void functions) can lead to unexpected behavior and might indicate a mistake in the implementation.
+
+## Rule Details
+
+Example of **incorrect** code for this rule:
+
+```tsx
+/* eslint "@tanstack/query/no-void-query-fn": "error" */
+
+useQuery({
+  queryKey: ['todos'],
+  queryFn: async () => {
+    await api.todos.fetch() // Function doesn't return the fetched data
+  },
+})
+```
+
+Example of **correct** code for this rule:
+
+```tsx
+/* eslint "@tanstack/query/no-void-query-fn": "error" */
+useQuery({
+  queryKey: ['todos'],
+  queryFn: async () => {
+    const todos = await api.todos.fetch()
+    return todos
+  },
+})
+```
+
+## Attributes
+
+- [x] ✅ Recommended
+- [ ] 🔧 Fixable

docs/framework/react/community/community-projects.md

@@ -25,6 +25,12 @@ The Missing Fullstack Toolkit for Next.js
 
 Link: https://blitzjs.com/
 
+## Connect
+
+A family of libraries for building building browser and gRPC-compatible HTTP APIs.
+
+Link: https://connectrpc.com/docs
+
 ## GraphQL Code Generator
 
 Generate React Query hooks from your GraphQL schema
@@ -33,7 +39,7 @@ Link: https://the-guild.dev/graphql/codegen
 
 ## Http-wizard
 
-End-to-end type-safe Fastify API with typecript magic ✨
+End-to-end type-safe Fastify API with typeScript magic ✨
 
 Link: https://http-wizard.com
 

docs/framework/react/community/tkdodos-blog.md

@@ -3,7 +3,7 @@ id: tkdodos-blog
 title: TkDodo's Blog
 ---
 
-TanStack Query maintainer [TkDodo](https://twitter.com/tkdodo) has a series of blog posts about using and working with the library. Some articles show general best practices, but most have an _opinionated_ point of view.
+TanStack Query maintainer [TkDodo](https://bsky.app/profile/tkdodo.eu) has a series of blog posts about using and working with the library. Some articles show general best practices, but most have an _opinionated_ point of view.
 
 ## [#1: Practical React Query](https://tkdodo.eu/blog/practical-react-query)