mirror of
https://github.com/oven-sh/bun
synced 2026-02-10 02:48:50 +00:00
b4f85c8866
## Summary Updated all example version placeholders in documentation from 1.3.1 and 1.2.20 to 1.3.2. ## Changes Updated version examples in: - Installation examples (Linux/macOS and Windows install commands) - Package manager output examples (`bun install`, `bun publish`, `bun pm` commands) - Test runner output examples - Spawn/child process output examples - Fetch User-Agent header examples in debugging docs - `Bun.version` API example ## Notes - Historical version references (e.g., "As of Bun v1.x.x..." or "Bun v1.x.x+ required") were intentionally **preserved** as they document when features were introduced - Generic package.json version examples (non-Bun package versions) were **preserved** - Only example outputs and code snippets showing current Bun version were updated ## Files Changed (13 total) - `docs/installation.mdx` - `docs/guides/install/from-npm-install-to-bun-install.mdx` - `docs/guides/install/add-peer.mdx` - `docs/bundler/html-static.mdx` (6 occurrences) - `docs/test/dom.mdx` - `docs/pm/cli/publish.mdx` - `docs/pm/cli/pm.mdx` - `docs/guides/test/snapshot.mdx` (2 occurrences) - `docs/guides/ecosystem/nuxt.mdx` - `docs/guides/util/version.mdx` - `docs/runtime/debugger.mdx` (3 occurrences) - `docs/runtime/networking/fetch.mdx` - `docs/runtime/child-process.mdx` **Total:** 23 version references updated 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Bot <claude-bot@bun.sh> Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: Michael H <git@riskymh.dev>
103 lines
2.2 KiB
Plaintext
103 lines
2.2 KiB
Plaintext
---
|
|
title: Use snapshot testing in `bun test`
|
|
sidebarTitle: Snapshot testing
|
|
mode: center
|
|
---
|
|
|
|
Bun's test runner supports Jest-style snapshot testing via `.toMatchSnapshot()`.
|
|
|
|
```ts snap.test.ts icon="/icons/typescript.svg"
|
|
import { test, expect } from "bun:test";
|
|
|
|
test("snapshot", () => {
|
|
expect({ foo: "bar" }).toMatchSnapshot();
|
|
});
|
|
```
|
|
|
|
---
|
|
|
|
The first time this test is executed, Bun will evaluate the value passed into `expect()` and write it to disk in a directory called `__snapshots__` that lives alongside the test file. (Note the `snapshots: +1 added` line in the output.)
|
|
|
|
```sh terminal icon="terminal"
|
|
bun test test/snap
|
|
```
|
|
|
|
```txt
|
|
test/snap.test.ts:
|
|
✓ snapshot [1.48ms]
|
|
|
|
1 pass
|
|
0 fail
|
|
snapshots: +1 added
|
|
1 expect() calls
|
|
Ran 1 tests across 1 files. [82.00ms]
|
|
```
|
|
|
|
---
|
|
|
|
The `__snapshots__` directory contains a `.snap` file for each test file in the directory.
|
|
|
|
```txt File Tree icon="folder-tree"
|
|
test
|
|
├── __snapshots__
|
|
│ └── snap.test.ts.snap
|
|
└── snap.test.ts
|
|
```
|
|
|
|
---
|
|
|
|
The `snap.test.ts.snap` file is a JavaScript file that exports a serialized version of the value passed into `expect()`. The `{foo: "bar"}` object has been serialized to JSON.
|
|
|
|
```js snap.test.ts.snap icon="file-code"
|
|
// Bun Snapshot v1, https://bun.sh/docs/test/snapshots
|
|
|
|
exports[`snapshot 1`] = `
|
|
{
|
|
"foo": "bar",
|
|
}
|
|
`;
|
|
```
|
|
|
|
---
|
|
|
|
Later, when this test file is executed again, Bun will read the snapshot file and compare it to the value passed into `expect()`. If the values are different, the test will fail.
|
|
|
|
```sh terminal icon="terminal"
|
|
bun test
|
|
bun test v1.3.2 (9c68abdb)
|
|
```
|
|
|
|
```txt
|
|
test/snap.test.ts:
|
|
✓ snapshot [1.05ms]
|
|
|
|
1 pass
|
|
0 fail
|
|
1 snapshots, 1 expect() calls
|
|
Ran 1 tests across 1 files. [101.00ms]
|
|
```
|
|
|
|
---
|
|
|
|
To update snapshots, use the `--update-snapshots` flag.
|
|
|
|
```sh terminal icon="terminal"
|
|
bun test --update-snapshots
|
|
bun test v1.3.2 (9c68abdb)
|
|
```
|
|
|
|
```txt
|
|
test/snap.test.ts:
|
|
✓ snapshot [0.86ms]
|
|
|
|
1 pass
|
|
0 fail
|
|
snapshots: +1 added # the snapshot was regenerated
|
|
1 expect() calls
|
|
Ran 1 tests across 1 files. [102.00ms]
|
|
```
|
|
|
|
---
|
|
|
|
See [Docs > Test Runner > Snapshots](https://bun.sh/docs/test/snapshots) for complete documentation on snapshots with the Bun test runner.
|