mirror of https://github.com/pnpm/pnpm.git synced 2026-07-14 01:32:40 -04:00

Files

Zoltan Kochan 8e17c3d366 refactor: rename the pacquet/ directory to pnpm/ (#12913 )

Pure directory move plus path fixups: the Rust port ships as pnpm v12,
so the source tree now lives at pnpm/ (alongside pnpm11/, the frozen
TypeScript line). No identifiers change in this pass — crate names
(pacquet-*), the pacquet bin, PACQUET_VERSION, the @pacquet/* npm
package names v11's runPacquet spawns, the .pacquet virtual-store dir,
the benchmark harness's clone dir, and the pacquet-*.yml workflow
filenames (npm trusted publishing is bound to them) all stay for a
follow-up.

Also removes the root /pnpm/ .gitignore entry (build detritus in the
pre-pnpm11 package location): pnpm/ is real source now and must not be
ignored. Developers with a stale generated pnpm/ dir should delete it
before checking out this change.

2026-07-10 18:06:56 +02:00

fixture

refactor: move the TypeScript pnpm CLI into a pnpm11/ directory (#12537 )

2026-06-20 14:36:25 +02:00

bench.sh

refactor: rename the pacquet/ directory to pnpm/ (#12913 )

2026-07-10 18:06:56 +02:00

README.md

refactor: rename the pacquet/ directory to pnpm/ (#12913 )

2026-07-10 18:06:56 +02:00

README.md

pnpm Benchmarks

Compares pnpm install performance between the current branch (HEAD) and main, across the scenarios listed below.

This wrapper builds both pnpm revisions and runs hyperfine through the shared Rust orchestrator at pnpm/tasks/integrated-benchmark, so scenario / fixture / workspace / install-script / report generation stay consistent with the pacquet benchmark.

Prerequisites

cargo (install Rust via rustup if you don't have it).
hyperfine, pnpm, node, git on $PATH.

Usage

./pnpm11/benchmarks/bench.sh

The script:

Builds the integrated-benchmark binary in release mode.
Clones the current repo into the temp work-env once per revision (HEAD and main) and runs pnpm install && pnpm run compile-only in each to produce pnpm11/pnpm/dist/pnpm.mjs. compile-only skips the update-manifests pass that the root compile script does — it would rewrite tracked files and trigger a second install per revision, neither of which the bench needs.
Runs hyperfine on each scenario with --registry=npm (hits registry.npmjs.org directly, no proxy — same as before).
Writes a per-scenario BENCHMARK_REPORT.md / .json and a consolidated results.md into the temp work-env. The path is printed at the end of the run.
Emits bencher-results.json — a hyperfine-shaped file with one result per scenario (the @HEAD revision only, command renamed to the scenario name) that the Benchmarks GitHub Actions workflow uploads to Bencher for continuous tracking.

Scenarios

Slugs follow <linker>.<action>.<cache state>.<store state> so the leading segment groups runs by linker mode. Today there are two groups (isolated-linker.* and gvs-linker.*); future scenarios will add hoisted-linker.* and pnp-linker.*.

Every current scenario starts with node_modules wiped — "fresh" names that target state; future variants that begin with a populated node_modules will use a different action prefix. (For fresh-resolve the wipe also keeps the install's up-to-date short-circuit from skipping the measured resolution.)

#	Slug	Lockfile	Cache	Store	Description
1	`isolated-linker.fresh-restore.hot-cache.hot-store`	✔ frozen	hot	hot	Restore from lockfile with both directories hot (repeat-headless shape)
2	`isolated-linker.fresh-add-dep.hot-cache.hot-store`	✔ + add dep	hot	hot	`pnpm add <dep>` against an existing lockfile
3	`isolated-linker.fresh-install.hot-cache.hot-store`	✗	hot	hot	Resolve from scratch with both directories hot
4	`isolated-linker.fresh-restore.cold-cache.cold-store`	✔ frozen	cold	cold	Restore from lockfile with cold disks (typical CI shape)
5	`isolated-linker.fresh-install.cold-cache.cold-store`	✗	cold	cold	True cold start — no lockfile, nothing cached
6	`isolated-linker.fresh-resolve.hot-cache.offline`	✗ (removed per run)	hot	n/a	`install --offline --lockfile-only`: full re-resolution from the warm on-disk packument mirror — no network, no linking; guards offline/prefer-offline resolution (an online pre-warm pass primes the mirror first)
7	`gvs-linker.fresh-restore.hot-cache.hot-store`	✔ frozen	hot	hot + GVS	Frozen-lockfile restore with `enableGlobalVirtualStore: true`, pre-warmed GVS

All scenarios use --ignore-scripts and isolated store/cache directories per revision.

Fixture

The fixture lives at fixture/ — a synthetic package.json with ~80 typical front-end dependencies, plus a committed pnpm-lock.yaml (generated once with pnpm install --lockfile-only). The lockfile is checked in so every CI run starts from the same resolution graph regardless of registry drift.

Configuration

Environment variables read by bench.sh:

WARMUP — number of warmup runs before timing (default: 1)
RUNS — number of timed runs per benchmark (default: 10)