feat: size-limit (#9993)

* feat: size-limit

* fix: script

* fix: add test:size to nx

* fix: skip install and build

* really

* fix: size-limit options

* ok we need build step

* fix: test-size runs as part of its own action

Author: TkDodo

.github/workflows/pr.yml

@@ -60,16 +60,13 @@ jobs:
         id: determine-sha
         run: |
           echo "COMMIT_SHA=${{ github.event.pull_request.head.sha || github.sha }}" >> $GITHUB_ENV
-      - name: Preview Bundle Size
-        uses: marocchino/sticky-pull-request-comment@fd19551a2a7c0d29677c63257f86d8ef8bb24b48
+      - name: Size Limit
+        uses: andresz1/size-limit-action@94bc357df29c36c8f8d50ea497c3e225c3c95d1d
         with:
-          message: |
-            Sizes for commit ${{ env.COMMIT_SHA }}:
-            | Branch | Bundle Size |
-            |--------|--------|
-            | Main | [![](https://deno.bundlejs.com/badge?q=https://esm.sh/@tanstack/react-query/es2022/react-query.mjs&config={%22esbuild%22:{%22external%22:[%22react@^19.2.1/jsx-runtime?target=es2022%22,%22react@^19.2.1?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.2.0/jsx-runtime?target=es2022%22,%22react@%5E19.2.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.2.1/jsx-runtime?target=es2022%22,%22react@^19.2.1?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.2.0/jsx-runtime?target=es2022%22,%22react@%5E19.2.0?target=es2022%22%5D%7D%7D) |
-        continue-on-error: true
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          skip_step: install
+          build_script: build:all
+          script: pnpm run test:size
   provenance:
     name: Provenance
     runs-on: ubuntu-latest

nx.json

@@ -42,6 +42,10 @@
       "cache": true,
       "inputs": ["{workspaceRoot}/**/package.json"]
     },
+    "test:size": {
+      "cache": true,
+      "inputs": ["{workspaceRoot}/**/package.json"]
+    },
     "test:eslint": {
       "cache": true,
       "dependsOn": ["^compile"],

package.json

@@ -14,6 +14,7 @@
     "test:ci": "nx run-many --targets=test:sherif,test:knip,test:docs,test:eslint,test:lib,test:types,test:build,build",
     "test:eslint": "nx affected --target=test:eslint",
     "test:sherif": "sherif -i typescript -p \"./integrations/*\" -p \"./examples/*\"",
+    "test:size": "size-limit",
     "test:lib": "nx affected --target=test:lib --exclude=examples/**",
     "test:lib:dev": "pnpm run test:lib && nx watch --all -- pnpm run test:lib",
     "test:build": "nx affected --target=test:build --exclude=examples/**",
@@ -34,14 +35,16 @@
     "includedScripts": [
       "test:docs",
       "test:knip",
-      "test:sherif"
+      "test:sherif",
+      "test:size"
     ]
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.3",
     "@changesets/cli": "^2.29.8",
     "@cspell/eslint-plugin": "^9.2.1",
     "@eslint-react/eslint-plugin": "^2.0.1",
+    "@size-limit/preset-small-lib": "^12.0.0",
     "@svitejs/changesets-changelog-github-compact": "^1.2.0",
     "@tanstack/eslint-config": "0.3.2",
     "@tanstack/typedoc-config": "0.3.1",
@@ -66,6 +69,7 @@
     "react": "^19.2.1",
     "react-dom": "^19.2.1",
     "sherif": "^1.6.1",
+    "size-limit": "^12.0.0",
     "tinyglobby": "^0.2.15",
     "tsup": "^8.4.0",
     "typescript": "5.8.3",
@@ -85,5 +89,26 @@
       "@types/react": "^19.0.1",
       "@types/react-dom": "^19.0.2"
     }
-  }
+  },
+  "size-limit": [
+    {
+      "name": "react full",
+      "path": "packages/react-query/build/modern/index.js",
+      "limit": "12.02 kB",
+      "ignore": [
+        "react",
+        "react-dom"
+      ]
+    },
+    {
+      "name": "react minimal",
+      "path": "packages/react-query/build/modern/index.js",
+      "limit": "9.08 kB",
+      "import": "{ useQuery, QueryClient, QueryClientProvider }",
+      "ignore": [
+        "react",
+        "react-dom"
+      ]
+    }
+  ]
 }