bun-types 1.2.19-canary.20250717T140556 → 1.2.19-canary.20250719T140529

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/api/fetch.md CHANGED
@@ -337,7 +337,7 @@ This will print the request and response headers to your terminal:
337
337
  ```sh
338
338
  [fetch] > HTTP/1.1 GET http://example.com/
339
339
  [fetch] > Connection: keep-alive
340
- [fetch] > User-Agent: Bun/1.2.19-canary.20250717T140556
340
+ [fetch] > User-Agent: Bun/1.2.19-canary.20250719T140529
341
341
  [fetch] > Accept: */*
342
342
  [fetch] > Host: example.com
343
343
  [fetch] > Accept-Encoding: gzip, deflate, br
package/docs/api/spawn.md CHANGED
@@ -140,7 +140,7 @@ You can read results from the subprocess via the `stdout` and `stderr` propertie
140
140
  ```ts
141
141
  const proc = Bun.spawn(["bun", "--version"]);
142
142
  const text = await proc.stdout.text();
143
- console.log(text); // => "1.2.19-canary.20250717T140556\n"
143
+ console.log(text); // => "1.2.19-canary.20250719T140529\n"
144
144
  ```
145
145
 
146
146
  Configure the output stream by passing one of the following values to `stdout/stderr`:
@@ -88,6 +88,20 @@ The order of the `--target` flag does not matter, as long as they're delimited b
88
88
 
89
89
  On x64 platforms, Bun uses SIMD optimizations which require a modern CPU supporting AVX2 instructions. The `-baseline` build of Bun is for older CPUs that don't support these optimizations. Normally, when you install Bun we automatically detect which version to use but this can be harder to do when cross-compiling since you might not know the target CPU. You usually don't need to worry about it on Darwin x64, but it is relevant for Windows x64 and Linux x64. If you or your users see `"Illegal instruction"` errors, you might need to use the baseline version.
90
90
 
91
+ ## Build-time constants
92
+
93
+ Use the `--define` flag to inject build-time constants into your executable, such as version numbers, build timestamps, or configuration values:
94
+
95
+ ```bash
96
+ $ bun build --compile --define BUILD_VERSION='"1.2.3"' --define BUILD_TIME='"2024-01-15T10:30:00Z"' src/cli.ts --outfile mycli
97
+ ```
98
+
99
+ These constants are embedded directly into your compiled binary at build time, providing zero runtime overhead and enabling dead code elimination optimizations.
100
+
101
+ {% callout type="info" %}
102
+ For comprehensive examples and advanced patterns, see the [Build-time constants guide](/guides/runtime/build-time-constants).
103
+ {% /callout %}
104
+
91
105
  ## Deploying to production
92
106
 
93
107
  Compiled executables reduce memory usage and improve Bun's start time.
@@ -183,6 +183,30 @@ Bun supports installing dependencies from Git, GitHub, and local or remotely-hos
183
183
  }
184
184
  ```
185
185
 
