To remind yourself to write a test later, use the test.todo function. There's no need to provide a test implementation.
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.
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.
import { test, expect } from "bun:test";
test.todo("unimplemented feature", () => {
expect(Bun.isAwesome()).toBe(true);
});
If an implementation is provided, it will not be run unless the --todo flag is passed. If the --todo flag is passed, the test 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.
bun test --todomy.test.ts:
✗ unimplemented feature
^ this test is marked as todo but passes. Remove `.todo` or check that test is correct.
0 pass
1 fail
1 expect() callsecho $?1 # this is the exit code of the previous commandSee also: