bun-types 1.1.40-canary.20241219T140645 → 1.1.41-canary.20241220T140556
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/bundler/executables.md +13 -0
- package/docs/cli/bun-install.md +3 -0
- package/docs/cli/install.md +14 -0
- package/docs/install/index.md +7 -0
- package/package.json +1 -1
|
@@ -279,6 +279,19 @@ $ bun build --compile --asset-naming="[name].[ext]" ./index.ts
|
|
|
279
279
|
|
|
280
280
|
To trim down the size of the executable a little, pass `--minify` to `bun build --compile`. This uses Bun's minifier to reduce the code size. Overall though, Bun's binary is still way too big and we need to make it smaller.
|
|
281
281
|
|
|
282
|
+
## Windows-specific flags
|
|
283
|
+
|
|
284
|
+
When compiling a standalone executable on Windows, there are two platform-specific options that can be used to customize metadata on the generated `.exe` file:
|
|
285
|
+
|
|
286
|
+
- `--windows-icon=path/to/icon.ico` to customize the executable file icon.
|
|
287
|
+
- `--windows-hide-console` to disable the background terminal, which can be used for applications that do not need a TTY.
|
|
288
|
+
|
|
289
|
+
{% callout %}
|
|
290
|
+
|
|
291
|
+
These flags currently cannot be used when cross-compiling because they depend on Windows APIs.
|
|
292
|
+
|
|
293
|
+
{% /callout %}
|
|
294
|
+
|
|
282
295
|
## Unsupported CLI arguments
|
|
283
296
|
|
|
284
297
|
Currently, the `--compile` flag can only accept a single entrypoint at a time and does not support the following flags:
|
package/docs/cli/bun-install.md
CHANGED
|
@@ -57,12 +57,15 @@ frozenLockfile = false
|
|
|
57
57
|
dryRun = true
|
|
58
58
|
|
|
59
59
|
# Install optionalDependencies (default: true)
|
|
60
|
+
# Setting this to false is equivalent to the `--omit=optional` CLI argument
|
|
60
61
|
optional = true
|
|
61
62
|
|
|
62
63
|
# Install local devDependencies (default: true)
|
|
64
|
+
# Setting this to false is equivalent to the `--omit=dev` CLI argument
|
|
63
65
|
dev = true
|
|
64
66
|
|
|
65
67
|
# Install peerDependencies (default: true)
|
|
68
|
+
# Setting this to false is equivalent to the `--omit=peer` CLI argument
|
|
66
69
|
peer = true
|
|
67
70
|
|
|
68
71
|
# Max number of concurrent lifecycle scripts (default: (cpu count or GOMAXPROCS) x2)
|
package/docs/cli/install.md
CHANGED
|
@@ -130,6 +130,20 @@ $ bun install --frozen-lockfile
|
|
|
130
130
|
|
|
131
131
|
For more information on Bun's binary lockfile `bun.lockb`, refer to [Package manager > Lockfile](https://bun.sh/docs/install/lockfile).
|
|
132
132
|
|
|
133
|
+
## Omitting dependencies
|
|
134
|
+
|
|
135
|
+
To omit dev, peer, or optional dependencies use the `--omit` flag.
|
|
136
|
+
|
|
137
|
+
```bash
|
|
138
|
+
# Exclude "devDependencies" from the installation. This will apply to the
|
|
139
|
+
# root package and workspaces if they exist. Transitive dependencies will
|
|
140
|
+
# not have "devDependencies".
|
|
141
|
+
$ bun install --omit dev
|
|
142
|
+
|
|
143
|
+
# Install only dependencies from "dependencies"
|
|
144
|
+
$ bun install --omit=dev --omit=peer --omit=optional
|
|
145
|
+
```
|
|
146
|
+
|
|
133
147
|
## Dry run
|
|
134
148
|
|
|
135
149
|
To perform a dry run (i.e. don't actually install anything):
|
package/docs/install/index.md
CHANGED
|
@@ -55,6 +55,13 @@ To install dependencies without allowing changes to lockfile (useful on CI):
|
|
|
55
55
|
$ bun install --frozen-lockfile
|
|
56
56
|
```
|
|
57
57
|
|
|
58
|
+
To exclude dependency types from installing, use `--omit` with `dev`, `optional`, or `peer`:
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
# Disable devDependencies and optionalDependencies
|
|
62
|
+
$ bun install --omit=dev --omit=optional
|
|
63
|
+
```
|
|
64
|
+
|
|
58
65
|
To perform a dry run (i.e. don't actually install anything):
|
|
59
66
|
|
|
60
67
|
```bash
|
package/package.json
CHANGED