Merge branch 'main' into fix/docs-typos

TanStack · Aug 19, 2024 · 5eb6505 · 5eb6505
2 parents 1c4c415 + eee3948
commit 5eb6505
Show file tree

Hide file tree

Showing 108 changed files with 526 additions and 360 deletions.
diff --git a/README.md b/README.md
@@ -8,8 +8,6 @@ Hooks for fetching, caching and updating asynchronous data in React, Solid, Svel
   <img alt="#TanStack" src="https://img.shields.io/twitter/url?color=%2308a0e9&label=%23TanStack&style=social&url=https%3A%2F%2Ftwitter.com%2Fintent%2Ftweet%3Fbutton_hashtag%3DTanStack">
 </a><a href="https://discord.com/invite/WrRKjPJ" target="\_parent">
   <img alt="" src="https://img.shields.io/badge/Discord-TanStack-%235865F2" />
-</a><a href="https://github.com/TanStack/query/actions?query=workflow%3A%22react-query+tests%22">
-<img src="https://github.com/TanStack/query/workflows/react-query%20tests/badge.svg" />
 </a><a href="https://www.npmjs.com/package/@tanstack/query-core" target="\_parent">
   <img alt="" src="https://img.shields.io/npm/dm/@tanstack/query-core.svg" />
 </a><a href="https://bundlejs.com/?q=%40tanstack%2Freact-query&config=%7B%22esbuild%22%3A%7B%22external%22%3A%5B%22react%22%2C%22react-dom%22%5D%7D%7D&badge=" target="\_parent">

diff --git a/docs/eslint/eslint-plugin-query.md b/docs/eslint/eslint-plugin-query.md
@@ -11,11 +11,23 @@ The plugin is a separate package that you need to install:
 
 ```bash
 $ npm i -D @tanstack/eslint-plugin-query
-# or
+```
+
+or
+
+```bash
 $ pnpm add -D @tanstack/eslint-plugin-query
-# or
+```
+
+or
+
+```bash
 $ yarn add -D @tanstack/eslint-plugin-query
-# or
+```
+
+or
+
+```bash
 $ bun add -D @tanstack/eslint-plugin-query
 ```
 

diff --git a/docs/framework/angular/devtools.md b/docs/framework/angular/devtools.md
@@ -9,11 +9,23 @@ The devtools are a separate package that you need to install:
 
 ```bash
 $ npm i @tanstack/angular-query-devtools-experimental
-# or
+```
+
+or
+
+```bash
 $ pnpm add @tanstack/angular-query-devtools-experimental
-# or
+```
+
+or
+
+```bash
 $ yarn add @tanstack/angular-query-devtools-experimental
-# or
+```
+
+or
+
+```bash
 $ bun add @tanstack/angular-query-devtools-experimental
 ```
 

diff --git a/docs/framework/angular/installation.md b/docs/framework/angular/installation.md
@@ -11,11 +11,23 @@ _Angular Query is compatible with Angular v16 and higher_
 
 ```bash
 npm i @tanstack/angular-query-experimental
-# or
+```
+
+or
+
+```bash
 pnpm add @tanstack/angular-query-experimental
-# or
+```
+
+or
+
+```bash
 yarn add @tanstack/angular-query-experimental
-# or
+```
+
+or
+
+```bash
 bun add @tanstack/angular-query-experimental
 ```
 

diff --git a/docs/framework/react/devtools.md b/docs/framework/react/devtools.md
@@ -21,11 +21,23 @@ The devtools are a separate package that you need to install:
 
 ```bash
 $ npm i @tanstack/react-query-devtools
-# or
+```
+
+or
+
+```bash
 $ pnpm add @tanstack/react-query-devtools
-# or
+```
+
+or
+
+```bash
 $ yarn add @tanstack/react-query-devtools
-# or
+```
+
+or
+
+```bash
 $ bun add @tanstack/react-query-devtools
 ```
 