186
+ ## Installation strategies
187
+
188
+ Bun supports two package installation strategies that determine how dependencies are organized in `node_modules`:
189
+
190
+ ### Hoisted installs (default for single projects)
191
+
192
+ The traditional npm/Yarn approach that flattens dependencies into a shared `node_modules` directory:
193
+
194
+ ```bash
195
+ $ bun install --linker hoisted
196
+ ```
197
+
198
+ ### Isolated installs
199
+
200
+ A pnpm-like approach that creates strict dependency isolation to prevent phantom dependencies:
201
+
202
+ ```bash
203
+ $ bun install --linker isolated
204
+ ```
205
+
206
+ 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.
207
+
208
+ For complete documentation on isolated installs, refer to [Package manager > Isolated installs](https://bun.com/docs/install/isolated).
209
+
186
210
  ## Configuration
187
211
 
188
212
  The default behavior of `bun install` can be configured in `bunfig.toml`. The default values are shown below.
@@ -213,6 +237,10 @@ dryRun = false
213
237
 
214
238
  # equivalent to `--concurrent-scripts` flag
215
239
  concurrentScripts = 16 # (cpu count or GOMAXPROCS) x2
240
+
241
+ # installation strategy: "hoisted" or "isolated"
242
+ # default: "hoisted"
243
+ linker = "hoisted"
216
244
  ```
217
245
 
218
246
  ## CI/CD
package/docs/cli/pm.md CHANGED
@@ -213,7 +213,7 @@ To display current package version and help:
213
213
 
214
214
  ```bash
215
215
  $ bun pm version
216
- bun pm version v1.2.19-canary.20250717T140556 (ca7428e9)
216
+ bun pm version v1.2.19-canary.20250719T140529 (ca7428e9)
217
217
  Current package version: v1.0.0
218
218
 
219
219
  Increment:
@@ -7,7 +7,7 @@ Use `bun publish` to publish a package to the npm registry.
7
7
  $ bun publish
8
8
 
9
9
  ## Output
10
- bun publish v1.2.19-canary.20250717T140556 (ca7428e9)
10
+ bun publish v1.2.19-canary.20250719T140529 (ca7428e9)
11
11
 
12
12
  packed 203B package.json
13
13
  packed 224B README.md
package/docs/cli/test.md CHANGED
@@ -248,4 +248,33 @@ $ bun test foo
248
248
 
249
249
  Any test file in the directory with an _absolute path_ that contains one of the targets will run. Glob patterns are not yet supported. -->
250
250
 
251
+ ## AI Agent Integration
252
+
253
+ When using Bun's test runner with AI coding assistants, you can enable quieter output to improve readability and reduce context noise. This feature minimizes test output verbosity while preserving essential failure information.
254
+
255
+ ### Environment Variables
256
+
257
+ Set any of the following environment variables to enable AI-friendly output:
258
+
259
+ - `CLAUDECODE=1` - For Claude Code
260
+ - `REPL_ID=1` - For Replit
261
+ - `AGENT=1` - Generic AI agent flag
262
+
263
+ ### Behavior
264
+
265
+ When an AI agent environment is detected:
266
+
267
+ - Only test failures are displayed in detail
268
+ - Passing, skipped, and todo test indicators are hidden
269
+ - Summary statistics remain intact
270
+
271
+ ```bash
272
+ # Example: Enable quiet output for Claude Code
273
+ $ CLAUDECODE=1 bun test
274
+
275
+ # Still shows failures and summary, but hides verbose passing test output
276
+ ```
277
+
278
+ This feature is particularly useful in AI-assisted development workflows where reduced output verbosity improves context efficiency while maintaining visibility into test failures.
279
+
251
280
  {% bunCLIUsage command="test" /%}
@@ -9,7 +9,7 @@ $ bunx nuxi init my-nuxt-app
9
9
  ✔ Which package manager would you like to use?
10
10
  bun
11
11
  ◐ Installing dependencies...
12
- bun install v1.2.19-canary.20250717T140556 (16b4bf34)
12
+ bun install v1.2.19-canary.20250719T140529 (16b4bf34)
13
13
  + @nuxt/devtools@0.8.2
14
14
  + nuxt@3.7.0
15
15
  785 packages installed [2.67s]
@@ -15,7 +15,7 @@ This will add the package to `peerDependencies` in `package.json`.
15
15
  ```json-diff
16
16
  {
17
17
  "peerDependencies": {
18
- + "@types/bun": "^1.2.19-canary.20250717T140556"
18
+ + "@types/bun": "^1.2.19-canary.20250719T140529"
19
19
  }
20
20
  }
21
21
  ```
@@ -27,7 +27,7 @@ Running `bun install` will install peer dependencies by default, unless marked o
27
27
  ```json-diff
28
28
  {
29
29
  "peerDependencies": {
30
- "@types/bun": "^1.2.19-canary.20250717T140556"
30
+ "@types/bun": "^1.2.19-canary.20250719T140529"
31
31
  },
32
32
  "peerDependenciesMeta": {
33
33
  + "@types/bun": {
@@ -97,7 +97,7 @@ $ bun update
97
97
  $ bun update @types/bun --latest
98
98
 
99
99
  # Update a dependency to a specific version
100
- $ bun update @types/bun@1.2.19-canary.20250717T140556
100
+ $ bun update @types/bun@1.2.19-canary.20250719T140529
101
101
 
102
102
  # Update all dependencies to the latest versions
103
103
  $ bun update --latest
@@ -0,0 +1,293 @@
1
+ ---
2
+ name: Build-time constants with --define
3
+ ---
4
+
5
+ The `--define` flag can be used with `bun build` and `bun build --compile` to inject build-time constants into your application. This is especially useful for embedding metadata like build versions, timestamps, or configuration flags directly into your compiled executables.
6
+
7
+ ```sh
8
+ $ bun build --compile --define BUILD_VERSION='"1.2.3"' --define BUILD_TIME='"2024-01-15T10:30:00Z"' src/index.ts --outfile myapp
9
+ ```
10
+
11
+ ---
12
+
13
+ ## Why use build-time constants?
14
+
15
+ Build-time constants are embedded directly into your compiled code, making them:
16
+
17
+ - **Zero runtime overhead** - No environment variable lookups or file reads
18
+ - **Immutable** - Values are baked into the binary at compile time
19
+ - **Optimizable** - Dead code elimination can remove unused branches
20
+ - **Secure** - No external dependencies or configuration files to manage
21
+
22
+ This is similar to `gcc -D` or `#define` in C/C++, but for JavaScript/TypeScript.
23
+
24
+ ---
25
+
26
+ ## Basic usage
27
+
28
+ ### With `bun build`
29
+
30
+ ```sh
31
+ # Bundle with build-time constants
32
+ $ bun build --define BUILD_VERSION='"1.0.0"' --define NODE_ENV='"production"' src/index.ts --outdir ./dist
33
+ ```
34
+
35
+ ### With `bun build --compile`
36
+
37
+ ```sh
38
+ # Compile to executable with build-time constants
39
+ $ bun build --compile --define BUILD_VERSION='"1.0.0"' --define BUILD_TIME='"2024-01-15T10:30:00Z"' src/cli.ts --outfile mycli
40
+ ```
41
+
42
+ ### JavaScript API
43
+
44
+ ```ts
45
+ await Bun.build({
46
+ entrypoints: ["./src/index.ts"],
47
+ outdir: "./dist",
48
+ define: {
49
+ BUILD_VERSION: '"1.0.0"',
50
+ BUILD_TIME: '"2024-01-15T10:30:00Z"',
51
+ DEBUG: "false",
52
+ },
53
+ });
54
+ ```
55
+
56
+ ---
57
+
58
+ ## Common use cases
59
+
60
+ ### Version information
61
+
62
+ Embed version and build metadata directly into your executable:
63
+
64
+ {% codetabs %}
65
+
66
+ ```ts#src/version.ts
67
+ // These constants are replaced at build time
68
+ declare const BUILD_VERSION: string;
69
+ declare const BUILD_TIME: string;
70
+ declare const GIT_COMMIT: string;
71
+
72
+ export function getVersion() {
73
+ return {
74
+ version: BUILD_VERSION,
75
+ buildTime: BUILD_TIME,
76
+ commit: GIT_COMMIT,
77
+ };
78
+ }
79
+ ```
80
+
81
+ ```sh#Build command
82
+ $ bun build --compile \
83
+ --define BUILD_VERSION='"1.2.3"' \
84
+ --define BUILD_TIME='"2024-01-15T10:30:00Z"' \
85
+ --define GIT_COMMIT='"abc123"' \
86
+ src/cli.ts --outfile mycli
87
+ ```
88
+
89
+ {% /codetabs %}
90
+
91
+ ### Feature flags
92
+
93
+ Use build-time constants to enable/disable features:
94
+
95
+ ```ts
96
+ // Replaced at build time
97
+ declare const ENABLE_ANALYTICS: boolean;
98
+ declare const ENABLE_DEBUG: boolean;
99
+
100
+ function trackEvent(event: string) {
101
+ if (ENABLE_ANALYTICS) {
102
+ // This entire block is removed if ENABLE_ANALYTICS is false
103
+ console.log("Tracking:", event);
104
+ }
105
+ }
106
+
107
+ if (ENABLE_DEBUG) {
108
+ console.log("Debug mode enabled");
109
+ }
110
+ ```
111
+
112
+ ```sh
113
+ # Production build - analytics enabled, debug disabled
114
+ $ bun build --compile --define ENABLE_ANALYTICS=true --define ENABLE_DEBUG=false src/app.ts --outfile app-prod
115
+
116
+ # Development build - both enabled
117
+ $ bun build --compile --define ENABLE_ANALYTICS=false --define ENABLE_DEBUG=true src/app.ts --outfile app-dev
118
+ ```
119
+
120
+ ### Configuration
121
+
122
+ Replace configuration objects at build time:
123
+
124
+ ```ts
125
+ declare const CONFIG: {
126
+ apiUrl: string;
127
+ timeout: number;
128
+ retries: number;
129
+ };
130
+
131
+ // CONFIG is replaced with the actual object at build time
132
+ const response = await fetch(CONFIG.apiUrl, {
133
+ timeout: CONFIG.timeout,
134
+ });
135
+ ```
136
+
137
+ ```sh
138
+ $ bun build --compile --define 'CONFIG={"apiUrl":"https://api.example.com","timeout":5000,"retries":3}' src/app.ts --outfile app
139
+ ```
140
+
141
+ ---
142
+
143
+ ## Advanced patterns
144
+
145
+ ### Environment-specific builds
146
+
147
+ Create different executables for different environments:
148
+
149
+ ```json
150
+ {
151
+ "scripts": {
152
+ "build:dev": "bun build --compile --define NODE_ENV='\"development\"' --define API_URL='\"http://localhost:3000\"' src/app.ts --outfile app-dev",
153
+ "build:staging": "bun build --compile --define NODE_ENV='\"staging\"' --define API_URL='\"https://staging.example.com\"' src/app.ts --outfile app-staging",
154
+ "build:prod": "bun build --compile --define NODE_ENV='\"production\"' --define API_URL='\"https://api.example.com\"' src/app.ts --outfile app-prod"
155
+ }
156
+ }
157
+ ```
158
+
159
+ ### Using shell commands for dynamic values
160
+
161
+ Generate build-time constants from shell commands:
162
+
163
+ ```sh
164
+ # Use git to get current commit and timestamp
165
+ $ bun build --compile \
166
+ --define BUILD_VERSION="\"$(git describe --tags --always)\"" \
167
+ --define BUILD_TIME="\"$(date -u +%Y-%m-%dT%H:%M:%SZ)\"" \
168
+ --define GIT_COMMIT="\"$(git rev-parse HEAD)\"" \
169
+ src/cli.ts --outfile mycli
170
+ ```
171
+
172
+ ### Build automation script
173
+
174
+ Create a build script that automatically injects build metadata:
175
+
176
+ ```ts
177
+ // build.ts
178
+ import { $ } from "bun";
179
+
180
+ const version = await $`git describe --tags --always`.text();
181
+ const buildTime = new Date().toISOString();
182
+ const gitCommit = await $`git rev-parse HEAD`.text();
183
+
184
+ await Bun.build({
185
+ entrypoints: ["./src/cli.ts"],
186
+ outdir: "./dist",
187
+ define: {
188
+ BUILD_VERSION: JSON.stringify(version.trim()),
189
+ BUILD_TIME: JSON.stringify(buildTime),
190
+ GIT_COMMIT: JSON.stringify(gitCommit.trim()),
191
+ },
192
+ });
193
+
194
+ console.log(`Built with version ${version.trim()}`);
195
+ ```
196
+
197
+ ---
198
+
199
+ ## Important considerations
200
+
201
+ ### Value format
202
+
203
+ Values must be valid JSON that will be parsed and inlined as JavaScript expressions:
204
+
205
+ ```sh
206
+ # ✅ Strings must be JSON-quoted
207
+ --define VERSION='"1.0.0"'
208
+
209
+ # ✅ Numbers are JSON literals
210
+ --define PORT=3000
211
+
212
+ # ✅ Booleans are JSON literals
213
+ --define DEBUG=true
214
+
215
+ # ✅ Objects and arrays (use single quotes to wrap the JSON)
216
+ --define 'CONFIG={"host":"localhost","port":3000}'
217
+
218
+ # ✅ Arrays work too
219
+ --define 'FEATURES=["auth","billing","analytics"]'
220
+
221
+ # ❌ This won't work - missing quotes around string
222
+ --define VERSION=1.0.0
223
+ ```
224
+
225
+ ### Property keys
226
+
227
+ You can use property access patterns as keys, not just simple identifiers:
228
+
229
+ ```sh
230
+ # ✅ Replace process.env.NODE_ENV with "production"
231
+ --define 'process.env.NODE_ENV="production"'
232
+
233
+ # ✅ Replace process.env.API_KEY with the actual key
234
+ --define 'process.env.API_KEY="abc123"'
235
+
236
+ # ✅ Replace nested properties
237
+ --define 'window.myApp.version="1.0.0"'
238
+
239
+ # ✅ Replace array access
240
+ --define 'process.argv[2]="--production"'
241
+ ```
242
+
243
+ This is particularly useful for environment variables:
244
+
245
+ ```ts
246
+ // Before compilation
247
+ if (process.env.NODE_ENV === "production") {
248
+ console.log("Production mode");
249
+ }
250
+
251
+ // After compilation with --define 'process.env.NODE_ENV="production"'
252
+ if ("production" === "production") {
253
+ console.log("Production mode");
254
+ }
255
+
256
+ // After optimization
257
+ console.log("Production mode");
258
+ ```
259
+
260
+ ### TypeScript declarations
261
+
262
+ For TypeScript projects, declare your constants to avoid type errors:
263
+
264
+ ```ts
265
+ // types/build-constants.d.ts
266
+ declare const BUILD_VERSION: string;
267
+ declare const BUILD_TIME: string;
268
+ declare const NODE_ENV: "development" | "staging" | "production";
269
+ declare const DEBUG: boolean;
270
+ ```
271
+
272
+ ### Cross-platform compatibility
273
+
274
+ When building for multiple platforms, constants work the same way:
275
+
276
+ ```sh
277
+ # Linux
278
+ $ bun build --compile --target=bun-linux-x64 --define PLATFORM='"linux"' src/app.ts --outfile app-linux
279
+
280
+ # macOS
281
+ $ bun build --compile --target=bun-darwin-x64 --define PLATFORM='"darwin"' src/app.ts --outfile app-macos
282
+
283
+ # Windows
284
+ $ bun build --compile --target=bun-windows-x64 --define PLATFORM='"windows"' src/app.ts --outfile app-windows.exe
285
+ ```
286
+
287
+ ---
288
+
289
+ ## Related
290
+
291
+ - [Define constants at runtime](/guides/runtime/define-constant) - Using `--define` with `bun run`
292
+ - [Building executables](/bundler/executables) - Complete guide to `bun build --compile`
293
+ - [Bundler API](/bundler) - Full bundler documentation including `define` option
@@ -21,7 +21,7 @@ Here's what the output of a typical test run looks like. In this case, there are
21
21
 
22
22
  ```sh
23
23
  $ bun test
24
- bun test v1.2.19-canary.20250717T140556 (9c68abdb)
24
+ bun test v1.2.19-canary.20250719T140529 (9c68abdb)
25
25
 
26
26
  test.test.js:
27
27
  ✓ add [0.87ms]
@@ -47,7 +47,7 @@ To only run certain test files, pass a positional argument to `bun test`. The ru
47
47
 
48
48
  ```sh
49
49
  $ bun test test3
50
- bun test v1.2.19-canary.20250717T140556 (9c68abdb)
50
+ bun test v1.2.19-canary.20250719T140529 (9c68abdb)
51
51
 
52
52
  test3.test.js:
53
53
  ✓ add [1.40ms]
@@ -85,7 +85,7 @@ Adding `-t add` will only run tests with "add" in the name. This works with test
85
85
 
86
86
  ```sh
87
87
  $ bun test -t add
88
- bun test v1.2.19-canary.20250717T140556 (9c68abdb)
88
+ bun test v1.2.19-canary.20250719T140529 (9c68abdb)
89
89
 
90
90
  test.test.js:
91
91
  ✓ add [1.79ms]
@@ -18,7 +18,7 @@ The first time this test is executed, Bun will evaluate the value passed into `e
18
18
 
19
19
  ```sh
20
20
  $ bun test test/snap
21
- bun test v1.2.19-canary.20250717T140556 (9c68abdb)
21
+ bun test v1.2.19-canary.20250719T140529 (9c68abdb)
22
22
 
23
23
  test/snap.test.ts:
24
24
  ✓ snapshot [1.48ms]
@@ -61,7 +61,7 @@ Later, when this test file is executed again, Bun will read the snapshot file an
61
61
 
62
62
  ```sh
63
63
  $ bun test
64
- bun test v1.2.19-canary.20250717T140556 (9c68abdb)
64
+ bun test v1.2.19-canary.20250719T140529 (9c68abdb)
65
65
 
66
66
  test/snap.test.ts:
67
67
  ✓ snapshot [1.05ms]
@@ -78,7 +78,7 @@ To update snapshots, use the `--update-snapshots` flag.
78
78
 
79
79
  ```sh
80
80
  $ bun test --update-snapshots
81
- bun test v1.2.19-canary.20250717T140556 (9c68abdb)
81
+ bun test v1.2.19-canary.20250719T140529 (9c68abdb)
82
82
 
83
83
  test/snap.test.ts:
84
84
  ✓ snapshot [0.86ms]
@@ -29,7 +29,7 @@ To regenerate snapshots, use the `--update-snapshots` flag.
29
29
 
30
30
  ```sh
31
31
  $ bun test --update-snapshots
32
- bun test v1.2.19-canary.20250717T140556 (9c68abdb)
32
+ bun test v1.2.19-canary.20250719T140529 (9c68abdb)
33
33
 
34
34
  test/snap.test.ts:
35
35
  ✓ snapshot [0.86ms]
@@ -5,7 +5,7 @@ name: Get the current Bun version
5
5
  Get the current version of Bun in a semver format.
6
6
 
7
7
  ```ts#index.ts
8
- Bun.version; // => "1.2.19-canary.20250717T140556"
8
+ Bun.version; // => "1.2.19-canary.20250719T140529"
9
9
  ```
10
10
 
11
11
  ---
@@ -81,6 +81,14 @@ $ bun install --verbose # debug logging
81
81
  $ bun install --silent # no logging
82
82
  ```
83
83
 
84
+ To use isolated installs instead of the default hoisted strategy:
85
+
86
+ ```bash
87
+ $ bun install --linker isolated
88
+ ```
89
+
90
+ Isolated installs create strict dependency isolation similar to pnpm, preventing phantom dependencies and ensuring more deterministic builds. For complete documentation, see [Isolated installs](https://bun.com/docs/install/isolated).
91
+
84
92
  {% details summary="Configuring behavior" %}
85
93
  The default behavior of `bun install` can be configured in `bunfig.toml`:
86
94
 
@@ -110,6 +118,10 @@ dryRun = false
110
118
 
111
119
  # equivalent to `--concurrent-scripts` flag
112
120
  concurrentScripts = 16 # (cpu count or GOMAXPROCS) x2
121
+
122
+ # installation strategy: "hoisted" or "isolated"
123
+ # default: "hoisted"
124
+ linker = "hoisted"
113
125
  ```
114
126
 
115
127
  {% /details %}
@@ -0,0 +1,195 @@
1
+ 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.
2
+
3
+ ## What are isolated installs?
4
+
5
+ Isolated installs create a non-hoisted dependency structure where packages can only access their explicitly declared dependencies. This differs from the traditional "hoisted" installation strategy used by npm and Yarn, where dependencies are flattened into a shared `node_modules` directory.
6
+
7
+ ### Key benefits
8
+
9
+ - **Prevents phantom dependencies** — Packages cannot accidentally import dependencies they haven't declared
10
+ - **Deterministic resolution** — Same dependency tree regardless of what else is installed
11
+ - **Better for monorepos** — Workspace isolation prevents cross-contamination between packages
12
+ - **Reproducible builds** — More predictable resolution behavior across environments
13
+
14
+ ## Using isolated installs
15
+
16
+ ### Command line
17
+
18
+ Use the `--linker` flag to specify the installation strategy:
19
+
20
+ ```bash
21
+ # Use isolated installs
22
+ $ bun install --linker isolated
23
+
24
+ # Use traditional hoisted installs
25
+ $ bun install --linker hoisted
26
+ ```
27
+
28
+ ### Configuration file
29
+
30
+ Set the default linker strategy in your `bunfig.toml`:
31
+
32
+ ```toml
33
+ [install]
34
+ linker = "isolated"
35
+ ```
36
+
37
+ ### Default behavior
38
+
39
+ By default, Bun uses the **hoisted** installation strategy for all projects. To use isolated installs, you must explicitly specify the `--linker isolated` flag or set it in your configuration file.
40
+
41
+ ## How isolated installs work
42
+
43
+ ### Directory structure
44
+
45
+ Instead of hoisting dependencies, isolated installs create a two-tier structure:
46
+
47
+ ```
48
+ node_modules/
49
+ ├── .bun/ # Central package store
50
+ │ ├── package@1.0.0/ # Versioned package installations
51
+ │ │ └── node_modules/
52
+ │ │ └── package/ # Actual package files
53
+ │ ├── @scope+package@2.1.0/ # Scoped packages (+ replaces /)
54
+ │ │ └── node_modules/
55
+ │ │ └── @scope/
56
+ │ │ └── package/
57
+ │ └── ...
58
+ └── package-name -> .bun/package@1.0.0/node_modules/package # Symlinks
59
+ ```
60
+
61
+ ### Resolution algorithm
62
+
63
+ 1. **Central store** — All packages are installed in `node_modules/.bun/package@version/` directories
64
+ 2. **Symlinks** — Top-level `node_modules` contains symlinks pointing to the central store
65
+ 3. **Peer resolution** — Complex peer dependencies create specialized directory names
66
+ 4. **Deduplication** — Packages with identical package IDs and peer dependency sets are shared
67
+
68
+ ### Workspace handling
69
+
70
+ In monorepos, workspace dependencies are handled specially:
71
+
72
+ - **Workspace packages** — Symlinked directly to their source directories, not the store
73
+ - **Workspace dependencies** — Can access other workspace packages in the monorepo
74
+ - **External dependencies** — Installed in the isolated store with proper isolation
75
+
76
+ ## Comparison with hoisted installs
77
+
78
+ | Aspect | Hoisted (npm/Yarn) | Isolated (pnpm-like) |
79
+ | ------------------------- | ------------------------------------------ | --------------------------------------- |
80
+ | **Dependency access** | Packages can access any hoisted dependency | Packages only see declared dependencies |
81
+ | **Phantom dependencies** | ❌ Possible | ✅ Prevented |
82
+ | **Disk usage** | ✅ Lower (shared installs) | ✅ Similar (uses symlinks) |
83
+ | **Determinism** | ❌ Less deterministic | ✅ More deterministic |
84
+ | **Node.js compatibility** | ✅ Standard behavior | ✅ Compatible via symlinks |
85
+ | **Best for** | Single projects, legacy code | Monorepos, strict dependency management |
86
+
87
+ ## Advanced features
88
+
89
+ ### Peer dependency handling
90
+
91
+ Isolated installs handle peer dependencies through sophisticated resolution:
92
+
93
+ ```bash
94
+ # Package with peer dependencies creates specialized paths
95
+ node_modules/.bun/package@1.0.0_react@18.2.0/
96
+ ```
97
+
98
+ The directory name encodes both the package version and its peer dependency versions, ensuring each unique combination gets its own installation.
99
+
100
+ ### Backend strategies
101
+
102
+ Bun uses different file operation strategies for performance:
103
+
104
+ - **Clonefile** (macOS) — Copy-on-write filesystem clones for maximum efficiency
105
+ - **Hardlink** (Linux/Windows) — Hardlinks to save disk space
106
+ - **Copyfile** (fallback) — Full file copies when other methods aren't available
107
+
108
+ ### Debugging isolated installs
109
+
110
+ Enable verbose logging to understand the installation process:
111
+
112
+ ```bash
113
+ $ bun install --linker isolated --verbose
114
+ ```
115
+
116
+ This shows:
117
+
118
+ - Store entry creation
119
+ - Symlink operations
120
+ - Peer dependency resolution
121
+ - Deduplication decisions
122
+
123
+ ## Troubleshooting
124
+
125
+ ### Compatibility issues
126
+
127
+ Some packages may not work correctly with isolated installs due to:
128
+
129
+ - **Hardcoded paths** — Packages that assume a flat `node_modules` structure
130
+ - **Dynamic imports** — Runtime imports that don't follow Node.js resolution
131
+ - **Build tools** — Tools that scan `node_modules` directly
132
+
133
+ If you encounter issues, you can:
134
+
135
+ 1. **Switch to hoisted mode** for specific projects:
136
+
137
+ ```bash
138
+ $ bun install --linker hoisted
139
+ ```
140
+
141
+ 2. **Report compatibility issues** to help improve isolated install support
142
+
143
+ ### Performance considerations
144
+
145
+ - **Install time** — May be slightly slower due to symlink operations
146
+ - **Disk usage** — Similar to hoisted (uses symlinks, not file copies)
147
+ - **Memory usage** — Higher during install due to complex peer resolution
148
+
149
+ ## Migration guide
150
+
151
+ ### From npm/Yarn
152
+
153
+ ```bash
154
+ # Remove existing node_modules and lockfiles
155
+ $ rm -rf node_modules package-lock.json yarn.lock
156
+
157
+ # Install with isolated linker
158
+ $ bun install --linker isolated
159
+ ```
160
+
161
+ ### From pnpm
162
+
163
+ Isolated installs are conceptually similar to pnpm, so migration should be straightforward:
164
+
165
+ ```bash
166
+ # Remove pnpm files
167
+ $ rm -rf node_modules pnpm-lock.yaml
168
+
169
+ # Install with Bun's isolated linker
170
+ $ bun install --linker isolated
171
+ ```
172
+
173
+ The main difference is that Bun uses symlinks in `node_modules` while pnpm uses a global store with symlinks.
174
+
175
+ ## When to use isolated installs
176
+
177
+ **Use isolated installs when:**
178
+
179
+ - Working in monorepos with multiple packages
180
+ - Strict dependency management is required
181
+ - Preventing phantom dependencies is important
182
+ - Building libraries that need deterministic dependencies
183
+
184
+ **Use hoisted installs when:**
185
+
186
+ - Working with legacy code that assumes flat `node_modules`
187
+ - Compatibility with existing build tools is required
188
+ - Working in environments where symlinks aren't well supported
189
+ - You prefer the simpler traditional npm behavior
190
+
191
+ ## Related documentation
192
+
193
+ - [Package manager > Workspaces](https://bun.com/docs/install/workspaces) — Monorepo workspace management
194
+ - [Package manager > Lockfile](https://bun.com/docs/install/lockfile) — Understanding Bun's lockfile format
195
+ - [CLI > install](https://bun.com/docs/cli/install) — Complete `bun install` command reference
@@ -14,7 +14,7 @@ Kernel version 5.6 or higher is strongly recommended, but the minimum is 5.1. Us
14
14
  ```bash#macOS/Linux_(curl)
15
15
  $ curl -fsSL https://bun.com/install | bash # for macOS, Linux, and WSL
16
16
  # to install a specific version
17
- $ curl -fsSL https://bun.com/install | bash -s "bun-v1.2.19-canary.20250717T140556"
17
+ $ curl -fsSL https://bun.com/install | bash -s "bun-v1.2.19-canary.20250719T140529"
18
18
  ```
19
19
 
20
20
  ```bash#npm
@@ -189,10 +189,10 @@ Since Bun is a single binary, you can install older versions of Bun by re-runnin
189
189
 
190
190
  ### Installing a specific version of Bun on Linux/Mac
191
191
 
192
- To install a specific version of Bun, you can pass the git tag of the version you want to install to the install script, such as `bun-v1.2.0` or `bun-v1.2.19-canary.20250717T140556`.
192
+ To install a specific version of Bun, you can pass the git tag of the version you want to install to the install script, such as `bun-v1.2.0` or `bun-v1.2.19-canary.20250719T140529`.
193
193
 
194
194
  ```sh
195
- $ curl -fsSL https://bun.com/install | bash -s "bun-v1.2.19-canary.20250717T140556"
195
+ $ curl -fsSL https://bun.com/install | bash -s "bun-v1.2.19-canary.20250719T140529"
196
196
  ```
197
197
 
198
198
  ### Installing a specific version of Bun on Windows
@@ -201,7 +201,7 @@ On Windows, you can install a specific version of Bun by passing the version num
201
201
 
202
202
  ```sh
203
203
  # PowerShell:
204
- $ iex "& {$(irm https://bun.com/install.ps1)} -Version 1.2.19-canary.20250717T140556"
204
+ $ iex "& {$(irm https://bun.com/install.ps1)} -Version 1.2.19-canary.20250719T140529"
205
205
  ```
206
206
 
207
207
  ## Downloading Bun binaries directly
@@ -124,11 +124,11 @@ await fetch("https://example.com", {
124
124
  This prints the `fetch` request as a single-line `curl` command to let you copy-paste into your terminal to replicate the request.
125
125
 
126
126
  ```sh
127
- [fetch] $ curl --http1.1 "https://example.com/" -X POST -H "content-type: application/json" -H "Connection: keep-alive" -H "User-Agent: Bun/1.2.19-canary.20250717T140556" -H "Accept: */*" -H "Host: example.com" -H "Accept-Encoding: gzip, deflate, br" --compressed -H "Content-Length: 13" --data-raw "{\"foo\":\"bar\"}"
127
+ [fetch] $ curl --http1.1 "https://example.com/" -X POST -H "content-type: application/json" -H "Connection: keep-alive" -H "User-Agent: Bun/1.2.19-canary.20250719T140529" -H "Accept: */*" -H "Host: example.com" -H "Accept-Encoding: gzip, deflate, br" --compressed -H "Content-Length: 13" --data-raw "{\"foo\":\"bar\"}"
128
128
  [fetch] > HTTP/1.1 POST https://example.com/
129
129
  [fetch] > content-type: application/json
130
130
  [fetch] > Connection: keep-alive
131
- [fetch] > User-Agent: Bun/1.2.19-canary.20250717T140556
131
+ [fetch] > User-Agent: Bun/1.2.19-canary.20250719T140529
132
132
  [fetch] > Accept: */*
133
133
  [fetch] > Host: example.com
134
134
  [fetch] > Accept-Encoding: gzip, deflate, br
@@ -170,7 +170,7 @@ This prints the following to the console:
170
170
  [fetch] > HTTP/1.1 POST https://example.com/
171
171
  [fetch] > content-type: application/json
172
172
  [fetch] > Connection: keep-alive
173
- [fetch] > User-Agent: Bun/1.2.19-canary.20250717T140556
173
+ [fetch] > User-Agent: Bun/1.2.19-canary.20250719T140529
174
174
  [fetch] > Accept: */*
175
175
  [fetch] > Host: example.com
176
176
  [fetch] > Accept-Encoding: gzip, deflate, br
package/docs/test/dom.md CHANGED
@@ -55,7 +55,7 @@ Let's run this test with `bun test`:
55
55
 
56
56
  ```bash
57
57
  $ bun test
58
- bun test v1.2.19-canary.20250717T140556
58
+ bun test v1.2.19-canary.20250719T140529
59
59
 
60
60
  dom.test.ts:
61
61
  ✓ dom test [0.82ms]
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.2.19-canary.20250717T140556",
2
+ "version": "1.2.19-canary.20250719T140529",
3
3
  "name": "bun-types",
4
4
  "license": "MIT",
5
5
  "types": "./index.d.ts",