aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Colin McDonnell <colinmcd94@gmail.com> 2023-09-14 21:25:57 -0700
committerGravatar Colin McDonnell <colinmcd94@gmail.com> 2023-09-14 21:25:57 -0700
commitb262b0153a2d9667fcb47a970e8027d3b54f8a0a (patch)
tree888f325d0f96eabec0a225b82dd6f6ea4bba7b83
parent75e68e356b3d5b93739ae0c7e3967f2214a3d9d8 (diff)
downloadbun-b262b0153a2d9667fcb47a970e8027d3b54f8a0a.tar.gz
bun-b262b0153a2d9667fcb47a970e8027d3b54f8a0a.tar.zst
bun-b262b0153a2d9667fcb47a970e8027d3b54f8a0a.zip
Clean up bunfig.md
-rw-r--r--docs/runtime/bunfig.md40
1 files changed, 21 insertions, 19 deletions
diff --git a/docs/runtime/bunfig.md b/docs/runtime/bunfig.md
index 34e3cfa33..9426cc6e0 100644
--- a/docs/runtime/bunfig.md
+++ b/docs/runtime/bunfig.md
@@ -159,6 +159,7 @@ coverageThreshold = 0.9
Different thresholds can be specified for line-wise, function-wise, and statement-wise coverage.
```toml
+[test]
coverageThreshold = { line = 0.7, function = 0.8, statement = 0.9 }
```
@@ -308,6 +309,25 @@ Whether to install optional dependencies. Default `false`. When true, it's equiv
dryRun = false
```
+### `install.globalDir`
+
+To configure the directory where Bun puts globally installed packages.
+
+```toml
+[install]
+# where `bun install --global` installs packages
+globalDir = "~/.bun/install/global"
+```
+
+### `install.globalBinDir`
+
+To configure the directory where Bun installs globally installed binaries and CLIs.
+
+```toml
+# where globally-installed package bins are linked
+globalBinDir = "~/.bun/bin"
+```
+
### `install.registry`
The default registry is `https://registry.npmjs.org/`. This can be globally configured in `bunfig.toml`:
@@ -339,25 +359,6 @@ myorg = { username = "myusername", password = "$npm_password", url = "https://re
myorg = { token = "$npm_token", url = "https://registry.myorg.com/" }
```
-### `install.globalDir`
-
-To configure the directory where Bun puts globally installed packages.
-
-```toml
-[install]
-# where `bun install --global` installs packages
-globalDir = "~/.bun/install/global"
-```
-
-### `install.globalBinDir`
-
-To configure the directory where Bun installs globally installed binaries and CLIs.
-
-```toml
-# where globally-installed package bins are linked
-globalBinDir = "~/.bun/bin"
-```
-
### `install.cache`
To configure the cache behavior:
@@ -390,6 +391,7 @@ save = true
Whether to generate a non-Bun lockfile alongside `bun.lockb`. (A `bun.lockb` will always be created.) Currently `"yarn"` is the only supported value.
```toml
+[install.lockfile]
print = "yarn"
```