bun-types 1.3.2-canary.20251105T140650 → 1.3.2

package/docs/{cli/bunx.md → pm/bunx.mdx}

@@ -1,20 +1,24 @@
-{% callout %}
-**Note** — `bunx` is an alias for `bun x`. The `bunx` CLI will be auto-installed when you install `bun`.
-{% /callout %}
+---
+title: "bunx"
+description: "Run packages from npm"
+---
+
+<Note>`bunx` is an alias for `bun x`. The `bunx` CLI will be auto-installed when you install `bun`.</Note>
 
 Use `bunx` to auto-install and run packages from `npm`. It's Bun's equivalent of `npx` or `yarn dlx`.
 
-```bash
-$ bunx cowsay "Hello world!"
+```bash terminal icon="terminal"
+bunx cowsay "Hello world!"
 ```
 
-{% callout %}
-⚡️ **Speed** — With Bun's fast startup times, `bunx` is [roughly 100x faster](https://twitter.com/jarredsumner/status/1606163655527059458) than `npx` for locally installed packages.
-{% /callout %}
+<Note>
+  ⚡️ **Speed** — With Bun's fast startup times, `bunx` is [roughly 100x
+  faster](https://twitter.com/jarredsumner/status/1606163655527059458) than `npx` for locally installed packages.
+</Note>
 
 Packages can declare executables in the `"bin"` field of their `package.json`. These are known as _package executables_ or _package binaries_.
 
-```jsonc#package.json
+```json package.json icon="file-json"
 {
   // ... other fields
   "name": "my-cli",
@@ -26,7 +30,7 @@ Packages can declare executables in the `"bin"` field of their `package.json`. T
 
 These executables are commonly plain JavaScript files marked with a [shebang line](<https://en.wikipedia.org/wiki/Shebang_(Unix)>) to indicate which program should be used to execute them. The following file indicates that it should be executed with `node`.
 
-```js#dist/index.js
+```ts dist/index.js icon="/icons/javascript.svg"
 #!/usr/bin/env node
 
 console.log("Hello world!");
@@ -34,8 +38,8 @@ console.log("Hello world!");
 
 These executables can be run with `bunx`,
 
-```bash
-$ bunx my-cli
+```bash terminal icon="terminal"
+bunx my-cli
 ```
 
 As with `npx`, `bunx` will check for a locally installed package first, then fall back to auto-installing the package from `npm`. Installed packages will be stored in Bun's global cache for future use.
@@ -44,46 +48,36 @@ As with `npx`, `bunx` will check for a locally installed package first, then fal
 
 To pass additional command-line flags and arguments through to the executable, place them after the executable name.
 
-```bash
-$ bunx my-cli --foo bar
+```bash terminal icon="terminal"
+bunx my-cli --foo bar
 ```
 
 ## Shebangs
 
 By default, Bun respects shebangs. If an executable is marked with `#!/usr/bin/env node`, Bun will spin up a `node` process to execute the file. However, in some cases it may be desirable to run executables using Bun's runtime, even if the executable indicates otherwise. To do so, include the `--bun` flag.
 
-```bash
-$ bunx --bun my-cli
+```bash terminal icon="terminal"
+bunx --bun my-cli
 ```
 
 The `--bun` flag must occur _before_ the executable name. Flags that appear _after_ the name are passed through to the executable.
 
-```bash
-$ bunx --bun my-cli # good
-$ bunx my-cli --bun # bad
+```bash terminal icon="terminal"
+bunx --bun my-cli # good
+bunx my-cli --bun # bad
 ```
 
 ## Package flag
 
 **`--package <pkg>` or `-p <pkg>`** - Run binary from specific package. Useful when binary name differs from package name:
 
-```bash
+```bash terminal icon="terminal"
 bunx -p renovate renovate-config-validator
 bunx --package @angular/cli ng
 ```
 
 To force bun to always be used with a script, use a shebang.
 
-```
+```ts dist/index.js icon="/icons/javascript.svg"
 #!/usr/bin/env bun
 ```
-
-<!-- ## Environment variables
-
-Bun automatically loads environment variables from `.env` files before running a file, script, or executable. The following files are checked, in order:
-
-1. `.env.local` (first)
-2. `NODE_ENV` === `"production"` ? `.env.production` : `.env.development`
-3. `.env`
-
-To debug environment variables, run `bun --print process.env` to view a list of resolved environment variables. -->

