feat: Remove UMD build output (#5517)

TanStack · Jun 2, 2023 · a33f87b · a33f87b
1 parent 359a082
commit a33f87b
Show file tree

Hide file tree

Showing 20 changed files with 58 additions and 280 deletions.
diff --git a/docs/react/installation.md b/docs/react/installation.md
@@ -3,9 +3,9 @@ id: installation
 title: Installation
 ---
 
-You can install React Query via [NPM](https://npmjs.com),
+You can install React Query via [NPM](https://npmjs.com/),
 or a good ol' `<script>` via
-[unpkg.com](https://unpkg.com).
+[ESM.sh](https://esm.sh/).
 
 > v5 is currently in alpha.
 
@@ -25,15 +25,17 @@ React Query is compatible with React v18+ and works with ReactDOM and React Nati
 
 ### CDN
 
-If you're not using a module bundler or package manager we also have a global ("UMD") build hosted on the [unpkg.com](https://unpkg.com) CDN. Simply add the following `<script>` tag to the bottom of your HTML file:
+If you're not using a module bundler or package manager, you can also use this library via an ESM-compatible CDN such as [ESM.sh](https://esm.sh/). Simply add a `<script type="module">` tag to the bottom of your HTML file:
 
 ```html
-<script src="https://unpkg.com/@tanstack/react-query@alpha/build/umd/index.production.js"></script>
+<script type="module">
+  import React from 'https://esm.sh/react@18.2.0'
+  import ReactDOM from 'https://esm.sh/react-dom@18.2.0'
+  import { QueryClient } from 'https://esm.sh/@tanstack/react-query@alpha'
+</script>
 ```
 
-Once you've added this you will have access to the `window.ReactQuery` object and its exports.
-
-> This installation/usage requires the [React CDN script bundles](https://reactjs.org/docs/cdn-links.html) to be on the page as well.
+> You can find instructions on how to use React without JSX [here](https://react.dev/reference/react/createElement#creating-an-element-without-jsx).
 
 ### Requirements
 

diff --git a/package.json b/package.json
@@ -40,7 +40,6 @@
     "@rollup/plugin-commonjs": "^25.0.0",
     "@rollup/plugin-node-resolve": "^15.0.2",
     "@rollup/plugin-replace": "^5.0.2",
-    "@rollup/plugin-terser": "^0.4.3",
     "@solidjs/testing-library": "^0.5.1",
     "@testing-library/jest-dom": "^5.16.5",
     "@testing-library/react": "^14.0.0",
@@ -83,7 +82,6 @@
     "rimraf": "^5.0.1",
     "rollup": "^3.23.0",
     "rollup-plugin-preserve-directives": "^0.2.0",
-    "rollup-plugin-size": "^0.3.1",
     "rollup-plugin-visualizer": "^5.9.0",
     "rollup-preset-solid": "^2.0.1",
     "semver": "^7.5.1",
@@ -97,7 +95,7 @@
   "bundlewatch": {
     "files": [
       {
-        "path": "packages/*/build/umd/*.production.js"
+        "path": "packages/*/build/lib/*.js"
       }
     ]
   },

diff --git a/packages/query-async-storage-persister/package.json b/packages/query-async-storage-persister/package.json
@@ -25,7 +25,6 @@
   "sideEffects": false,
   "files": [
     "build/lib/*",
-    "build/umd/*",
     "src"
   ],
   "scripts": {

diff --git a/packages/query-broadcast-client-experimental/package.json b/packages/query-broadcast-client-experimental/package.json
@@ -25,7 +25,6 @@
   "sideEffects": false,
   "files": [
     "build/lib/*",
-    "build/umd/*",
     "src"
   ],
   "scripts": {

diff --git a/packages/query-core/package.json b/packages/query-core/package.json
@@ -25,7 +25,6 @@
   "sideEffects": false,
   "files": [
     "build/lib/*",
-    "build/umd/*",
     "src"
   ],
   "scripts": {

diff --git a/packages/query-devtools/package.json b/packages/query-devtools/package.json
@@ -12,14 +12,14 @@
   },
   "type": "commonjs",
   "types": "build/types/index.d.ts",
-  "main": "build/umd/index.js",
+  "main": "build/cjs/index.js",
   "module": "build/esm/index.mjs",
   "exports": {
     ".": {
       "types": "./build/types/index.d.ts",
       "import": "./build/esm/index.mjs",
-      "require": "./build/umd/index.js",
-      "default": "./build/umd/index.js"
+      "require": "./build/cjs/index.js",
+      "default": "./build/cjs/index.js"
     },
     "./package.json": "./package.json"
   },

diff --git a/packages/query-persist-client-core/package.json b/packages/query-persist-client-core/package.json
@@ -25,7 +25,6 @@
   "sideEffects": false,
   "files": [
     "build/lib/*",
-    "build/umd/*",
     "src"
   ],
   "scripts": {

diff --git a/packages/query-sync-storage-persister/package.json b/packages/query-sync-storage-persister/package.json
@@ -25,7 +25,6 @@
   "sideEffects": false,
   "files": [
     "build/lib/*",
-    "build/umd/*",
     "src"
   ],
   "scripts": {

diff --git a/packages/react-query-devtools/package.json b/packages/react-query-devtools/package.json
@@ -35,7 +35,6 @@
   "sideEffects": false,
   "files": [
     "build/lib/*",
-    "build/umd/*",
     "src"
   ],
   "scripts": {

diff --git a/packages/react-query-devtools/rollup.config.mjs b/packages/react-query-devtools/rollup.config.mjs
@@ -4,7 +4,7 @@ import { defineConfig } from 'rollup'
 import { buildConfigs } from '../../scripts/getRollupConfig.mjs'
 
 export default defineConfig([
-  ...buildConfigs({
+  buildConfigs({
     name: 'react-query-devtools',
     jsName: 'ReactQueryDevtools',
     outputFile: 'index',
@@ -15,9 +15,8 @@ export default defineConfig([
       '@tanstack/react-query': 'ReactQuery',
       '@tanstack/query-devtools': 'TanstackQueryDevtools',
     },
-    bundleUMDGlobals: ['@tanstack/query-devtools'],
   }),
-  ...buildConfigs({
+  buildConfigs({
     name: 'react-query-devtools-prod',
     jsName: 'ReactQueryDevtools',
     outputFile: 'index.prod',
@@ -31,6 +30,5 @@ export default defineConfig([
     },
     forceDevEnv: true,
     forceBundle: true,
-    skipUmdBuild: true,
   }),
 ])
diff --git a/packages/react-query-persist-client/package.json b/packages/react-query-persist-client/package.json
@@ -25,7 +25,6 @@
   "sideEffects": false,
   "files": [
     "build/lib/*",
-    "build/umd/*",
     "src"
   ],
   "scripts": {

diff --git a/packages/react-query-persist-client/rollup.config.mjs b/packages/react-query-persist-client/rollup.config.mjs
@@ -14,6 +14,5 @@ export default defineConfig(
       '@tanstack/query-persist-client-core': 'QueryPersistClientCore',
       '@tanstack/react-query': 'ReactQuery',
     },
-    bundleUMDGlobals: ['@tanstack/query-persist-client-core'],
   }),
 )
diff --git a/packages/react-query/package.json b/packages/react-query/package.json
@@ -36,7 +36,6 @@
   },
   "files": [
     "build/lib/*",
-    "build/umd/*",
     "src",
     "build/codemods",
     "!build/codemods/jest.config.js",

diff --git a/packages/react-query/rollup.config.mjs b/packages/react-query/rollup.config.mjs
@@ -15,6 +15,5 @@ export default defineConfig(
       '@tanstack/query-core': 'QueryCore',
       'react-native': 'ReactNative',
     },
-    bundleUMDGlobals: ['@tanstack/query-core'],
   }),
 )
diff --git a/packages/solid-query/package.json b/packages/solid-query/package.json
@@ -45,7 +45,6 @@
   "files": [
     "build/esm/*",
     "build/cjs/*",
-    "build/umd/*",
     "build/source/*",
     "build/types/*",
     "src"

diff --git a/packages/vue-query/package.json b/packages/vue-query/package.json
@@ -42,7 +42,7 @@
   },
   "files": [
     "build/lib/*",
-    "build/umd/*"
+    "src"
   ],
   "dependencies": {
     "@tanstack/query-core": "^5.0.0-alpha.43",

diff --git a/packages/vue-query/rollup.config.mjs b/packages/vue-query/rollup.config.mjs
@@ -16,10 +16,5 @@ export default defineConfig(
       '@tanstack/match-sorter-utils': 'MatchSorter',
       '@vue/devtools-api': 'DevtoolsApi',
     },
-    bundleUMDGlobals: [
-      '@tanstack/query-core',
-      '@tanstack/match-sorter-utils',
-      '@vue/devtools-api',
-    ],
   }),
 )
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml