bun-types 1.3.6-canary.20251230T140703 → 1.3.6-canary.20260101T140646

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.
Files changed (2) hide show
  1. package/docs/pm/npmrc.mdx +134 -0
  2. package/package.json +1 -1
package/docs/pm/npmrc.mdx CHANGED
@@ -72,6 +72,7 @@ The following options are supported:
72
72
  - `username`
73
73
  - `_password` (base64 encoded password)
74
74
  - `_auth` (base64 encoded username:password, e.g. `btoa(username + ":" + password)`)
75
+ - `email`
75
76
 
76
77
  The equivalent `bunfig.toml` option is to add a key in [`install.scopes`](/docs/runtime/bunfig#install-registry):
77
78
 
@@ -109,3 +110,136 @@ The equivalent `bunfig.toml` option is [`install.exact`](/docs/runtime/bunfig#in
109
110
  [install]
110
111
  exact = true
111
112
  ```
113
+
114
+ ### `ignore-scripts`: Skip lifecycle scripts
115
+
116
+ Prevents running lifecycle scripts during installation:
117
+
118
+ ```ini .npmrc icon="npm"
119
+ ignore-scripts=true
120
+ ```
121
+
122
+ This is equivalent to using the `--ignore-scripts` flag with `bun install`.
123
+
124
+ ### `dry-run`: Preview changes without installing
125
+
126
+ Shows what would be installed without actually installing:
127
+
128
+ ```ini .npmrc icon="npm"
129
+ dry-run=true
130
+ ```
131
+
132
+ The equivalent `bunfig.toml` option is [`install.dryRun`](/docs/runtime/bunfig#install-dryrun):
133
+
134
+ ```toml bunfig.toml icon="settings"
135
+ [install]
136
+ dryRun = true
137
+ ```
138
+
139
+ ### `cache`: Configure cache directory
140
+
141
+ Set the cache directory path, or disable caching:
142
+
143
+ ```ini .npmrc icon="npm"
144
+ # set a custom cache directory
145
+ cache=/path/to/cache
146
+
147
+ # or disable caching
148
+ cache=false
149
+ ```
150
+
151
+ The equivalent `bunfig.toml` option is [`install.cache`](/docs/runtime/bunfig#install-cache):
152
+
153
+ ```toml bunfig.toml icon="settings"
154
+ [install.cache]
155
+ # set a custom cache directory
156
+ dir = "/path/to/cache"
157
+
158
+ # or disable caching
159
+ disable = true
160
+ ```
161
+
162
+ ### `ca` and `cafile`: Configure CA certificates
163
+
164
+ Configure custom CA certificates for registry connections:
165
+
166
+ ```ini .npmrc icon="npm"
167
+ # single CA certificate
168
+ ca="-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----"
169
+
170
+ # multiple CA certificates
171
+ ca[]="-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----"
172
+ ca[]="-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----"
173
+
174
+ # or specify a path to a CA file
175
+ cafile=/path/to/ca-bundle.crt
176
+ ```
177
+
178
+ ### `omit` and `include`: Control dependency types
179
+
180
+ Control which dependency types are installed:
181
+
182
+ ```ini .npmrc icon="npm"
183
+ # omit dev dependencies
184
+ omit=dev
185
+
186
+ # omit multiple types
187
+ omit[]=dev
188
+ omit[]=optional
189
+
190
+ # include specific types (overrides omit)
191
+ include=dev
192
+ ```
193
+
194
+ Valid values: `dev`, `peer`, `optional`
195
+
196
+ ### `install-strategy` and `node-linker`: Installation strategy
197
+
198
+ Control how packages are installed in `node_modules`. Bun supports two different configuration options for compatibility with different package managers.
199
+
200
+ **npm's `install-strategy`:**
201
+
202
+ ```ini .npmrc icon="npm"
203
+ # flat node_modules structure (default)
204
+ install-strategy=hoisted
205
+
206
+ # symlinked structure
207
+ install-strategy=linked
208
+ ```
209
+
210
+ **pnpm/yarn's `node-linker`:**
211
+
212
+ The `node-linker` option controls the installation mode. Bun supports values from both pnpm and yarn:
213
+
214
+ | Value | Description | Accepted by |
215
+ | -------------- | ----------------------------------------------- | ----------- |
216
+ | `isolated` | Symlinked structure with isolated dependencies | pnpm |
217
+ | `hoisted` | Flat node_modules structure | pnpm |
218
+ | `pnpm` | Symlinked structure (same as `isolated`) | yarn |
219
+ | `node-modules` | Flat node_modules structure (same as `hoisted`) | yarn |
220
+
221
+ ```ini .npmrc icon="npm"
222
+ # symlinked/isolated mode
223
+ node-linker=isolated
224
+ node-linker=pnpm
225
+
226
+ # flat/hoisted mode
227
+ node-linker=hoisted
228
+ node-linker=node-modules
229
+ ```
230
+
231
+ ### `public-hoist-pattern` and `hoist-pattern`: Control hoisting
232
+
233
+ Control which packages are hoisted to the root `node_modules`:
234
+
235
+ ```ini .npmrc icon="npm"
236
+ # packages matching this pattern will be hoisted to the root
237
+ public-hoist-pattern=*eslint*
238
+
239
+ # multiple patterns
240
+ public-hoist-pattern[]=*eslint*
241
+ public-hoist-pattern[]=*prettier*
242
+
243
+ # control general hoisting behavior
244
+ hoist-pattern=*
245
+ ```
package/package.json CHANGED
@@ -33,5 +33,5 @@
33
33
  "bun.js",
34
34
  "types"
35
35
  ],
36
- "version": "1.3.6-canary.20251230T140703"
36
+ "version": "1.3.6-canary.20260101T140646"
37
37
  }