package/docs/{install/catalogs.md → pm/catalogs.mdx}

@@ -1,3 +1,8 @@
+---
+title: "Catalogs"
+description: "Share common dependency versions across multiple packages in a monorepo"
+---
+
 Catalogs in Bun provide a straightforward way to share common dependency versions across multiple packages in a monorepo. Rather than specifying the same versions repeatedly in each workspace package, you define them once in the root package.json and reference them consistently throughout your project.
 
 ## Overview
@@ -33,7 +38,7 @@ my-monorepo/
 
 In your root-level `package.json`, add a `catalog` or `catalogs` field within the `workspaces` object:
 
-```json
+```json package.json icon="file-json"
 {
   "name": "my-monorepo",
   "workspaces": {
@@ -58,9 +63,7 @@ If you put `catalog` or `catalogs` at the top level of the `package.json` file,
 
 In your workspace packages, use the `catalog:` protocol to reference versions:
 
-**packages/app/package.json**
-
-```json
+```json packages/app/package.json icon="file-json"
 {
   "name": "app",
   "dependencies": {
@@ -71,9 +74,7 @@ In your workspace packages, use the `catalog:` protocol to reference versions:
 }
 ```
 
-**packages/ui/package.json**
-
-```json
+```json packages/ui/package.json icon="file-json"
 {
   "name": "ui",
   "dependencies": {
@@ -97,7 +98,7 @@ Bun supports two ways to define catalogs:
 
 1. **`catalog`** (singular): A single default catalog for commonly used dependencies
 
-   ```json
+   ```json package.json icon="file-json"
    "catalog": {
      "react": "^19.0.0",
      "react-dom": "^19.0.0"
@@ -106,7 +107,7 @@ Bun supports two ways to define catalogs:
 
    Reference with simply `catalog:`:
 
-   ```json
+   ```json packages/app/package.json icon="file-json"
    "dependencies": {
      "react": "catalog:"
    }
@@ -114,7 +115,7 @@ Bun supports two ways to define catalogs:
 
 2. **`catalogs`** (plural): Multiple named catalogs for grouping dependencies
 
-   ```json
+   ```json package.json icon="file-json"
    "catalogs": {
      "testing": {
        "jest": "30.0.0"
@@ -127,7 +128,7 @@ Bun supports two ways to define catalogs:
 
    Reference with `catalog:<name>`:
 
-   ```json
+   ```json packages/app/package.json icon="file-json"
    "dependencies": {
      "jest": "catalog:testing",
      "tailwind": "catalog:ui"
@@ -147,7 +148,7 @@ Here's a more comprehensive example for a React application:
 
 **Root package.json**
 
-```json
+```json package.json icon="file-json"
 {
   "name": "react-monorepo",
   "workspaces": {
@@ -174,9 +175,7 @@ Here's a more comprehensive example for a React application:
 }
 ```
 
-**packages/app/package.json**
-
-```json
+```json packages/app/package.json icon="file-json"
 {
   "name": "app",
   "dependencies": {
@@ -195,9 +194,7 @@ Here's a more comprehensive example for a React application:
 }
 ```
 
-**packages/ui/package.json**
-
-```json
+```json packages/ui/package.json icon="file-json"
 {
   "name": "@monorepo/ui",
   "dependencies": {
@@ -211,9 +208,7 @@ Here's a more comprehensive example for a React application:
 }
 ```
 
-**packages/utils/package.json**
-
-```json
+```json packages/utils/package.json icon="file-json"
 {
   "name": "@monorepo/utils",
   "dependencies": {
@@ -229,7 +224,7 @@ Here's a more comprehensive example for a React application:
 
 To update versions across all packages, simply change the version in the root package.json:
 
-```json
+```json package.json icon="file-json"
 "catalog": {
   "react": "^19.1.0",  // Updated from ^19.0.0
   "react-dom": "^19.1.0"  // Updated from ^19.0.0
@@ -245,8 +240,7 @@ Bun's lockfile tracks catalog versions, making it easy to ensure consistent inst
 - The catalog definitions from your package.json
 - The resolution of each cataloged dependency
 
-```
-// bun.lock (excerpt)
+```json bun.lock(excerpt) icon="file-json"
 {
   "lockfileVersion": 1,
   "workspaces": {

package/docs/{cli/add.md → pm/cli/add.mdx}

@@ -1,91 +1,97 @@
+---
+title: "bun add"
+description: "Add packages to your project with Bun's fast package manager"
+---
+
+import Add from "/snippets/cli/add.mdx";
+
 To add a particular package:
 
-```bash
-$ bun add preact
+```bash terminal icon="terminal"
+bun add preact
 ```
 
 To specify a version, version range, or tag:
 
-```bash
-$ bun add zod@3.20.0
-$ bun add zod@^3.0.0
-$ bun add zod@latest
+```bash terminal icon="terminal"
+bun add zod@3.20.0
+bun add zod@^3.0.0
+bun add zod@latest
 ```
 
 ## `--dev`
 
-{% callout %}
-**Alias** — `--development`, `-d`, `-D`
-{% /callout %}
+<Note>**Alias** — `--development`, `-d`, `-D`</Note>
 
 To add a package as a dev dependency (`"devDependencies"`):
 
-```bash
-$ bun add --dev @types/react
-$ bun add -d @types/react
+```bash terminal icon="terminal"
+bun add --dev @types/react
+bun add -d @types/react
 ```
 
 ## `--optional`
 
 To add a package as an optional dependency (`"optionalDependencies"`):
 
-```bash
-$ bun add --optional lodash
+```bash terminal icon="terminal"
+bun add --optional lodash
 ```
 
 ## `--peer`
 
 To add a package as a peer dependency (`"peerDependencies"`):
 
-```bash
-$ bun add --peer @types/bun
+```bash terminal icon="terminal"
+bun add --peer @types/bun
 ```
 
 ## `--exact`
 
-{% callout %}
-**Alias** — `-E`
-{% /callout %}
+<Note>**Alias** — `-E`</Note>
 
 To add a package and pin to the resolved version, use `--exact`. This will resolve the version of the package and add it to your `package.json` with an exact version number instead of a version range.
 
-```bash
-$ bun add react --exact
-$ bun add react -E
+```bash terminal icon="terminal"
+bun add react --exact
+bun add react -E
 ```
 
 This will add the following to your `package.json`:
 
-```jsonc
+```json package.json icon="file-json"
 {
   "dependencies": {
     // without --exact
     "react": "^18.2.0", // this matches >= 18.2.0 < 19.0.0
 
     // with --exact
-    "react": "18.2.0", // this matches only 18.2.0 exactly
-  },
+    "react": "18.2.0" // this matches only 18.2.0 exactly
+  }
 }
 ```
 
 To view a complete list of options for this command:
 
-```bash
-$ bun add --help
+```bash terminal icon="terminal"
+bun add --help
 ```
 
 ## `--global`
 
-{% callout %}
-**Note** — This would not modify package.json of your current project folder.
-**Alias** - `bun add --global`, `bun add -g`, `bun install --global` and `bun install -g`
-{% /callout %}
+<Note>
+  **Note** — This would not modify package.json of your current project folder. **Alias** - `bun add --global`, `bun add
+  -g`, `bun install --global` and `bun install -g`
+</Note>
 
 To install a package globally, use the `-g`/`--global` flag. This will not modify the `package.json` of your current project. Typically this is used for installing command-line tools.
 
-```bash
-$ bun add --global cowsay # or `bun add -g cowsay`
-$ cowsay "Bun!"
+```bash terminal icon="terminal"
+bun add --global cowsay # or `bun add -g cowsay`
+cowsay "Bun!"
+```
+
+```txt
  ______
 < Bun! >
  ------
@@ -96,9 +102,9 @@ $ cowsay "Bun!"
                 ||     ||
 ```
 
-{% details summary="Configuring global installation behavior" %}
+<Accordion title="Configuring global installation behavior">
 
-```toml
+```toml bunfig.toml icon="settings"
 [install]
 # where `bun add --global` installs packages
 globalDir = "~/.bun/install/global"
@@ -107,7 +113,7 @@ globalDir = "~/.bun/install/global"
 globalBinDir = "~/.bun/bin"
 ```
 
-{% /details %}
+</Accordion>
 
 ## Trusted dependencies
 
@@ -115,33 +121,31 @@ Unlike other npm clients, Bun does not execute arbitrary lifecycle scripts for i
 
 To tell Bun to allow lifecycle scripts for a particular package, add the package to `trustedDependencies` in your package.json.
 
-```json-diff
-  {
-    "name": "my-app",
-    "version": "1.0.0",
-+   "trustedDependencies": ["my-trusted-package"]
-  }
+```json package.json icon="file-json"
+{
+  "name": "my-app",
+  "version": "1.0.0",
+  "trustedDependencies": ["my-trusted-package"] // [!code ++]
+}
 ```
 
 Bun reads this field and will run lifecycle scripts for `my-trusted-package`.
 
-<!-- Bun maintains an allow-list of popular packages containing `postinstall` scripts that are known to be safe. To run lifecycle scripts for packages that aren't on this list, add the package to `trustedDependencies` in your package.json. -->
-
 ## Git dependencies
 
 To add a dependency from a public or private git repository:
 
-```bash
-$ bun add git@github.com:moment/moment.git
+```bash terminal icon="terminal"
+bun add git@github.com:moment/moment.git
 ```
 
-{% callout %}
-**Note** — To install private repositories, your system needs the appropriate SSH credentials to access the repository.
-{% /callout %}
+<Note>
+  To install private repositories, your system needs the appropriate SSH credentials to access the repository.
+</Note>
 
 Bun supports a variety of protocols, including [`github`](https://docs.npmjs.com/cli/v9/configuring-npm/package-json#github-urls), [`git`](https://docs.npmjs.com/cli/v9/configuring-npm/package-json#git-urls-as-dependencies), `git+ssh`, `git+https`, and many more.
 
-```json
+```json package.json icon="file-json"
 {
   "dependencies": {
     "dayjs": "git+https://github.com/iamkun/dayjs.git",
@@ -156,13 +160,13 @@ Bun supports a variety of protocols, including [`github`](https://docs.npmjs.com
 
 A package name can correspond to a publicly hosted `.tgz` file. During installation, Bun will download and install the package from the specified tarball URL, rather than from the package registry.
 
-```sh
-$ bun add zod@https://registry.npmjs.org/zod/-/zod-3.21.4.tgz
+```sh terminal icon="terminal"
+bun add zod@https://registry.npmjs.org/zod/-/zod-3.21.4.tgz
 ```
 
 This will add the following line to your `package.json`:
 
-```json#package.json
+```json package.json icon="file-json"
 {
   "dependencies": {
     "zod": "https://registry.npmjs.org/zod/-/zod-3.21.4.tgz"
@@ -170,4 +174,6 @@ This will add the following line to your `package.json`:
 }
 ```
 
-{% bunCLIUsage command="add" /%}
+---
+
+<Add />

package/docs/{install/audit.md → pm/cli/audit.mdx}

@@ -1,9 +1,12 @@
-`bun audit` checks your installed packages for known security vulnerabilities.
+---
+title: "bun audit"
+description: "Check your installed packages for known security vulnerabilities"
+---
 
 Run the command in a project with a `bun.lock` file:
 
-```bash
-$ bun audit
+```bash terminal icon="terminal"
+bun audit
 ```
 
 Bun sends the list of installed packages and versions to NPM, and prints a report of any vulnerabilities that were found. Packages installed from registries other than the default registry are skipped.
@@ -28,19 +31,19 @@ To update all dependencies to the latest versions (including breaking changes):
 
 **`--audit-level=<low|moderate|high|critical>`** - Only show vulnerabilities at this severity level or higher:
 
-```bash
+```bash terminal icon="terminal"
 bun audit --audit-level=high
 ```
 
 **`--prod`** - Audit only production dependencies (excludes devDependencies):
 
-```bash
+```bash terminal icon="terminal"
 bun audit --prod
 ```
 
 **`--ignore <CVE>`** - Ignore specific CVEs (can be used multiple times):
 
-```bash
+```bash terminal icon="terminal"
 bun audit --ignore CVE-2022-25883 --ignore CVE-2023-26136
 ```
 
@@ -48,8 +51,8 @@ bun audit --ignore CVE-2022-25883 --ignore CVE-2023-26136
 
 Use the `--json` flag to print the raw JSON response from the registry instead of the formatted report:
 
-```bash
-$ bun audit --json
+```bash terminal icon="terminal"
+bun audit --json
 ```
 
 ### Exit code