blob: 611bc674db4dd6b7cbbf926b23cd86309d8568ec (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
---
name: Mark a test as a "todo" with the Bun test runner
---
To remind yourself to write a test later, use the `test.todo` function. There's no need to provide a test implementation.
```ts
import { test, expect } from "bun:test";
// write this later
test.todo("unimplemented feature");
```
---
The output of `bun test` indicates how many `todo` tests were encountered.
```sh
$ bun test
test.test.ts:
✓ add [0.03ms]
✓ multiply [0.02ms]
✎ unimplemented feature
2 pass
1 todo
0 fail
2 expect() calls
Ran 3 tests across 1 files. [74.00ms]
```
---
Optionally, you can provide a test implementation.
```ts
import { test, expect } from "bun:test";
test.todo("unimplemented feature", () => {
expect(Bun.isAwesome()).toBe(true);
});
```
---
If an implementation is provides, it will be executed and _expected to fail_ by test runner! If a todo test passes, the `bun test` run will return a non-zero exit code to signal the failure.
```sh
$ bun test
$ echo $?
1 # this is the exit code of the previous command
```
---
See also:
- [Skip a test](/guides/test/skip-tests)
- [Docs > Test runner > Writing tests](/docs/test/writing)
|
