mirror of
https://github.com/TanStack/router.git
synced 2026-11-16 19:38:07 +00:00
|
History
|
||
|---|---|---|
| .. | ||
| results | ||
| scenarios | ||
| .gitignore | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
Bundle Size Benchmarks
This workspace contains deterministic bundle-size fixtures for:
@tanstack/react-router@tanstack/solid-router@tanstack/vue-router@tanstack/react-start@tanstack/solid-start
Each package has two scenarios:
minimal: Small route app with__root+ index route that rendershello worldfull: Same route shape plus a broad root-level harness that imports/uses the full hooks/components surface- Start
fullscenarios also exercisecreateServerFn,createMiddleware, anduseServerFn
Design Notes
- Scenarios use file-based routing as the default app style.
- Router scenarios use
@tanstack/router-plugin/vitewithautoCodeSplitting: true. - Start scenarios use
@tanstack/<framework>-start/plugin/vitewith router code-splitting enabled. - Full-surface coverage is manually maintained (no strict export-coverage gate).
- Metrics are measured from initial-load JS graph only and reported as raw/gzip/brotli bytes.
- Gzip is the primary tracking signal for PR deltas and historical charting.
Local Run
pnpm nx run @benchmarks/bundle-size:build
This writes:
benchmarks/bundle-size/results/current.jsonbenchmarks/bundle-size/results/benchmark-action.json
CI Reporting
- PR workflow generates a sticky comment with:
- current gzip values
- baseline delta
- inline sparkline trend
- Pushes to
mainpublish historical chart data to GitHub Pages viabenchmark-action/github-action-benchmark.
Manual Update Policy
When router/start public hooks/components evolve, update the corresponding *-full/src/routes/__root.tsx harness to keep full scenarios representative.
Backfill Readiness
The measurement script supports optional interfaces for historical backfilling:
--sha--measured-at--append-history
These are intended for one-off scripts that replay historical commits and append results to the same history dataset shape used for chart generation.
If --append-history points at a data.js file, output is written as window.BENCHMARK_DATA = ... for direct GitHub Pages compatibility.