mirror of
https://github.com/oven-sh/bun
synced 2026-02-11 03:18:53 +00:00
## Summary Updates documentation for all major features and changes introduced in Bun v1.3.2 blog post. ## Changes ### Package Manager - ✅ Document `configVersion` system for controlling default linker behavior - ✅ Clarify that "existing projects (made pre-v1.3.2)" use hoisted installs for backward compatibility - ✅ Add smart postinstall script optimization with environment variable flags - ✅ Document improved Git dependency resolution with HTTP tarball optimization - ✅ Add `bun list` alias for `bun pm ls` ### Testing - ✅ Document new `onTestFinished` lifecycle hook with simple example - ✅ Add to lifecycle hooks table in test documentation ### Runtime & Performance - ✅ Add CPU profiling with `--cpu-prof` flag documentation - ✅ Place after memory usage section for better flow ### WebSockets - ✅ Add `subscriptions` getter to existing pub/sub example - ✅ Add TypeScript reference for the subscriptions property ## Documentation Improvements All documentation now consistently: - Uses "made pre-v1.3.2" to clarify existing project behavior - Simplifies default linker explanations with clear references to `/docs/pm/isolated-installs` - Uses `/docs/pm/isolated-installs` for all internal references - Avoids confusing technical details in favor of user-friendly summaries ## Files Modified - `docs/guides/install/add-git.mdx` - Added GitHub tarball optimization note - `docs/pm/cli/install.mdx` - Added installation strategies and smart postinstall docs - `docs/pm/cli/pm.mdx` - Added bun list alias - `docs/pm/isolated-installs.mdx` - Updated default behavior section with configVersion table - `docs/project/benchmarking.mdx` - Added CPU profiling section - `docs/runtime/bunfig.mdx` - Clarified install.linker defaults - `docs/runtime/http/websockets.mdx` - Added subscriptions to example and TypeScript interface - `docs/test/lifecycle.mdx` - Added onTestFinished hook documentation ## Diff ````diff diff --git a/docs/guides/install/add-git.mdx b/docs/guides/install/add-git.mdx index 70950e1a63..7f8f3c8d81 100644 --- a/docs/guides/install/add-git.mdx +++ b/docs/guides/install/add-git.mdx @@ -33,6 +33,8 @@ bun add git@github.com:lodash/lodash.git bun add github:colinhacks/zod ``` +**Note:** GitHub dependencies download via HTTP tarball when possible for faster installation. + --- See [Docs > Package manager](https://bun.com/docs/cli/install) for complete documentation of Bun's package manager. diff --git a/docs/pm/cli/install.mdx b/docs/pm/cli/install.mdx index 7affb62646..dde268b7e5 100644 --- a/docs/pm/cli/install.mdx +++ b/docs/pm/cli/install.mdx @@ -88,6 +88,13 @@ Lifecycle scripts will run in parallel during installation. To adjust the maximu bun install --concurrent-scripts 5 ``` +Bun automatically optimizes postinstall scripts for popular packages (like `esbuild`, `sharp`, etc.) by determining which scripts need to run. To disable these optimizations: + +```bash terminal icon="terminal" +BUN_FEATURE_FLAG_DISABLE_NATIVE_DEPENDENCY_LINKER=1 bun install +BUN_FEATURE_FLAG_DISABLE_IGNORE_SCRIPTS=1 bun install +``` + --- ## Workspaces @@ -231,7 +238,7 @@ Bun supports installing dependencies from Git, GitHub, and local or remotely-hos Bun supports two package installation strategies that determine how dependencies are organized in `node_modules`: -### Hoisted installs (default for single projects) +### Hoisted installs The traditional npm/Yarn approach that flattens dependencies into a shared `node_modules` directory: @@ -249,7 +256,15 @@ bun install --linker isolated Isolated installs create a central package store in `node_modules/.bun/` with symlinks in the top-level `node_modules`. This ensures packages can only access their declared dependencies. -For complete documentation on isolated installs, refer to [Package manager > Isolated installs](/pm/isolated-installs). +### Default strategy + +The default linker strategy depends on whether you're starting fresh or have an existing project: + +- **New workspaces/monorepos**: `isolated` (prevents phantom dependencies) +- **New single-package projects**: `hoisted` (traditional npm behavior) +- **Existing projects (made pre-v1.3.2)**: `hoisted` (preserves backward compatibility) + +The default is controlled by a `configVersion` field in your lockfile. For a detailed explanation, see [Package manager > Isolated installs](/docs/pm/isolated-installs). --- @@ -319,8 +334,7 @@ dryRun = false concurrentScripts = 16 # (cpu count or GOMAXPROCS) x2 # installation strategy: "hoisted" or "isolated" -# default: "hoisted" (for single-project projects) -# default: "isolated" (for monorepo projects) +# default varies by project type - see /docs/pm/isolated-installs linker = "hoisted" diff --git a/docs/pm/cli/pm.mdx b/docs/pm/cli/pm.mdx index fc297753d3..9c8faa7da1 100644 --- a/docs/pm/cli/pm.mdx +++ b/docs/pm/cli/pm.mdx @@ -115,6 +115,8 @@ To print a list of installed dependencies in the current project and their resol ```bash terminal icon="terminal" bun pm ls +# or +bun list ``` ```txt @@ -130,6 +132,8 @@ To print all installed dependencies, including nth-order dependencies. ```bash terminal icon="terminal" bun pm ls --all +# or +bun list --all ``` ```txt diff --git a/docs/pm/isolated-installs.mdx b/docs/pm/isolated-installs.mdx index 73c6748b15..17afe02fe1 100644 --- a/docs/pm/isolated-installs.mdx +++ b/docs/pm/isolated-installs.mdx @@ -5,7 +5,7 @@ description: "Strict dependency isolation similar to pnpm's approach" Bun provides an alternative package installation strategy called **isolated installs** that creates strict dependency isolation similar to pnpm's approach. This mode prevents phantom dependencies and ensures reproducible, deterministic builds. -This is the default installation strategy for monorepo projects. +This is the default installation strategy for **new** workspace/monorepo projects (with `configVersion = 1` in the lockfile). Existing projects continue using hoisted installs unless explicitly configured. ## What are isolated installs? @@ -43,8 +43,23 @@ linker = "isolated" ### Default behavior -- For monorepo projects, Bun uses the **isolated** installation strategy by default. -- For single-project projects, Bun uses the **hoisted** installation strategy by default. +The default linker strategy depends on your project's lockfile `configVersion`: + +| `configVersion` | Using workspaces? | Default Linker | +| --------------- | ----------------- | -------------- | +| `1` | ✅ | `isolated` | +| `1` | ❌ | `hoisted` | +| `0` | ✅ | `hoisted` | +| `0` | ❌ | `hoisted` | + +**New projects**: Default to `configVersion = 1`. In workspaces, v1 uses the isolated linker by default; otherwise it uses hoisted linking. + +**Existing Bun projects (made pre-v1.3.2)**: If your existing lockfile doesn't have a version yet, Bun sets `configVersion = 0` when you run `bun install`, preserving the previous hoisted linker default. + +**Migrations from other package managers**: + +- From pnpm: `configVersion = 1` (using isolated installs in workspaces) +- From npm or yarn: `configVersion = 0` (using hoisted installs) You can override the default behavior by explicitly specifying the `--linker` flag or setting it in your configuration file. diff --git a/docs/project/benchmarking.mdx b/docs/project/benchmarking.mdx index 1263a06729..2ab8bcafc8 100644 --- a/docs/project/benchmarking.mdx +++ b/docs/project/benchmarking.mdx @@ -216,3 +216,26 @@ numa nodes: 1 elapsed: 0.068 s process: user: 0.061 s, system: 0.014 s, faults: 0, rss: 57.4 MiB, commit: 64.0 MiB ``` + +## CPU profiling + +Profile JavaScript execution to identify performance bottlenecks with the `--cpu-prof` flag. + +```sh terminal icon="terminal" +bun --cpu-prof script.js +``` + +This generates a `.cpuprofile` file you can open in Chrome DevTools (Performance tab → Load profile) or VS Code's CPU profiler. + +### Options + +```sh terminal icon="terminal" +bun --cpu-prof --cpu-prof-name my-profile.cpuprofile script.js +bun --cpu-prof --cpu-prof-dir ./profiles script.js +``` + +| Flag | Description | +| ---------------------------- | -------------------- | +| `--cpu-prof` | Enable profiling | +| `--cpu-prof-name <filename>` | Set output filename | +| `--cpu-prof-dir <dir>` | Set output directory | diff --git a/docs/runtime/bunfig.mdx b/docs/runtime/bunfig.mdx index 91005c1607..5b7fe49823 100644 --- a/docs/runtime/bunfig.mdx +++ b/docs/runtime/bunfig.mdx @@ -497,9 +497,9 @@ print = "yarn" ### `install.linker` -Configure the default linker strategy. Default `"hoisted"` for single-project projects, `"isolated"` for monorepo projects. +Configure the linker strategy for installing dependencies. Defaults to `"isolated"` for new workspaces, `"hoisted"` for new single-package projects and existing projects (made pre-v1.3.2). -For complete documentation refer to [Package manager > Isolated installs](/pm/isolated-installs). +For complete documentation refer to [Package manager > Isolated installs](/docs/pm/isolated-installs). ```toml title="bunfig.toml" icon="settings" [install] diff --git a/docs/runtime/http/websockets.mdx b/docs/runtime/http/websockets.mdx index b33f37c29f..174043200d 100644 --- a/docs/runtime/http/websockets.mdx +++ b/docs/runtime/http/websockets.mdx @@ -212,6 +212,9 @@ const server = Bun.serve({ // this is a group chat // so the server re-broadcasts incoming message to everyone server.publish("the-group-chat", `${ws.data.username}: ${message}`); + + // inspect current subscriptions + console.log(ws.subscriptions); // ["the-group-chat"] }, close(ws) { const msg = `${ws.data.username} has left the chat`; @@ -393,6 +396,7 @@ interface ServerWebSocket { readonly data: any; readonly readyState: number; readonly remoteAddress: string; + readonly subscriptions: string[]; send(message: string | ArrayBuffer | Uint8Array, compress?: boolean): number; close(code?: number, reason?: string): void; subscribe(topic: string): void; diff --git a/docs/test/lifecycle.mdx b/docs/test/lifecycle.mdx index 6427175df6..3837f0e948 100644 --- a/docs/test/lifecycle.mdx +++ b/docs/test/lifecycle.mdx @@ -6,11 +6,12 @@ description: "Learn how to use beforeAll, beforeEach, afterEach, and afterAll li The test runner supports the following lifecycle hooks. This is useful for loading test fixtures, mocking data, and configuring the test environment. | Hook | Description | -| ------------ | --------------------------- | +| ---------------- | ---------------------------------------------------------- | | `beforeAll` | Runs once before all tests. | | `beforeEach` | Runs before each test. | | `afterEach` | Runs after each test. | | `afterAll` | Runs once after all tests. | +| `onTestFinished` | Runs after a single test finishes (after all `afterEach`). | ## Per-Test Setup and Teardown @@ -90,6 +91,23 @@ describe("test group", () => { }); ``` +### `onTestFinished` + +Use `onTestFinished` to run a callback after a single test completes. It runs after all `afterEach` hooks. + +```ts title="test.ts" icon="/icons/typescript.svg" +import { test, onTestFinished } from "bun:test"; + +test("cleanup after test", () => { + onTestFinished(() => { + // runs after all afterEach hooks + console.log("test finished"); + }); +}); +``` + +Not supported in concurrent tests; use `test.serial` instead. + ## Global Setup and Teardown To scope the hooks to an entire multi-file test run, define the hooks in a separate file. ```` 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Bot <claude-bot@bun.sh> Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: Michael H <git@riskymh.dev> Co-authored-by: Lydia Hallie <lydiajuliettehallie@gmail.com>
324 lines
7.1 KiB
Plaintext
324 lines
7.1 KiB
Plaintext
---
|
|
title: "bun pm"
|
|
description: "Package manager utilities"
|
|
---
|
|
|
|
The `bun pm` command group provides a set of utilities for working with Bun's package manager.
|
|
|
|
## pack
|
|
|
|
To create a tarball of the current workspace:
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm pack
|
|
```
|
|
|
|
This command creates a `.tgz` file containing all files that would be published to npm, following the same rules as `npm pack`.
|
|
|
|
## Examples
|
|
|
|
Basic usage:
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm pack
|
|
# Creates my-package-1.0.0.tgz in current directory
|
|
```
|
|
|
|
Quiet mode for scripting:
|
|
|
|
```bash terminal icon="terminal"
|
|
TARBALL=$(bun pm pack --quiet)
|
|
echo "Created: $TARBALL"
|
|
```
|
|
|
|
```txt
|
|
Created: my-package-1.0.0.tgz
|
|
```
|
|
|
|
Custom destination:
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm pack --destination ./dist
|
|
# Saves tarball in ./dist/ directory
|
|
```
|
|
|
|
## Options
|
|
|
|
- `--dry-run`: Perform all tasks except writing the tarball to disk. Shows what would be included.
|
|
- `--destination <dir>`: Specify the directory where the tarball will be saved.
|
|
- `--filename <name>`: Specify an exact file name for the tarball to be saved at.
|
|
- `--ignore-scripts`: Skip running pre/postpack and prepare scripts.
|
|
- `--gzip-level <0-9>`: Set a custom compression level for gzip, ranging from 0 to 9 (default is 9).
|
|
- `--quiet`: Only output the tarball filename, suppressing verbose output. Ideal for scripts and automation.
|
|
|
|
> **Note:** `--filename` and `--destination` cannot be used at the same time.
|
|
|
|
## Output Modes
|
|
|
|
**Default output:**
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm pack
|
|
```
|
|
|
|
```txt
|
|
bun pack v1.2.19
|
|
|
|
packed 131B package.json
|
|
packed 40B index.js
|
|
|
|
my-package-1.0.0.tgz
|
|
|
|
Total files: 2
|
|
Shasum: f2451d6eb1e818f500a791d9aace80b394258a90
|
|
Unpacked size: 171B
|
|
Packed size: 249B
|
|
```
|
|
|
|
**Quiet output:**
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm pack --quiet
|
|
```
|
|
|
|
```txt
|
|
my-package-1.0.0.tgz
|
|
```
|
|
|
|
The `--quiet` flag is particularly useful for automation workflows where you need to capture the generated tarball filename for further processing.
|
|
|
|
## bin
|
|
|
|
To print the path to the `bin` directory for the local project:
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm bin
|
|
```
|
|
|
|
```txt
|
|
/path/to/current/project/node_modules/.bin
|
|
```
|
|
|
|
To print the path to the global `bin` directory:
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm bin -g
|
|
```
|
|
|
|
```txt
|
|
<$HOME>/.bun/bin
|
|
```
|
|
|
|
## ls
|
|
|
|
To print a list of installed dependencies in the current project and their resolved versions, excluding their dependencies.
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm ls
|
|
# or
|
|
bun list
|
|
```
|
|
|
|
```txt
|
|
/path/to/project node_modules (135)
|
|
├── eslint@8.38.0
|
|
├── react@18.2.0
|
|
├── react-dom@18.2.0
|
|
├── typescript@5.0.4
|
|
└── zod@3.21.4
|
|
```
|
|
|
|
To print all installed dependencies, including nth-order dependencies.
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm ls --all
|
|
# or
|
|
bun list --all
|
|
```
|
|
|
|
```txt
|
|
/path/to/project node_modules (135)
|
|
├── @eslint-community/eslint-utils@4.4.0
|
|
├── @eslint-community/regexpp@4.5.0
|
|
├── @eslint/eslintrc@2.0.2
|
|
├── @eslint/js@8.38.0
|
|
├── @nodelib/fs.scandir@2.1.5
|
|
├── @nodelib/fs.stat@2.0.5
|
|
├── @nodelib/fs.walk@1.2.8
|
|
├── acorn@8.8.2
|
|
├── acorn-jsx@5.3.2
|
|
├── ajv@6.12.6
|
|
├── ansi-regex@5.0.1
|
|
├── ...
|
|
```
|
|
|
|
## whoami
|
|
|
|
Print your npm username. Requires you to be logged in (`bunx npm login`) with credentials in either `bunfig.toml` or `.npmrc`:
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm whoami
|
|
```
|
|
|
|
## hash
|
|
|
|
To generate and print the hash of the current lockfile:
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm hash
|
|
```
|
|
|
|
To print the string used to hash the lockfile:
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm hash-string
|
|
```
|
|
|
|
To print the hash stored in the current lockfile:
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm hash-print
|
|
```
|
|
|
|
## cache
|
|
|
|
To print the path to Bun's global module cache:
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm cache
|
|
```
|
|
|
|
To clear Bun's global module cache:
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm cache rm
|
|
```
|
|
|
|
## migrate
|
|
|
|
To migrate another package manager's lockfile without installing anything:
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm migrate
|
|
```
|
|
|
|
## untrusted
|
|
|
|
To print current untrusted dependencies with scripts:
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm untrusted
|
|
```
|
|
|
|
```txt
|
|
./node_modules/@biomejs/biome @1.8.3
|
|
» [postinstall]: node scripts/postinstall.js
|
|
|
|
These dependencies had their lifecycle scripts blocked during install.
|
|
```
|
|
|
|
## trust
|
|
|
|
To run scripts for untrusted dependencies and add to `trustedDependencies`:
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm trust <names>
|
|
```
|
|
|
|
Options for the `trust` command:
|
|
|
|
- `--all`: Trust all untrusted dependencies.
|
|
|
|
## default-trusted
|
|
|
|
To print the default trusted dependencies list:
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm default-trusted
|
|
```
|
|
|
|
see the current list on GitHub [here](https://github.com/oven-sh/bun/blob/main/src/install/default-trusted-dependencies.txt)
|
|
|
|
## version
|
|
|
|
To display current package version and help:
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm version
|
|
```
|
|
|
|
```txt
|
|
bun pm version v1.3.2 (ca7428e9)
|
|
Current package version: v1.0.0
|
|
|
|
Increment:
|
|
patch 1.0.0 → 1.0.1
|
|
minor 1.0.0 → 1.1.0
|
|
major 1.0.0 → 2.0.0
|
|
prerelease 1.0.0 → 1.0.1-0
|
|
prepatch 1.0.0 → 1.0.1-0
|
|
preminor 1.0.0 → 1.1.0-0
|
|
premajor 1.0.0 → 2.0.0-0
|
|
from-git Use version from latest git tag
|
|
1.2.3 Set specific version
|
|
|
|
Options:
|
|
--no-git-tag-version Skip git operations
|
|
--allow-same-version Prevents throwing error if version is the same
|
|
--message=<val>, -m Custom commit message, use %s for version substitution
|
|
--preid=<val> Prerelease identifier (i.e beta → 1.0.1-beta.0)
|
|
--force, -f Bypass dirty git history check
|
|
|
|
Examples:
|
|
bun pm version patch
|
|
bun pm version 1.2.3 --no-git-tag-version
|
|
bun pm version prerelease --preid beta --message "Release beta: %s"
|
|
```
|
|
|
|
To bump the version in `package.json`:
|
|
|
|
```bash terminal icon="terminal"
|
|
bun pm version patch
|
|
```
|
|
|
|
```txt
|
|
v1.0.1
|
|
```
|
|
|
|
Supports `patch`, `minor`, `major`, `premajor`, `preminor`, `prepatch`, `prerelease`, `from-git`, or specific versions like `1.2.3`. By default creates git commit and tag unless `--no-git-tag-version` was used to skip.
|
|
|
|
## pkg
|
|
|
|
Manage `package.json` data with get, set, delete, and fix operations.
|
|
|
|
All commands support dot and bracket notation:
|
|
|
|
```bash terminal icon="terminal"
|
|
scripts.build # dot notation
|
|
contributors[0] # array access
|
|
workspaces.0 # dot with numeric index
|
|
scripts[test:watch] # bracket for special chars
|
|
```
|
|
|
|
Examples:
|
|
|
|
```bash terminal icon="terminal"
|
|
# set
|
|
bun pm pkg get name # single property
|
|
bun pm pkg get name version # multiple properties
|
|
bun pm pkg get # entire package.json
|
|
bun pm pkg get scripts.build # nested property
|
|
|
|
# set
|
|
bun pm pkg set name="my-package" # simple property
|
|
bun pm pkg set scripts.test="jest" version=2.0.0 # multiple properties
|
|
bun pm pkg set {"private":"true"} --json # JSON values with --json flag
|
|
|
|
# delete
|
|
bun pm pkg delete description # single property
|
|
bun pm pkg delete scripts.test contributors[0] # multiple/nested
|
|
|
|
# fix
|
|
bun pm pkg fix # auto-fix common issues
|
|
```
|