mirrors/bun.sh
1
0
Fork 0
mirror of https://github.com/oven-sh/bun synced 2026-02-02 15:08:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update plugins.md

Browse Source
This commit is contained in:
Jarred Sumner
2025-05-05 15:40:07 -07:00
parent 09fc87850f
commit 1cf492c208
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/runtime/plugins.md
View File

@@ -25,6 +25,12 @@ Plugins have to be loaded before any other code runs! To achieve this, use the `
preload = ["./myPlugin.ts"]
```
Preloads can be either local files or npm packages. Anything that can be imported/required can be preloaded.
```toml
preload = ["bun-plugin-foo"]
```
To preload files before `bun test`:
```toml
@@ -32,7 +38,7 @@ To preload files before `bun test`:
preload = ["./myPlugin.ts"]
```
## Third-party plugins
## Plugin conventions
By convention, third-party plugins intended for consumption should export a factory function that accepts some configuration and returns a plugin object.