diff --git a/docs/framework/react/guides/request-waterfalls.md b/docs/framework/react/guides/request-waterfalls.md
@@ -118,8 +118,8 @@ const [usersQuery, teamsQuery, projectsQuery] = useSuspenseQueries({
     { queryKey: ['users'], queryFn: fetchUsers },
     { queryKey: ['teams'], queryFn: fetchTeams },
     { queryKey: ['projects'], queryFn: fetchProjects },
-  ]
-}
+  ],
+})
 ```
 
 ### Nested Component Waterfalls

diff --git a/docs/framework/react/installation.md b/docs/framework/react/installation.md
@@ -11,11 +11,23 @@ or a good ol' `<script>` via
 
 ```bash
 npm i @tanstack/react-query
-# or
+```
+
+or
+
+```bash
 pnpm add @tanstack/react-query
-# or
+```
+
+or
+
+```bash
 yarn add @tanstack/react-query
-# or
+```
+
+or
+
+```bash
 bun add @tanstack/react-query
 ```
 
@@ -58,10 +70,22 @@ It is recommended to also use our [ESLint Plugin Query](../../../eslint/eslint-p
 
 ```bash
 npm i -D @tanstack/eslint-plugin-query
-# or
+```
+
+or
+
+```bash
 pnpm add -D @tanstack/eslint-plugin-query
-# or
+```
+
+or
+
+```bash
 yarn add -D @tanstack/eslint-plugin-query
-# or
+```
+
+or
+
+```bash
 bun add -D @tanstack/eslint-plugin-query
 ```
diff --git a/docs/framework/solid/devtools.md b/docs/framework/solid/devtools.md
@@ -13,11 +13,23 @@ The devtools are a separate package that you need to install:
 
 ```bash
 $ npm i @tanstack/solid-query-devtools
-# or
+```
+
+or
+
+```bash
 $ pnpm add @tanstack/solid-query-devtools
-# or
+```
+
+or
+
+```bash
 $ yarn add @tanstack/solid-query-devtools
-# or
+```
+
+or
+
+```bash
 $ bun add @tanstack/solid-query-devtools
 ```
 

diff --git a/docs/framework/solid/installation.md b/docs/framework/solid/installation.md
@@ -11,11 +11,23 @@ or a good ol' `<script>` via
 
 ```bash
 npm i @tanstack/solid-query
-# or
+```
+
+or
+
+```bash
 pnpm add @tanstack/solid-query
-# or
+```
+
+or
+
+```bash
 yarn add @tanstack/solid-query
-# or
+```
+
+or
+
+```bash
 bun add @tanstack/solid-query
 ```
 

diff --git a/docs/framework/svelte/installation.md b/docs/framework/svelte/installation.md
@@ -11,11 +11,23 @@ You can install Svelte Query via [NPM](https://npmjs.com).
 
 ```bash
 npm i @tanstack/svelte-query
-# or
+```
+
+or
+
+```bash
 pnpm add @tanstack/svelte-query
-# or
+```
+
+or
+
+```bash
 yarn add @tanstack/svelte-query
-# or
+```
+
+or
+
+```bash
 bun add @tanstack/svelte-query
 ```
 

diff --git a/docs/framework/vue/devtools.md b/docs/framework/vue/devtools.md
@@ -16,11 +16,23 @@ The devtools component is a separate package that you need to install:
 
 ```bash
 $ npm i @tanstack/vue-query-devtools
-# or
+```
+
+or
+
+```bash
 $ pnpm add @tanstack/vue-query-devtools
-# or
+```
+
+or
+
+```bash
 $ yarn add @tanstack/vue-query-devtools
-# or
+```
+
+or
+
+```bash
 $ bun add @tanstack/vue-query-devtools
 ```
 

diff --git a/docs/framework/vue/installation.md b/docs/framework/vue/installation.md
@@ -9,11 +9,23 @@ You can install Vue Query via [NPM](https://npmjs.com).
 
 ```bash
 npm i @tanstack/vue-query
-# or
+```
+
+or
+
+```bash
 pnpm add @tanstack/vue-query
-# or
+```
+
+or
+
+```bash
 yarn add @tanstack/vue-query
-# or
+```
+
+or
+
+```bash
 bun add @tanstack/vue-query
 ```
 

diff --git a/eslint.config.js b/eslint.config.js
@@ -3,6 +3,7 @@
 // @ts-ignore Needed due to moduleResolution Node vs Bundler
 import { tanstackConfig } from '@tanstack/config/eslint'
 import pluginCspell from '@cspell/eslint-plugin'
+import vitest from '@vitest/eslint-plugin'
 
 export default [
   ...tanstackConfig,
@@ -40,4 +41,13 @@ export default [
       'no-case-declarations': 'off',
     },
   },
+  {
+    files: ['**/*.spec.ts*', '**/*.test.ts*', '**/*.test-d.ts*'],
+    plugins: { vitest },
+    rules: {
+      ...vitest.configs.recommended.rules,
+      'vitest/expect-expect': 'warn',
+    },
+    settings: { vitest: { typecheck: true } },
+  },
 ]
diff --git a/examples/angular/basic/package.json b/examples/angular/basic/package.json
@@ -14,7 +14,7 @@
     "@angular/core": "^17.3.12",
     "@angular/platform-browser": "^17.3.12",
     "@angular/platform-browser-dynamic": "^17.3.12",
-    "@tanstack/angular-query-experimental": "^5.51.22",
+    "@tanstack/angular-query-experimental": "^5.51.24",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.3",
     "zone.js": "^0.14.8"
@@ -23,7 +23,7 @@
     "@angular-devkit/build-angular": "^17.3.8",
     "@angular/cli": "^17.3.8",
     "@angular/compiler-cli": "^17.3.12",
-    "@tanstack/angular-query-devtools-experimental": "^5.51.22",
+    "@tanstack/angular-query-devtools-experimental": "^5.51.24",
     "typescript": "5.3.3"
   }
 }
diff --git a/examples/angular/infinite-query-with-max-pages/package.json b/examples/angular/infinite-query-with-max-pages/package.json
@@ -14,7 +14,7 @@
     "@angular/core": "^17.3.12",
     "@angular/platform-browser": "^17.3.12",
     "@angular/platform-browser-dynamic": "^17.3.12",
-    "@tanstack/angular-query-experimental": "^5.51.22",
+    "@tanstack/angular-query-experimental": "^5.51.24",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.3",
     "zone.js": "^0.14.8"
@@ -23,7 +23,7 @@
     "@angular-devkit/build-angular": "^17.3.8",
     "@angular/cli": "^17.3.8",
     "@angular/compiler-cli": "^17.3.12",
-    "@tanstack/angular-query-devtools-experimental": "^5.51.22",
+    "@tanstack/angular-query-devtools-experimental": "^5.51.24",
     "typescript": "5.3.3"
   }
 }
diff --git a/examples/angular/router/package.json b/examples/angular/router/package.json
@@ -15,7 +15,7 @@
     "@angular/platform-browser": "^17.3.12",
     "@angular/platform-browser-dynamic": "^17.3.12",
     "@angular/router": "^17.3.12",
-    "@tanstack/angular-query-experimental": "^5.51.22",
+    "@tanstack/angular-query-experimental": "^5.51.24",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.3",
     "zone.js": "^0.14.8"
@@ -24,7 +24,7 @@
     "@angular-devkit/build-angular": "^17.3.8",
     "@angular/cli": "^17.3.8",
     "@angular/compiler-cli": "^17.3.12",
-    "@tanstack/angular-query-devtools-experimental": "^5.51.22",
+    "@tanstack/angular-query-devtools-experimental": "^5.51.24",
     "typescript": "5.3.3"
   }
 }