Skip to content

docs: say that bun test does not read the top-level preload in bunfig.toml #48063

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
robobun wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: say that bun test does not read the top-level preload in bunfig.toml #48063

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c675658
docs: say that `bun test` does not read the top-level `preload` in bu…
robobun Nov 7, 2026
ebfa6e4
docs: scope the `preload` sentence to files and name package scripts
robobun Nov 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/runtime/bunfig.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Top-level fields in `bunfig.toml` configure Bun's runtime behavior.

### `preload`

An array of scripts/plugins to execute before running a file or script.
An array of scripts/plugins to execute before running a file or script. `bun test` does not read this field. To run a script before your tests, use [`test.preload`](#test-preload).

```toml title="bunfig.toml" icon="settings"
# scripts to run before `bun run`-ing a file or script
Expand Down Expand Up @@ -187,7 +187,7 @@ root = "./__tests__"

### `test.preload`

Same as the top-level `preload` field, but only applies to `bun test`.
Same as the top-level `preload` field, but for `bun test`. Of the two fields, `bun test` reads only `test.preload`, including when a `package.json` script runs it. `bun <file>` and `bun run <file>` read only the top-level `preload`. To load a script for both, add it to both fields.

```toml title="bunfig.toml" icon="settings"
[test]
Expand Down
Loading