bun-types 1.3.2-canary.20251105T140650 → 1.3.2

package/docs/project/{bindgen.md → bindgen.mdx}

@@ -1,8 +1,9 @@
-{% callout %}
+---
+title: Bindgen
+description: Bindgen for Bun
+---
 
-This document is for maintainers and contributors to Bun, and describes internal implementation details.
-
-{% /callout %}
+<Note>This document is for maintainers and contributors to Bun, and describes internal implementation details.</Note>
 
 The new bindings generator, introduced to the codebase in Dec 2024, scans for
 `*.bind.ts` to find function and class definition, and generates glue code to
@@ -19,7 +20,7 @@ this one:
 
 Given a file implementing a simple function, such as `add`
 
-```zig#src/bun.js/math.zig
+```zig src/bun.js/math.zig
 pub fn add(global: *jsc.JSGlobalObject, a: i32, b: i32) !i32 {
     return std.math.add(i32, a, b) catch {
         // Binding functions can return `error.OutOfMemory` and `error.JSError`.
@@ -38,8 +39,8 @@ const jsc = bun.jsc;
 
 Then describe the API schema using a `.bind.ts` function. The binding file goes next to the Zig file.
 
-```ts#src/bun.js/math.bind.ts
-import { t, fn } from 'bindgen';
+```ts src/bun.js/math.bind.ts icon="/icons/typescript.svg"
+import { t, fn } from "bindgen";
 
 export const add = fn({
   args: {
@@ -84,8 +85,8 @@ TLDRs from WebIDL spec:
 
 A `variants` can specify multiple variants (also known as overloads).
 
-```ts#src/bun.js/math.bind.ts
-import { t, fn } from 'bindgen';
+```ts src/bun.js/math.bind.ts icon="/icons/typescript.svg"
+import { t, fn } from "bindgen";
 
 export const action = fn({
   variants: [
@@ -101,7 +102,7 @@ export const action = fn({
       },
       ret: t.DOMString,
     },
-  ]
+  ],
 });
 ```
 
@@ -131,10 +132,7 @@ To use [WebIDL's enumeration](https://webidl.spec.whatwg.org/#idl-enums) type, u
 An example of `stringEnum` as used in `fmt.zig` / `bun:internal-for-testing`
 
 ```ts
-export const Formatter = t.stringEnum(
-  "highlight-javascript",
-  "escape-powershell",
-);
+export const Formatter = t.stringEnum("highlight-javascript", "escape-powershell");
 
 export const fmtString = fn({
   args: {

package/docs/project/{building-windows.md → building-windows.mdx}

@@ -1,39 +1,14 @@
+---
+title: Building Windows
+description: Building Bun on Windows
+---
+
 This document describes the build process for Windows. If you run into problems, please join the [#contributing channel on our Discord](http://bun.com/discord) for help.
 
 It is strongly recommended to use [PowerShell 7 (`pwsh.exe`)](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.4) instead of the default `powershell.exe`.
 
 ## Prerequisites
 
-<!--
-{% details summary="Extra notes for Bun Core Team Members" %}
-
-Here are the extra steps I ran on my fresh windows machine (some of these are a little opiniated)
-
-- Change user to a local account (set username to `window` and 'bun!')
-- Set Windows Terminal as default terminal
-- Install latest version of Powershell
-- Display scale to 100%
-- Remove McAfee and enable Windows Defender (default antivirus, does not nag you)
-- Install Software
-  - OpenSSH server (run these in an elevated terminal)
-    - `Add-WindowsCapability -Online -Name OpenSSH.Client~~~~0.0.1.0`
-    - `Add-WindowsCapability -Online -Name OpenSSH.Server~~~~0.0.1.0`
-    - `Start-Service sshd`
-    - `Set-Service -Name sshd -StartupType 'Automatic'`
-    - `New-ItemProperty -Path "HKLM:\SOFTWARE\OpenSSH" -Name DefaultShell -Value "C:\Program Files\PowerShell\7\pwsh.exe" -PropertyType String -Force`
-    - Configure in `C:\ProgramData\ssh`
-    - Add ssh keys (in ProgramData because it is an admin account)
-  - Tailscale (login with GitHub so it joins the team tailnet)
-  - Visual Studio Code
-- Configure `git`
-  - `git config user.name "your name"`
-  - `git config user.email "your@email"`
-- Disable sleep mode and the lid switch by going to "Power Options" and configuring everything there.
-
-I recommend using VSCode through SSH instead of Tunnels or the Tailscale extension, it seems to be more reliable.
-
-{% /details %} -->
-
 ### Enable Scripts
 
 By default, running unverified scripts are blocked.
@@ -67,32 +42,27 @@ After Visual Studio, you need the following:
 - Perl
 - Ruby
 - Node.js
-- Ccache
 
-{% callout %}
-**Note** – The Zig compiler is automatically downloaded, installed, and updated by the building process.
-{% /callout %}
+<Note>The Zig compiler is automatically downloaded, installed, and updated by the building process.</Note>
 
 [Scoop](https://scoop.sh) can be used to install these remaining tools easily.
 
-{% codetabs group="a" %}
-
-```ps1#Scoop
+```ps1 Scoop
 > irm https://get.scoop.sh | iex
-> scoop install nodejs-lts go rust nasm ruby perl ccache
+> scoop install nodejs-lts go rust nasm ruby perl sccache
 # scoop seems to be buggy if you install llvm and the rest at the same time
 > scoop install llvm@19.1.7
 ```
 
-{% /codetabs %}
-
-{% callout %}
-Please do not use WinGet/other package manager for these, as you will likely install Strawberry Perl instead of a more minimal installation of Perl. Strawberry Perl includes many other utilities that get installed into `$Env:PATH` that will conflict with MSVC and break the build.
-{% /callout %}
+<Note>
+  Please do not use WinGet/other package manager for these, as you will likely install Strawberry Perl instead of a more
+  minimal installation of Perl. Strawberry Perl includes many other utilities that get installed into `$Env:PATH` that
+  will conflict with MSVC and break the build.
+</Note>
 
 If you intend on building WebKit locally (optional), you should install these packages:
 
-```ps1#Scoop
+```ps1 Scoop
 > scoop install make cygwin python
 ```
 
@@ -108,9 +78,10 @@ To verify, you can check for an MSVC-only command line such as `mt.exe`
 > Get-Command mt
 ```
 
-{% callout %}
-It is not recommended to install `ninja` / `cmake` into your global path, because you may run into a situation where you try to build bun without .\scripts\vs-shell.ps1 sourced.
-{% /callout %}
+<Note>
+  It is not recommended to install `ninja` / `cmake` into your global path, because you may run into a situation where
+  you try to build bun without .\scripts\vs-shell.ps1 sourced.
+</Note>
 
 ## Building
 

package/docs/project/{contributing.md → contributing.mdx}

@@ -1,98 +1,89 @@
-Configuring a development environment for Bun can take 10-30 minutes depending on your internet connection and computer speed. You will need ~10GB of free disk space for the repository and build artifacts.
-
-If you are using Windows, please refer to [this guide](https://bun.com/docs/project/building-windows)
-
-## Using Nix (Alternative)
+---
+title: Contributing
+description: Contributing to Bun
+---
 
-A Nix flake is provided as an alternative to manual dependency installation:
-
-```bash
-nix develop
-# or explicitly use the pure shell
-# nix develop .#pure
-export CMAKE_SYSTEM_PROCESSOR=$(uname -m)
-bun bd
-```
+Configuring a development environment for Bun can take 10-30 minutes depending on your internet connection and computer speed. You will need ~10GB of free disk space for the repository and build artifacts.
 
-This provides all dependencies in an isolated, reproducible environment without requiring sudo.
+If you are using Windows, please refer to [this guide](/project/building-windows)
 
-## Install Dependencies (Manual)
+## Install Dependencies
 
 Using your system's package manager, install Bun's dependencies:
 
-{% codetabs group="os" %}
+<CodeGroup>
 
-```bash#macOS (Homebrew)
+```bash macOS (Homebrew)
 $ brew install automake ccache cmake coreutils gnu-sed go icu4c libiconv libtool ninja pkg-config rust ruby
 ```
 
-```bash#Ubuntu/Debian
+```bash Ubuntu/Debian
 $ sudo apt install curl wget lsb-release software-properties-common cargo ccache cmake git golang libtool ninja-build pkg-config rustc ruby-full xz-utils
 ```
 
-```bash#Arch
+```bash Arch
 $ sudo pacman -S base-devel ccache cmake git go libiconv libtool make ninja pkg-config python rust sed unzip ruby
 ```
 
-```bash#Fedora
-$ sudo dnf install cargo clang19 llvm19 lld19 ccache cmake git golang libtool ninja-build pkg-config rustc ruby libatomic-static libstdc++-static sed unzip which libicu-devel 'perl(Math::BigInt)'
+```bash Fedora
+$ sudo dnf install cargo ccache cmake git golang libtool ninja-build pkg-config rustc ruby libatomic-static libstdc++-static sed unzip which libicu-devel 'perl(Math::BigInt)'
 ```
 
-```bash#openSUSE Tumbleweed
+```bash openSUSE Tumbleweed
 $ sudo zypper install go cmake ninja automake git icu rustup && rustup toolchain install stable
 ```
 
-{% /codetabs %}
+</CodeGroup>
 
 > **Note**: The Zig compiler is automatically installed and updated by the build scripts. Manual installation is not required.
 
 Before starting, you will need to already have a release build of Bun installed, as we use our bundler to transpile and minify our code, as well as for code generation scripts.
 
-{% codetabs %}
+<CodeGroup>
 
-```bash#Native
+```bash Native
 $ curl -fsSL https://bun.com/install | bash
 ```
 
-```bash#npm
+```bash npm
 $ npm install -g bun
 ```
 
-```bash#Homebrew
+```bash Homebrew
 $ brew tap oven-sh/bun
 $ brew install bun
 ```
 
-{% /codetabs %}
+</CodeGroup>
 
 ## Install LLVM
 
 Bun requires LLVM 19 (`clang` is part of LLVM). This version requirement is to match WebKit (precompiled), as mismatching versions will cause memory allocation failures at runtime. In most cases, you can install LLVM through your system package manager:
 
-{% codetabs group="os" %}
+<CodeGroup>
 
-```bash#macOS (Homebrew)
+```bash macOS (Homebrew)
 $ brew install llvm@19
 ```
 
-```bash#Ubuntu/Debian
+```bash Ubuntu/Debian
 $ # LLVM has an automatic installation script that is compatible with all versions of Ubuntu
 $ wget https://apt.llvm.org/llvm.sh -O - | sudo bash -s -- 19 all
 ```
 
-```bash#Arch
+```bash Arch
 $ sudo pacman -S llvm clang lld
 ```
 
-```bash#Fedora
+```bash Fedora
 $ sudo dnf install llvm clang lld-devel
 ```
 
-```bash#openSUSE Tumbleweed
+```bash openSUSE Tumbleweed
 $ sudo zypper install clang19 lld19 llvm19
 ```
 
-{% /codetabs %}
+</CodeGroup>
 
 If none of the above solutions apply, you will have to install it [manually](https://github.com/llvm/llvm-project/releases/tag/llvmorg-19.1.7).
 
@@ -104,29 +95,31 @@ $ which clang-19
 
 If not, run this to manually add it:
 
-{% codetabs group="os" %}
+<CodeGroup>
 
-```bash#macOS (Homebrew)
+```bash macOS (Homebrew)
 # use fish_add_path if you're using fish
 # use path+="$(brew --prefix llvm@19)/bin" if you are using zsh
 $ export PATH="$(brew --prefix llvm@19)/bin:$PATH"
 ```
 
-```bash#Arch
+```bash Arch
 # use fish_add_path if you're using fish
 $ export PATH="$PATH:/usr/lib/llvm19/bin"
 ```
 
-{% /codetabs %}
+</CodeGroup>
 
-> ⚠️ Ubuntu distributions (<= 20.04) may require installation of the C++ standard library independently. See the [troubleshooting section](#span-file-not-found-on-ubuntu) for more information.
+<Warning>
+⚠️ Ubuntu distributions (\<= 20.04) may require installation of the C++ standard library independently. See the [troubleshooting section](#span-file-not-found-on-ubuntu) for more information.
+</Warning>
 
 ## Building Bun
 
 After cloning the repository, run the following command to build. This may take a while as it will clone submodules and build dependencies.
 
 ```bash
-$ bun run build
+bun run build
 ```
 
 The binary will be located at `./build/debug/bun-debug`. It is recommended to add this to your `$PATH`. To verify the build worked, let's print the version number on the development build of Bun.
@@ -145,7 +138,7 @@ If you use a different editor, make sure that you tell ZLS to use the automatica
 We recommend adding `./build/debug` to your `$PATH` so that you can run `bun-debug` in your terminal:
 
 ```sh
-$ bun-debug
+bun-debug
 ```
 
 ## Running debug builds
@@ -153,9 +146,9 @@ $ bun-debug
 The `bd` package.json script compiles and runs a debug build of Bun, only printing the output of the build process if it fails.
 
 ```sh
-$ bun bd <args>
-$ bun bd test foo.test.ts
-$ bun bd ./foo.ts
+bun bd <args>
+bun bd test foo.test.ts
+bun bd ./foo.ts
 ```
 
 Bun generally takes about 2.5 minutes to compile a debug build when there are Zig changes. If your development workflow is "change one line, save, rebuild", you will spend too much time waiting for the build to finish. Instead:
@@ -163,7 +156,7 @@ Bun generally takes about 2.5 minutes to compile a debug build when there are Zi
 - Batch up your changes
 - Ensure zls is running with incremental watching for LSP errors (if you use VSCode and install Zig and run `bun run build` once to download Zig, this should just work)
 - Prefer using the debugger ("CodeLLDB" in VSCode) to step through the code.
-- Use debug logs. `BUN_DEBUG_<scope>=1` will enable debug logging for the corresponding `Output.scoped(.<scope>, .hidden)` logs. You can also set `BUN_DEBUG_QUIET_LOGS=1` to disable all debug logging that isn't explicitly enabled. To dump debug lgos into a file, `BUN_DEBUG=<path-to-file>.log`. Debug logs are aggressively removed in release builds.
+- Use debug logs. `BUN_DEBUG_<scope>=1` will enable debug logging for the corresponding `Output.scoped(.<scope>, false)` logs. You can also set `BUN_DEBUG_QUIET_LOGS=1` to disable all debug logging that isn't explicitly enabled. To dump debug lgos into a file, `BUN_DEBUG=<path-to-file>.log`. Debug logs are aggressively removed in release builds.
 - src/js/\*\*.ts changes are pretty much instant to rebuild. C++ changes are a bit slower, but still much faster than the Zig code (Zig is one compilation unit, C++ is many).
 
 ## Code generation scripts
@@ -187,7 +180,7 @@ Certain modules like `node:fs`, `node:stream`, `bun:sqlite`, and `ws` are implem
 To compile a release build of Bun, run:
 
 ```bash
-$ bun run build:release
+bun run build:release
 ```
 
 The binary will be located at `./build/release/bun` and `./build/release/bun-profile`.
@@ -220,7 +213,7 @@ This works by downloading the release build from the GitHub Actions artifacts on
 To build a release build with Address Sanitizer, run:
 
 ```bash
-$ bun run build:release:asan
+bun run build:release:asan
 ```
 
 In CI, we run our test suite with at least one target that is built with Address Sanitizer.
@@ -238,39 +231,42 @@ $ git -C vendor/WebKit checkout <commit_hash>
 
 # Make a debug build of JSC. This will output build artifacts in ./vendor/WebKit/WebKitBuild/Debug
 # Optionally, you can use `bun run jsc:build` for a release build
-$ bun run jsc:build:debug && rm vendor/WebKit/WebKitBuild/Debug/JavaScriptCore/DerivedSources/inspector/InspectorProtocolObjects.h
+bun run jsc:build:debug && rm vendor/WebKit/WebKitBuild/Debug/JavaScriptCore/DerivedSources/inspector/InspectorProtocolObjects.h
 
 # After an initial run of `make jsc-debug`, you can rebuild JSC with:
 $ cmake --build vendor/WebKit/WebKitBuild/Debug --target jsc && rm vendor/WebKit/WebKitBuild/Debug/JavaScriptCore/DerivedSources/inspector/InspectorProtocolObjects.h
 
 # Build bun with the local JSC build
-$ bun run build:local
+bun run build:local
 ```
 
 Using `bun run build:local` will build Bun in the `./build/debug-local` directory (instead of `./build/debug`), you'll have to change a couple of places to use this new directory:
 
-- The first line in [`src/js/builtins.d.ts`](/src/js/builtins.d.ts)
-- The `CompilationDatabase` line in [`.clangd` config](/.clangd) should be `CompilationDatabase: build/debug-local`
-- In [`build.zig`](/build.zig), the `codegen_path` option should be `build/debug-local/codegen` (instead of `build/debug/codegen`)
-- In [`.vscode/launch.json`](/.vscode/launch.json), many configurations use `./build/debug/`, change them as you see fit
+- The first line in `src/js/builtins.d.ts`
+- The `CompilationDatabase` line in `.clangd` config should be `CompilationDatabase: build/debug-local`
+- In `build.zig`, the `codegen_path` option should be `build/debug-local/codegen` (instead of `build/debug/codegen`)
+- In `.vscode/launch.json`, many configurations use `./build/debug/`, change them as you see fit
 
 Note that the WebKit folder, including build artifacts, is 8GB+ in size.
 
 If you are using a JSC debug build and using VScode, make sure to run the `C/C++: Select a Configuration` command to configure intellisense to find the debug headers.
 
-Note that if you change make changes to our [WebKit fork](https://github.com/oven-sh/WebKit), you will also have to change [`SetupWebKit.cmake`](/cmake/tools/SetupWebKit.cmake) to point to the commit hash.
+Note that if you change make changes to our [WebKit fork](https://github.com/oven-sh/WebKit), you will also have to change `SetupWebKit.cmake` to point to the commit hash.
 
 ## Troubleshooting
 
 ### 'span' file not found on Ubuntu
 
-> ⚠️ Please note that the instructions below are specific to issues occurring on Ubuntu. It is unlikely that the same issues will occur on other Linux distributions.
+<Warning>
+  ⚠️ Please note that the instructions below are specific to issues occurring on Ubuntu. It is unlikely that the same
+  issues will occur on other Linux distributions.
+</Warning>
 
 The Clang compiler typically uses the `libstdc++` C++ standard library by default. `libstdc++` is the default C++ Standard Library implementation provided by the GNU Compiler Collection (GCC). While Clang may link against the `libc++` library, this requires explicitly providing the `-stdlib` flag when running Clang.
 
 Bun relies on C++20 features like `std::span`, which are not available in GCC versions lower than 11. GCC 10 doesn't have all of the C++20 features implemented. As a result, running `make setup` may fail with the following error:
 
-```
+```txt
 fatal error: 'span' file not found
 #include <span>
          ^~~~~~
@@ -278,7 +274,7 @@ fatal error: 'span' file not found
 
 The issue may manifest when initially running `bun setup` as Clang being unable to compile a simple program:
 
-```
+```txt
 The C++ compiler
 
   "/usr/bin/clang++-19"
@@ -326,7 +322,7 @@ $ xcode-select --install
 Bun defaults to linking `libatomic` statically, as not all systems have it. If you are building on a distro that does not have a static libatomic available, you can run the following command to enable dynamic linking:
 
 ```bash
-$ bun run build -DUSE_STATIC_LIBATOMIC=OFF
+bun run build -DUSE_STATIC_LIBATOMIC=OFF
 ```
 
 The built version of Bun may not work on other systems if compiled this way.

package/docs/project/feedback.mdx

@@ -0,0 +1,20 @@
+---
+title: bun feedback
+description: Share feedback, bug reports, and feature requests
+---
+
+import Feedback from "/snippets/cli/feedback.mdx";
+
+Use `bun feedback` to share feedback, bug reports, and feature requests directly with the Bun team.
+
+```bash terminal icon="terminal"
+bun feedback "Love the new release!"
+bun feedback report.txt details.log
+echo "please document X" | bun feedback --email you@example.com
+```
+
+You can provide feedback as text arguments, file paths, or piped input.
+
+---
+
+<Feedback />

package/docs/project/license.mdx

@@ -0,0 +1,78 @@
+---
+title: License
+description: License for Bun
+---
+
+Bun itself is MIT-licensed.
+
+## JavaScriptCore
+
+Bun statically links JavaScriptCore (and WebKit) which is LGPL-2 licensed. WebCore files from WebKit are also licensed under LGPL2. Per LGPL2:
+
+> (1) If you statically link against an LGPL'd library, you must also provide your application in an object (not necessarily source) format, so that a user has the opportunity to modify the library and relink the application.
+
+You can find the patched version of WebKit used by Bun here: [https://github.com/oven-sh/webkit](https://github.com/oven-sh/webkit). If you would like to relink Bun with changes:
+
+- `git submodule update --init --recursive`
+- `make jsc`
+- `zig build`
+
+This compiles JavaScriptCore, compiles Bun's `.cpp` bindings for JavaScriptCore (which are the object files using JavaScriptCore) and outputs a new `bun` binary with your changes.
+
+## Linked libraries
+
+Bun statically links these libraries:
+
+| Library                                                                                                                                          | License                                                                                      |
+| ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------- |
+| [`boringssl`](https://boringssl.googlesource.com/boringssl/)                                                                                     | [several licenses](https://boringssl.googlesource.com/boringssl/+/refs/heads/master/LICENSE) |
+| [`brotli`](https://github.com/google/brotli)                                                                                                     | MIT                                                                                          |
+| [`libarchive`](https://github.com/libarchive/libarchive)                                                                                         | [several licenses](https://github.com/libarchive/libarchive/blob/master/COPYING)             |
+| [`lol-html`](https://github.com/cloudflare/lol-html/tree/master/c-api)                                                                           | BSD 3-Clause                                                                                 |
+| [`mimalloc`](https://github.com/microsoft/mimalloc)                                                                                              | MIT                                                                                          |
+| [`picohttp`](https://github.com/h2o/picohttpparser)                                                                                              | dual-licensed under the Perl License or the MIT License                                      |
+| [`zstd`](https://github.com/facebook/zstd)                                                                                                       | dual-licensed under the BSD License or GPLv2 license                                         |
+| [`simdutf`](https://github.com/simdutf/simdutf)                                                                                                  | Apache 2.0                                                                                   |
+| [`tinycc`](https://github.com/tinycc/tinycc)                                                                                                     | LGPL v2.1                                                                                    |
+| [`uSockets`](https://github.com/uNetworking/uSockets)                                                                                            | Apache 2.0                                                                                   |
+| [`zlib-cloudflare`](https://github.com/cloudflare/zlib)                                                                                          | zlib                                                                                         |
+| [`c-ares`](https://github.com/c-ares/c-ares)                                                                                                     | MIT licensed                                                                                 |
+| [`libicu`](https://github.com/unicode-org/icu) 72                                                                                                | [license here](https://github.com/unicode-org/icu/blob/main/icu4c/LICENSE)                   |
+| [`libbase64`](https://github.com/aklomp/base64/blob/master/LICENSE)                                                                              | BSD 2-Clause                                                                                 |
+| [`libuv`](https://github.com/libuv/libuv) (on Windows)                                                                                           | MIT                                                                                          |
+| [`libdeflate`](https://github.com/ebiggers/libdeflate)                                                                                           | MIT                                                                                          |
+| A fork of [`uWebsockets`](https://github.com/jarred-sumner/uwebsockets)                                                                          | Apache 2.0 licensed                                                                          |
+| Parts of [Tigerbeetle's IO code](https://github.com/tigerbeetle/tigerbeetle/blob/532c8b70b9142c17e07737ab6d3da68d7500cbca/src/io/windows.zig#L1) | Apache 2.0 licensed                                                                          |
+
+## Polyfills
+
+For compatibility reasons, the following packages are embedded into Bun's binary and injected if imported.
+
+| Package                                                                  | License |
+| ------------------------------------------------------------------------ | ------- |
+| [`assert`](https://npmjs.com/package/assert)                             | MIT     |
+| [`browserify-zlib`](https://npmjs.com/package/browserify-zlib)           | MIT     |
+| [`buffer`](https://npmjs.com/package/buffer)                             | MIT     |
+| [`constants-browserify`](https://npmjs.com/package/constants-browserify) | MIT     |
+| [`crypto-browserify`](https://npmjs.com/package/crypto-browserify)       | MIT     |
+| [`domain-browser`](https://npmjs.com/package/domain-browser)             | MIT     |
+| [`events`](https://npmjs.com/package/events)                             | MIT     |
+| [`https-browserify`](https://npmjs.com/package/https-browserify)         | MIT     |
+| [`os-browserify`](https://npmjs.com/package/os-browserify)               | MIT     |
+| [`path-browserify`](https://npmjs.com/package/path-browserify)           | MIT     |
+| [`process`](https://npmjs.com/package/process)                           | MIT     |
+| [`punycode`](https://npmjs.com/package/punycode)                         | MIT     |
+| [`querystring-es3`](https://npmjs.com/package/querystring-es3)           | MIT     |
+| [`stream-browserify`](https://npmjs.com/package/stream-browserify)       | MIT     |
+| [`stream-http`](https://npmjs.com/package/stream-http)                   | MIT     |
+| [`string_decoder`](https://npmjs.com/package/string_decoder)             | MIT     |
+| [`timers-browserify`](https://npmjs.com/package/timers-browserify)       | MIT     |
+| [`tty-browserify`](https://npmjs.com/package/tty-browserify)             | MIT     |
+| [`url`](https://npmjs.com/package/url)                                   | MIT     |
+| [`util`](https://npmjs.com/package/util)                                 | MIT     |
+| [`vm-browserify`](https://npmjs.com/package/vm-browserify)               | MIT     |
+
+## Additional credits
+
+- Bun's JS transpiler, CSS lexer, and Node.js module resolver source code is a Zig port of [@evanw](https://github.com/evanw)’s [esbuild](https://github.com/evanw/esbuild) project.
+- Credit to [@kipply](https://github.com/kipply) for the name "Bun"!

package/docs/project/roadmap.mdx

@@ -0,0 +1,8 @@
+---
+title: Roadmap
+description: Bun's roadmap and long-term plans
+---
+
+Bun is a project with an incredibly large scope and is still in its early days. Long-term, Bun aims to provide an all-in-one toolkit to replace the complex, fragmented toolchains common today: Node.js, Jest, Webpack, esbuild, Babel, yarn, PostCSS, etc.
+
+Refer to [Bun's Roadmap](https://github.com/oven-sh/bun/issues/159) on GitHub to learn more about the project's long-term plans and priorities.