docs(bun): setup bun test runner (#570)

Users of Bun most likely want to use the "battery included" test runner instead of separately installing Jest. For newcomers that want to use Bun it might not be obvious that root `preload` doesn't apply for tests also and they get the error `No valid runtime type ... given` when running the tests. Signed-off-by: Gabriel Arama <[email protected]>
deepkit · May 27, 2024 · 2cd09a8 · 2cd09a8
1 parent 5c49778
commit 2cd09a8
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/packages/bun/README.md b/packages/bun/README.md
@@ -24,3 +24,12 @@ bun install @deepkit/type @deepkit/type-compiler @deepkit/core @deepkit/bun type
     "reflection": true
 }
 ```
+
+## Bun test runner
+
+To use the [bun test runner](https://bun.sh/docs/cli/test) instead of Jest add the following to file `bunfig.toml`:
+
+```toml
+[test]
+preload = ["@deepkit/bun"]
+```