Merge branch 'main' into use-query-state

Author: TkDodo

.eslintrc.cjs

@@ -6,6 +6,7 @@ const config = {
   parser: '@typescript-eslint/parser',
   plugins: ['@typescript-eslint', 'import'],
   extends: [
+    'plugin:@cspell/recommended',
     'plugin:@typescript-eslint/eslint-recommended',
     'plugin:@typescript-eslint/recommended',
     'plugin:import/recommended',
@@ -34,6 +35,27 @@ const config = {
     },
   },
   rules: {
+    '@cspell/spellchecker': [
+      'error',
+      {
+        cspell: {
+          words: [
+            'tanstack', // Our package scope
+            'tsqd', // Our public interface (TanStack Query Devtools shorthand)
+            'retryer', // Our public interface
+            'Promisable', // Our public interface
+            'extralight', // Our public interface
+            'codemod', // We support our codemod
+
+            'TSES', // @typescript-eslint package's interface
+            'tsup', // We use tsup as builder
+            'solidjs', // Our target framework
+            'tabular-nums', // https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric
+            'todos', // Too general word to be caught as error
+          ],
+        },
+      },
+    ],
     '@typescript-eslint/array-type': [
       'error',
       { default: 'generic', readonly: 'generic' },
@@ -45,6 +67,19 @@ const config = {
       { prefer: 'type-imports' },
     ],
     '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/naming-convention': [
+      'error',
+      {
+        selector: 'typeParameter',
+        format: ['PascalCase'],
+        leadingUnderscore: 'forbid',
+        trailingUnderscore: 'forbid',
+        custom: {
+          regex: '^(T|T[A-Z][A-Za-z]+)$',
+          match: true,
+        },
+      },
+    ],
     '@typescript-eslint/no-empty-interface': 'off',
     '@typescript-eslint/no-explicit-any': 'off',
     '@typescript-eslint/no-non-null-assertion': 'off',

.github/workflows/ci.yml

@@ -15,7 +15,6 @@ concurrency:
 
 env:
   NX_CLOUD_ACCESS_TOKEN: ${{ secrets.NX_CLOUD_ACCESS_TOKEN }}
-  NX_CLOUD_AUTH_TOKEN: ${{ secrets.NX_CLOUD_AUTH_TOKEN }}
 
 jobs:
   test-and-publish:

.github/workflows/pr.yml

@@ -12,11 +12,9 @@ concurrency:
   cancel-in-progress: true
 
 env:
+  NX_CLOUD_ACCESS_TOKEN: ${{ secrets.NX_CLOUD_ACCESS_TOKEN }}
   NX_CLOUD_DISTRIBUTED_EXECUTION: true
   NX_CLOUD_DISTRIBUTED_EXECUTION_AGENT_COUNT: 3
-  NX_CLOUD_ACCESS_TOKEN: ${{ secrets.NX_CLOUD_ACCESS_TOKEN }}
-  NX_CLOUD_AUTH_TOKEN: ${{ secrets.NX_CLOUD_AUTH_TOKEN }}
-  NX_VERBOSE_LOGGING: true
 
 jobs:
   main:

docs/framework/angular/quick-start.md

@@ -12,8 +12,14 @@ If you're looking for a fully functioning example, please have a look at our [ba
 ### Provide the client to your App
 
 ```ts
+import { provideHttpClient } from '@angular/common/http'
+import {
+  provideAngularQuery,
+  QueryClient,
+} from '@tanstack/angular-query-experimental'
+
 bootstrapApplication(AppComponent, {
-  providers: [provideAngularQuery(new QueryClient())],
+  providers: [provideHttpClient(), provideAngularQuery(new QueryClient())],
 })
 ```
 
@@ -45,6 +51,7 @@ import {
   `,
 })
 export class TodosComponent {
+  todoService = inject(TodoService)
   queryClient = injectQueryClient()
 
   query = injectQuery(() => ({

examples/angular/basic/package.json

@@ -3,19 +3,18 @@
   "private": true,
   "type": "module",
   "scripts": {
-    "start": "vite",
     "dev": "vite",
     "build": "vite build",
-    "serve": "vite preview"
+    "preview": "vite preview",
+    "test:types": "tsc"
   },
-  "license": "MIT",
   "dependencies": {
     "@angular/common": "^17.0.8",
     "@angular/compiler": "^17.0.8",
     "@angular/core": "^17.0.8",
     "@angular/platform-browser": "^17.0.8",
-    "@tanstack/angular-query-devtools-experimental": "^5.13.3",
-    "@tanstack/angular-query-experimental": "^5.13.4",
+    "@tanstack/angular-query-devtools-experimental": "^5.18.1",
+    "@tanstack/angular-query-experimental": "^5.18.1",
     "rxjs": "^7.8.1",
     "zone.js": "^0.14.2"
   },

integrations/angular-cli-standalone-17/.gitignore renamed to examples/angular/cli-standalone-17/.gitignore

@@ -1,10 +1,10 @@
 {
-  "name": "angular-cli-standalone-17",
-  "version": "0.0.0",
+  "name": "@tanstack/query-example-angular-cli-standalone-17",
+  "private": true,
   "scripts": {
-    "build": "ng build"
+    "build": "ng build",
+    "test:types": "tsc"
   },
-  "private": true,
   "dependencies": {
     "@angular/animations": "^17.0.8",
     "@angular/common": "^17.0.8",

integrations/angular-cli-standalone-17/README.md renamed to examples/angular/cli-standalone-17/README.md

@@ -3,19 +3,18 @@
   "private": true,
   "type": "module",
   "scripts": {
-    "start": "vite",
     "dev": "vite",
     "build": "vite build",
-    "serve": "vite preview"
+    "preview": "vite preview",
+    "test:types": "tsc"
   },
-  "license": "MIT",
   "dependencies": {
     "@angular/common": "^17.0.8",
     "@angular/compiler": "^17.0.8",
     "@angular/core": "^17.0.8",
     "@angular/platform-browser": "^17.0.8",
-    "@tanstack/angular-query-devtools-experimental": "^5.13.3",
-    "@tanstack/angular-query-experimental": "^5.13.4",
+    "@tanstack/angular-query-devtools-experimental": "^5.18.1",
+    "@tanstack/angular-query-experimental": "^5.18.1",
     "axios": "^1.6.2",
     "rxjs": "^7.8.1",
     "zone.js": "^0.14.2"

integrations/angular-cli-standalone-17/angular.json renamed to examples/angular/cli-standalone-17/angular.json

@@ -3,19 +3,18 @@
   "private": true,
   "type": "module",
   "scripts": {
-    "start": "vite",
     "dev": "vite",
     "build": "vite build",
-    "serve": "vite preview"
+    "preview": "vite preview",
+    "test:types": "tsc"
   },
-  "license": "MIT",
   "dependencies": {
     "@angular/common": "^17.0.8",
     "@angular/compiler": "^17.0.8",
     "@angular/core": "^17.0.8",
     "@angular/platform-browser": "^17.0.8",
-    "@tanstack/angular-query-devtools-experimental": "^5.13.3",
-    "@tanstack/angular-query-experimental": "^5.13.4",
+    "@tanstack/angular-query-devtools-experimental": "^5.18.1",
+    "@tanstack/angular-query-experimental": "^5.18.1",
     "rxjs": "^7.8.1",
     "zone.js": "^0.14.2"
   },

integrations/angular-cli-standalone-17/package.json renamed to examples/angular/cli-standalone-17/package.json

@@ -1,23 +1,24 @@
 {
   "name": "@tanstack/query-example-react-algolia",
   "private": true,
-  "main": "src/index.tsx",
+  "type": "module",
   "scripts": {
     "dev": "vite",
-    "build": "tsc && vite build",
-    "preview": "vite preview"
+    "build": "vite build",
+    "preview": "vite preview",
+    "test:types": "tsc"
   },
   "dependencies": {
     "@algolia/client-search": "4.22.0",
     "@algolia/transporter": "4.22.0",
-    "@tanstack/react-query": "^5.0.0",
-    "@tanstack/react-query-devtools": "^5.0.0",
+    "@tanstack/react-query": "^5.18.1",
+    "@tanstack/react-query-devtools": "^5.18.1",
     "algoliasearch": "4.22.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "devDependencies": {
-    "@tanstack/eslint-plugin-query": "^5.0.0",
+    "@tanstack/eslint-plugin-query": "^5.18.1",
     "@types/react": "^18.2.45",
     "@types/react-dom": "^18.2.18",
     "@vitejs/plugin-react": "^4.2.1",

integrations/angular-cli-standalone-17/src/app/app.component.ts renamed to examples/angular/cli-standalone-17/src/app/app.component.ts

@@ -1,20 +1,24 @@
 {
   "compilerOptions": {
     "target": "ES2020",
-    "lib": ["dom", "dom.iterable", "esnext"],
-    "allowJs": true,
+    "useDefineForClassFields": true,
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
     "skipLibCheck": true,
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "strict": true,
-    "forceConsistentCasingInFileNames": true,
-    "noFallthroughCasesInSwitch": true,
-    "module": "esnext",
-    "moduleResolution": "node",
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
     "resolveJsonModule": true,
     "isolatedModules": true,
     "noEmit": true,
-    "jsx": "react-jsx"
+    "jsx": "react-jsx",
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true
   },
   "include": ["src"]
 }

integrations/angular-cli-standalone-17/src/app/app.config.ts renamed to examples/angular/cli-standalone-17/src/app/app.config.ts

@@ -0,0 +1,5 @@
+module.exports = {
+  eslint: {
+    ignoreDuringBuilds: true,
+  },
+}

integrations/angular-cli-standalone-17/src/assets/.gitkeep renamed to examples/angular/cli-standalone-17/src/assets/.gitkeep

@@ -1,20 +1,18 @@
 {
-  "name": "@tanstack/query-example-react-refetch-interval",
+  "name": "@tanstack/query-example-react-auto-refetching",
   "private": true,
-  "main": "index.js",
-  "license": "MIT",
+  "scripts": {
+    "dev": "next",
+    "build": "next build",
+    "start": "next start"
+  },
   "dependencies": {
-    "@tanstack/react-query": "^5.0.0",
-    "@tanstack/react-query-devtools": "^5.0.0",
+    "@tanstack/react-query": "^5.18.1",
+    "@tanstack/react-query-devtools": "^5.18.1",
     "axios": "^1.6.2",
     "isomorphic-unfetch": "4.0.2",
     "next": "^14.0.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
-  },
-  "scripts": {
-    "dev": "next",
-    "start": "next start",
-    "build": "next build"
   }
 }

integrations/angular-cli-standalone-17/src/favicon.ico renamed to examples/angular/cli-standalone-17/src/favicon.ico

@@ -1,15 +1,15 @@
 {
   "name": "@tanstack/query-example-react-basic-graphql-request",
   "private": true,
-  "main": "src/index.jsx",
+  "type": "module",
   "scripts": {
     "dev": "vite",
     "build": "vite build",
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.0.0",
-    "@tanstack/react-query-devtools": "^5.0.0",
+    "@tanstack/react-query": "^5.18.1",
+    "@tanstack/react-query-devtools": "^5.18.1",
     "graphql": "^16.8.1",
     "graphql-request": "^6.1.0",
     "react": "^18.2.0",

integrations/angular-cli-standalone-17/src/index.html renamed to examples/angular/cli-standalone-17/src/index.html

@@ -1,23 +1,24 @@
 {
   "name": "@tanstack/query-example-react-basic-typescript",
   "private": true,
-  "main": "src/index.tsx",
+  "type": "module",
   "scripts": {
     "dev": "vite",
-    "build": "tsc && vite build",
-    "preview": "vite preview"
+    "build": "vite build",
+    "preview": "vite preview",
+    "test:types": "tsc"
   },
   "dependencies": {
-    "@tanstack/query-sync-storage-persister": "^5.0.0",
-    "@tanstack/react-query": "^5.0.0",
-    "@tanstack/react-query-devtools": "^5.0.0",
-    "@tanstack/react-query-persist-client": "^5.0.0",
+    "@tanstack/query-sync-storage-persister": "^5.18.1",
+    "@tanstack/react-query": "^5.18.1",
+    "@tanstack/react-query-devtools": "^5.18.1",
+    "@tanstack/react-query-persist-client": "^5.18.1",
     "axios": "^1.6.2",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "devDependencies": {
-    "@tanstack/eslint-plugin-query": "^5.0.0",
+    "@tanstack/eslint-plugin-query": "^5.18.1",
     "@types/react": "^18.2.45",
     "@types/react-dom": "^18.2.18",
     "@vitejs/plugin-react": "^4.2.1",

integrations/angular-cli-standalone-17/src/main.ts renamed to examples/angular/cli-standalone-17/src/main.ts

@@ -1,20 +1,24 @@
 {
   "compilerOptions": {
     "target": "ES2020",
-    "lib": ["dom", "dom.iterable", "esnext"],
-    "allowJs": true,
+    "useDefineForClassFields": true,
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
     "skipLibCheck": true,
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "strict": true,
-    "forceConsistentCasingInFileNames": true,
-    "noFallthroughCasesInSwitch": true,
-    "module": "esnext",
-    "moduleResolution": "node",
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
     "resolveJsonModule": true,
     "isolatedModules": true,
     "noEmit": true,
-    "jsx": "react-jsx"
+    "jsx": "react-jsx",
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true
   },
   "include": ["src"]
 }

integrations/angular-cli-standalone-17/src/styles.css renamed to examples/angular/cli-standalone-17/src/styles.css

@@ -1,7 +1,6 @@
 import { defineConfig } from 'vite'
 import react from '@vitejs/plugin-react'
 
-// https://vitejs.dev/config/
 export default defineConfig({
   plugins: [react()],
 })